add hamming distance algorithm (#30)

abranhe · web-flow · commit c1c0c948353b · 2019-10-02T14:26:00.000-04:00
add hamming distance algorithm
diff --git a/allalgorithms/string/__init__.py b/allalgorithms/string/__init__.py
@@ -1,2 +1,2 @@
 from .palindrome_check import *
-
+from .hamming_dist import *
diff --git a/allalgorithms/string/hamming_dist.py b/allalgorithms/string/hamming_dist.py
@@ -0,0 +1,14 @@
+# -*- coding: UTF-8 -*-
+#
+# Binary search works for a sorted array.
+# The All ▲lgorithms library for python
+#
+# Contributed by: ninexball
+# Github: @ninexball
+#
+
+def hamming_dist(seq1: str, seq2: str) -> int:
+    """Compare hamming distance of two strings"""
+    if len(seq1) != len(seq2):
+        raise ValueError("length of strings are not the same")
+    return sum(c1 != c2 for c1, c2 in zip(seq1, seq2))
diff --git a/docs/string/hamming-dist.md b/docs/string/hamming-dist.md
@@ -0,0 +1,32 @@
+# Hamming Distance
+
+In informatics, Hamming distance is the number of positions where the characters differ between two strings of equal length
+
+## Install
+
+```
+pip install allalgorithms
+```
+
+## Usage
+
+```
+>>> from allalgorithms.sorting import hamming_dist
+
+>>> hamming_dist("hello world", "hello wario")
+3
+```
+
+## API
+
+### hamming_dist(seq1, seq2)
+
+> Returns an integer
+
+> Raises a ValueError if strings are of unequal length
+
+##### Params:
+
+- `seq1`: first string to compare
+- `seq2`: second string to compare
+

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`from .palindrome_check import *`
`2`		`-`
	`2`	`+from .hamming_dist import *`