doc: update doc for HammingDistance

* Strutil: HammingDistance func

The Hamming distance is the number of positions at which the corresponding symbols are different

* Add hamming distance doc

README.md

@@ -1621,7 +1621,8 @@ import "github.com/duke-git/lancet/v2/strutil"
     [[play](https://go.dev/play/p/HzLC9vsTwkf)]
 -   **<big>SubInBetween</big>** : return substring between the start and end position(excluded) of source string.
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/strutil.md#SubInBetween)]
-
+-   **<big>HammingDistance</big>** : calculates the Hamming distance between two strings.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/strutil.md#HammingDistance)]
 
 <h3 id="system"> 22. System package contain some functions about os, runtime, shell command. &nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">index</a></h3>
 

README_zh-CN.md

@@ -1620,7 +1620,8 @@ import "github.com/duke-git/lancet/v2/strutil"
     [[play](https://go.dev/play/p/HzLC9vsTwkf)]
 -   **<big>SubInBetween</big>** : 获取字符串中指定的起始字符串start和终止字符串end直接的子字符串。
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/strutil.md#SubInBetween)]
-
+-   **<big>HammingDistance</big>** : 计算两个字符串之间的汉明距离。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/strutil.md#HammingDistance)]
 
 <h3 id="system"> 22. system 包含 os, runtime, shell command 的相关函数。&nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">回到目录</a></h3>
 

docs/api/packages/strutil.md

@@ -61,6 +61,7 @@ import (
 -   [ContainsAny](#ContainsAny)
 -   [RemoveWhiteSpace](#RemoveWhiteSpace)
 -   [SubInBetween](#SubInBetween)
+-   [HammingDistance](#HammingDistance)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -1495,4 +1496,36 @@ func main() {
     // abc
     // bc
 }
+```
+
+### <span id="HammingDistance">HammingDistance</span>
+
+<p>计算两个字符串之间的汉明距离。汉明距离是指对应符号不同的位置数。</p>
+
+<b>函数签名:</b>
+
+```go
+HammingDistance(a, b string) (int, error)
+```
+
+<b>示例:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/strutil"
+)
+
+func main() {
+
+    result1, _ := strutil.HammingDistance("de", "de")
+    result2, _ := strutil.HammingDistance("a", "d")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+
+    // Output:
+    // 0
+    // 1
+}
 ```

docs/en/api/packages/strutil.md

@@ -60,6 +60,8 @@ import (
 -   [ContainsAll](#ContainsAll)
 -   [ContainsAny](#ContainsAny)
 -   [RemoveWhiteSpace](#RemoveWhiteSpace)
+-   [SubInBetween](#SubInBetween)
+-   [HammingDistance](#HammingDistance)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -1496,4 +1498,36 @@ func main() {
     // abc
     // bc
 }
+```
+
+### <span id="HammingDistance">HammingDistance</span>
+
+<p>HammingDistance calculates the Hamming distance between two strings. The Hamming distance is the number of positions at which the corresponding symbols are different.</p>
+
+<b>Signature:</b>
+
+```go
+HammingDistance(a, b string) (int, error)
+```
+
+<b>Example:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/strutil"
+)
+
+func main() {
+
+    result1, _ := strutil.HammingDistance("de", "de")
+    result2, _ := strutil.HammingDistance("a", "d")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+
+    // Output:
+    // 0
+    // 1
+}
 ```

strutil/string.go

@@ -4,6 +4,7 @@
 package strutil
 
 import (
+	"errors"
 	"regexp"
 	"strings"
 	"unicode"
@@ -594,3 +595,24 @@ func SubInBetween(str string, start string, end string) string {
 
 	return ""
 }
+
+// HammingDistance calculates the Hamming distance between two strings.
+// The Hamming distance is the number of positions at which the corresponding symbols are different.
+// This func returns an error if the input strings are of unequal lengths.
+func HammingDistance(a, b string) (int, error) {
+	if len(a) != len(b) {
+		return -1, errors.New("a length and b length are unequal")
+	}
+
+	ar := []rune(a)
+	br := []rune(b)
+
+	var distance int
+	for i, codepoint := range ar {
+		if codepoint != br[i] {
+			distance++
+		}
+	}
+
+	return distance, nil
+}

strutil/string_example_test.go

@@ -667,3 +667,16 @@ func ExampleSubInBetween() {
 	// abc
 	// bc
 }
+
+func ExampleHammingDistance() {
+
+	result, _ := HammingDistance("abc", "def")
+	fmt.Println(result)
+
+	result, _ = HammingDistance("name", "namf")
+	fmt.Println(result)
+
+	// Output:
+	// 3
+	// 1
+}

strutil/string_test.go

@@ -581,3 +581,26 @@ func TestSubInBetween(t *testing.T) {
 	assert.Equal("", SubInBetween(str, "a", ""))
 	assert.Equal("", SubInBetween(str, "a", "f"))
 }
+
+func TestHammingDistance(t *testing.T) {
+	assert := internal.NewAssert(t, "HammingDistance")
+
+	hd := func(a, b string) int {
+		c, _ := HammingDistance(a, b)
+		return c
+	}
+
+	assert.Equal(0, hd(" ", " "))
+	assert.Equal(1, hd(" ", "c"))
+	assert.Equal(1, hd("a", "d"))
+	assert.Equal(1, hd("a", " "))
+	assert.Equal(1, hd("a", "f"))
+
+	assert.Equal(0, hd("", ""))
+	assert.Equal(-1, hd("abc", "ab"))
+	assert.Equal(3, hd("abc", "def"))
+	assert.Equal(-1, hd("kitten", "sitting"))
+	assert.Equal(1, hd("ö", "ü"))
+	assert.Equal(0, hd("日本語", "日本語"))
+	assert.Equal(3, hd("日本語", "語日本"))
+}