nit

Author: nikolaydubina

README.md

@@ -1,4 +1,4 @@
-SIFT4[^1] — Super Fast and Accurate string distance algorithm
+SIFT4 — fast approximate string distance algorithm[^1]
 
 * zero memory copy
 * 100% test coverage

sfit4_test.go

@@ -42,12 +42,12 @@ func TestDistance(t *testing.T) {
 		{"abc", "def", 100, 5, 3},
 		{"hello", "helo", 100, 5, 1},
 		{"world", "word", 100, 5, 1},
-		{"halooooxo", "hbloooogo", 100, 5, 6},
+		{"halooooxo", "hbloooogo", 100, 5, 5},
 
 		// early exit not reached
-		{"distance", "difference", 100, 5, 6},
-		{"abcdef", "xyz", 100, 2, 3},
-		{"abcdefabcdefabcdefabcdefabcdefabcdef", "xyz", 100, 2, 3},
+		{"distance", "difference", 100, 5, 5},
+		{"abcdef", "xyz", 100, 2, 2},
+		{"abcdefabcdefabcdefabcdefabcdefabcdef", "xyz", 100, 2, 2},
 
 		// transposition
 		{"abc", "acb", 100, 5, 1}, // Damerau–Levenshtein distance, transposition of adjacent characters is one operation

sift4.go

@@ -14,7 +14,7 @@ type offset struct {
 	trans bool
 }
 
-// Distance is fast O(N) string distance algorithm.
+// Distance is fast approximate string distance O(N) algorithm.
 // If pointer to buffer is provided, then it will be reused for storing temporary structures.
 //   - maxOffset is the number of characters to search for matching letters
 //   - maxDistance is the distance at which the algorithm should stop computing the value and just exit (the strings are too different anyway)
@@ -102,7 +102,7 @@ func Distance(s1, s2 string, maxOffset, maxDistance int, buffer *Buffer) int {
 		c2++
 
 		if maxDistance > 0 {
-			if d := max(c1, c2) - lcss + trans; d > maxDistance {
+			if d := max(c1, c2) - lcss + trans; d >= maxDistance {
 				return d
 			}
 		}