1
0
mirror of https://github.com/duke-git/lancet.git synced 2026-03-01 00:35:28 +08:00

Add hamming distance doc

This commit is contained in:
Marcel Edmund Franke
2024-03-02 15:46:22 +01:00
parent 4e515e9bd5
commit c0575f703f
2 changed files with 67 additions and 0 deletions
+33
View File
@@ -61,6 +61,7 @@ import (
- [ContainsAny](#ContainsAny) - [ContainsAny](#ContainsAny)
- [RemoveWhiteSpace](#RemoveWhiteSpace) - [RemoveWhiteSpace](#RemoveWhiteSpace)
- [SubInBetween](#SubInBetween) - [SubInBetween](#SubInBetween)
- [HammingDistance](#HammingDistance)
<div STYLE="page-break-after: always;"></div> <div STYLE="page-break-after: always;"></div>
@@ -1496,3 +1497,35 @@ func main() {
// bc // bc
} }
``` ```
### <span id="HammingDistance">HammingDistance</span>
<p>TBD</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
}
```
+34
View File
@@ -60,6 +60,8 @@ import (
- [ContainsAll](#ContainsAll) - [ContainsAll](#ContainsAll)
- [ContainsAny](#ContainsAny) - [ContainsAny](#ContainsAny)
- [RemoveWhiteSpace](#RemoveWhiteSpace) - [RemoveWhiteSpace](#RemoveWhiteSpace)
- [SubInBetween](#SubInBetween)
- [HammingDistance](#HammingDistance)
<div STYLE="page-break-after: always;"></div> <div STYLE="page-break-after: always;"></div>
@@ -1497,3 +1499,35 @@ func main() {
// bc // 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
}
```