Require IEquatable<T> on Span methods to avoid boxing; use SequenceEq…

…ual instead of == equality. #35
feature23 · Aug 31, 2023 · 8a49b7f · 8a49b7f
1 parent abd0383
commit 8a49b7f
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 10 deletions.
diff --git a/src/F23.StringSimilarity/Damerau.cs b/src/F23.StringSimilarity/Damerau.cs
@@ -57,6 +57,7 @@ public double Distance(string s1, string s2)
             => Distance(s1.AsSpan(), s2.AsSpan());
 
         public double Distance<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
+            where T : IEquatable<T>
         {
             if (s1 == null)
             {
@@ -68,7 +69,7 @@ public double Distance<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
                 throw new ArgumentNullException(nameof(s2));
             }
 
-            if (s1 == s2)
+            if (s1.SequenceEqual(s2))
             {
                 return 0;
             }

diff --git a/src/F23.StringSimilarity/Interfaces/IMetricSpanDistance.cs b/src/F23.StringSimilarity/Interfaces/IMetricSpanDistance.cs
@@ -17,6 +17,7 @@ public interface IMetricSpanDistance : ISpanDistance
         /// <param name="b1">The first span.</param>
         /// <param name="b2">The second span.</param>
         /// <returns>The metric distance.</returns>
-        new double Distance<T>(ReadOnlySpan<T> b1, ReadOnlySpan<T> b2);
+        new double Distance<T>(ReadOnlySpan<T> b1, ReadOnlySpan<T> b2)
+            where T : IEquatable<T>;
     }
 }
diff --git a/src/F23.StringSimilarity/Interfaces/ISpanDistance.cs b/src/F23.StringSimilarity/Interfaces/ISpanDistance.cs
@@ -17,6 +17,7 @@ public interface ISpanDistance
         /// <param name="b1">The first span.</param>
         /// <param name="b2">The second span.</param>
         /// <returns>The measure of distance between the spans.</returns>
-        double Distance<T>(ReadOnlySpan<T> b1, ReadOnlySpan<T> b2);
+        double Distance<T>(ReadOnlySpan<T> b1, ReadOnlySpan<T> b2)
+            where T : IEquatable<T>;
     }
 }
diff --git a/src/F23.StringSimilarity/Interfaces/ISpanSimilarity.cs b/src/F23.StringSimilarity/Interfaces/ISpanSimilarity.cs
@@ -10,6 +10,7 @@ public interface ISpanSimilarity
         /// <param name="s1">The first span</param>
         /// <param name="s2">The second span</param>
         /// <returns>Similarity (0 means both spans are completely different)</returns>
-        double Similarity<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2);
+        double Similarity<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
+            where T : IEquatable<T>;
     }
 }
diff --git a/src/F23.StringSimilarity/JaroWinkler.cs b/src/F23.StringSimilarity/JaroWinkler.cs
@@ -79,6 +79,7 @@ public double Similarity(string s1, string s2)
             => Similarity(s1.AsSpan(), s2.AsSpan());
 
         public double Similarity<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
+            where T : IEquatable<T>
         {
             if (s1 == null)
             {
@@ -90,7 +91,7 @@ public double Similarity<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
                 throw new ArgumentNullException(nameof(s2));
             }
 
-            if (s1 == s2)
+            if (s1.SequenceEqual(s2))
             {
                 return 1f;
             }
@@ -123,9 +124,11 @@ public double Distance(string s1, string s2)
             => 1.0 - Similarity(s1, s2);
 
         public double Distance<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
+            where T : IEquatable<T>
             => 1.0 - Similarity(s1, s2);
 
         private static int[] Matches<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
+            where T : IEquatable<T>
         {
             ReadOnlySpan<T> max, min;
             if (s1.Length > s2.Length)

diff --git a/src/F23.StringSimilarity/Levenshtein.cs b/src/F23.StringSimilarity/Levenshtein.cs
@@ -75,9 +75,11 @@ public double Distance(string s1, string s2, int limit)
             => Distance(s1.AsSpan(), s2.AsSpan(), limit);
 
         public double Distance<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
+            where T : IEquatable<T>
             => Distance(s1, s2, int.MaxValue);
 
         public double Distance<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2, int limit)
+            where T : IEquatable<T>
         {
             if (s1 == null)
             {
@@ -89,7 +91,7 @@ public double Distance<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2, int limit)
                 throw new ArgumentNullException(nameof(s2));
             }
 
-            if (s1 == s2)
+            if (s1.SequenceEqual(s2))
             {
                 return 0;
             }

diff --git a/src/F23.StringSimilarity/LongestCommonSubsequence.cs b/src/F23.StringSimilarity/LongestCommonSubsequence.cs
@@ -61,6 +61,7 @@ public double Distance(string s1, string s2)
             => Distance(s1.AsSpan(), s2.AsSpan());
 
         public double Distance<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
+            where T : IEquatable<T>
         {
             if (s1 == null)
             {
@@ -72,7 +73,7 @@ public double Distance<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
                 throw new ArgumentNullException(nameof(s2));
             }
 
-            if (s1 == s2)
+            if (s1.SequenceEqual(s2))
             {
                 return 0;
             }
@@ -92,6 +93,7 @@ public int Length(string s1, string s2)
             => Length(s1.AsSpan(), s2.AsSpan());
 
         internal static int Length<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
+            where T : IEquatable<T>
         {
             if (s1 == null)
             {

diff --git a/src/F23.StringSimilarity/MetricLCS.cs b/src/F23.StringSimilarity/MetricLCS.cs
@@ -45,6 +45,7 @@ public double Distance(string s1, string s2)
             => Distance(s1.AsSpan(), s2.AsSpan());
 
         public double Distance<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
+            where T : IEquatable<T>
         {
             if (s1 == null)
             {
@@ -56,7 +57,7 @@ public double Distance<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
                 throw new ArgumentNullException(nameof(s2));
             }
 
-            if (s1 == s2)
+            if (s1.SequenceEqual(s2))
             {
                 return 0;
             }

diff --git a/src/F23.StringSimilarity/NormalizedLevenshtein.cs b/src/F23.StringSimilarity/NormalizedLevenshtein.cs
@@ -46,6 +46,7 @@ public double Distance(string s1, string s2)
             => Distance(s1.AsSpan(), s2.AsSpan());
 
         public double Distance<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
+            where T : IEquatable<T>
         {
             if (s1 == null)
             {
@@ -57,7 +58,7 @@ public double Distance<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
                 throw new ArgumentNullException(nameof(s2));
             }
 
-            if (s1 == s2)
+            if (s1.SequenceEqual(s2))
             {
                 return 0.0;
             }
@@ -83,6 +84,7 @@ public double Similarity(string s1, string s2)
             => 1.0 - Distance(s1, s2);
 
         public double Similarity<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
+            where T : IEquatable<T>
             => 1.0 - Distance(s1, s2);
     }
 }
diff --git a/src/F23.StringSimilarity/OptimalStringAlignment.cs b/src/F23.StringSimilarity/OptimalStringAlignment.cs
@@ -45,6 +45,7 @@ public double Distance(string s1, string s2)
             => Distance(s1.AsSpan(), s2.AsSpan());
 
         public double Distance<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
+            where T : IEquatable<T>
         {
             if (s1 == null)
             {
@@ -56,7 +57,7 @@ public double Distance<T>(ReadOnlySpan<T> s1, ReadOnlySpan<T> s2)
                 throw new ArgumentNullException(nameof(s2));
             }
 
-            if (s1 == s2)
+            if (s1.SequenceEqual(s2))
             {
                 return 0;
             }