usearch 2.3.2 → 2.4.1

package/python/usearch/index.py

@@ -476,6 +476,7 @@ class Index:
         multi: bool = False,
         path: Optional[os.PathLike] = None,
         view: bool = False,
+        enable_key_lookups: bool = True,
     ) -> None:
         """Construct the index and compiles the functions, if requested (expensive).
 
@@ -565,6 +566,7 @@ class Index:
             expansion_add=expansion_add,
             expansion_search=expansion_search,
             multi=multi,
+            enable_key_lookups=enable_key_lookups,
             metric_kind=self._metric_kind,
             metric_pointer=self._metric_pointer,
             metric_signature=self._metric_signature,
@@ -986,6 +988,8 @@ class Index:
 
     def reset(self):
         """Erases all members from index, closing files, and returning RAM to OS."""
+        if not hasattr(self, "_compiled"):
+            return
         self._compiled.reset()
 
     def __del__(self):
@@ -1175,23 +1179,28 @@ class Index:
 
     @property
     def specs(self) -> Dict[str, Union[str, int, bool]]:
+        if not hasattr(self, "_compiled"):
+            return "usearch.Index(failed)"
         return {
-            "Class": "usearch.Index",
-            "Connectivity": self.connectivity,
-            "Size": self.size,
-            "Dimensions": self.ndim,
-            "Expansion@Add": self.expansion_add,
-            "Expansion@Search": self.expansion_search,
-            "OpenMP": USES_OPENMP,
-            "SimSIMD": USES_SIMSIMD,
-            "NativeF16": USES_NATIVE_F16,
-            "JIT": self.jit,
-            "DType": self.dtype,
-            "Path": self.path,
+            "type": "usearch.Index",
+            "ndim": self.ndim,
+            "connectivity": self.connectivity,
+            "expansion_add": self.expansion_add,
+            "expansion_search": self.expansion_search,
+            "size": self.size,
+            "jit": self.jit,
+            "hardware_acceleration": self.hardware_acceleration,
+            "dtype": self.dtype,
+            "path": self.path,
+            "compiled_with_openmp": USES_OPENMP,
+            "compiled_with_simsimd": USES_SIMSIMD,
+            "compiled_with_native_f16": USES_NATIVE_F16,
         }
 
     def __repr__(self) -> str:
-        f = "usearch.Index({} x {}, {}, connectivity: {}, expansion: {} & {}, {} vectors in {} levels)"
+        if not hasattr(self, "_compiled"):
+            return "usearch.Index(failed)"
+        f = "usearch.Index({} x {}, {}, connectivity: {}, expansion: {} & {}, {:,} vectors in {} levels, {} hardware acceleration)"
         return f.format(
             self.dtype,
             self.ndim,
@@ -1201,9 +1210,12 @@ class Index:
             self.expansion_search,
             len(self),
             self.nlevels,
+            self.hardware_acceleration,
         )
 
     def _repr_pretty_(self, printer, cycle) -> str:
+        if not hasattr(self, "_compiled"):
+            return "usearch.Index(failed)"
         level_stats = [
             f"--- {i}. {self.level_stats(i).nodes:,} nodes" for i in range(self.nlevels)
         ]

package/rust/lib.rs

@@ -81,7 +81,18 @@ pub mod ffi {
         ///
         /// * `key` - The key associated with the vector.
         /// * `vector` - A slice containing the vector data.
-        pub fn add(self: &Index, key: u64, vector: &[f32]) -> Result<()>;
+        fn add<T>(self: &Index, key: u64, vector: &[T]) -> Result<()> {
+            // Use type-based dispatch
+            if std::any::TypeId::of::<T>() == std::any::TypeId::of::<i8>() {
+                add_i8(key, unsafe { std::mem::transmute::<&[T], &[i8]>(vector) })
+            } else if std::any::TypeId::of::<T>() == std::any::TypeId::of::<f32>() {
+                add_f32(key, unsafe { std::mem::transmute::<&[T], &[f32]>(vector) })
+            } else if std::any::TypeId::of::<T>() == std::any::TypeId::of::<f64>() {
+                add_f64(key, unsafe { std::mem::transmute::<&[T], &[f64]>(vector) })
+            } else {
+                Err(Box::new("Unsupported type"))
+            }
+        }
 
         pub fn add_i8(self: &Index, key: u64, vector: &[i8]) -> Result<()>;
         pub fn add_f16(self: &Index, key: u64, vector: &[u16]) -> Result<()>;
@@ -98,7 +109,18 @@ pub mod ffi {
         /// # Returns
         ///
         /// A `Result` containing the matches found.
-        pub fn search(self: &Index, query: &[f32], count: usize) -> Result<Matches>;
+        pub fn search<T>(self: &Index, query: &[T], count: usize) -> Result<Matches> {
+            // Use type-based dispatch
+            if std::any::TypeId::of::<T>() == std::any::TypeId::of::<i8>() {
+                search_i8(unsafe { std::mem::transmute::<&[T], &[i8]>(query) }, count)
+            } else if std::any::TypeId::of::<T>() == std::any::TypeId::of::<f32>() {
+                search_f32(unsafe { std::mem::transmute::<&[T], &[f32]>(query) }, count)
+            } else if std::any::TypeId::of::<T>() == std::any::TypeId::of::<f64>() {
+                search_f64(unsafe { std::mem::transmute::<&[T], &[f64]>(query) }, count)
+            } else {
+                Err(Box::new("Unsupported type"))
+            }
+        }
 
         pub fn search_i8(self: &Index, query: &[i8], count: usize) -> Result<Matches>;
         pub fn search_f16(self: &Index, query: &[u16], count: usize) -> Result<Matches>;

package/wasmer.toml

@@ -1,6 +1,6 @@
 [package]
 name="unum/usearch"
-version="2.3.2"
+version="2.4.1"
 description="Smaller & Faster Single-File Vector Search Engine from Unum"
 license="Apache-2.0"
 readme="README.md"

package/csharp/src/Cloud.Unum.USearch.Tests/InitTests.cs

@@ -1,306 +0,0 @@
-using Cloud.Unum.USearch;
-
-namespace Cloud.Unum.USearch.Tests;
-
-public class InitTests
-{
-    // Epsilon for real values comparisons
-    private const float Epsilon = 0.000001f;
-
-    [Fact]
-    public void InitializedAndDisposedSucceeds()
-    {
-        using (var index = new USearchIndex(MetricKind.Cos, ScalarKind.Float32, 3))
-        {
-            Assert.NotNull(index);
-            Assert.Equal((uint)3, index.Dimensions());
-        }
-    }
-
-    [Fact]
-    public void AddDoubleVectorSucceeds()
-    {
-        using (var index = new USearchIndex(MetricKind.Cos, ScalarKind.Float64, 3))
-        {
-            index.Add(1, new double[] { 1.0, 2.0, 3.0 });
-            Assert.True(index.Contains(1));
-            Assert.False(index.Contains(2));
-            Assert.Equal((uint)1, index.Size());
-        }
-    }
-
-    [Fact]
-    public void AddDoubleVectorsUnderSameKeySucceeds()
-    {
-        using (var index = new USearchIndex(MetricKind.Cos, ScalarKind.Float64, 3, multi: true))
-        {
-            index.Add(1, new double[] { 1.0, 2.0, 3.0 });
-            index.Add(2, new double[] { 1.0, 2.0, 3.0 });
-            index.Add(3, new double[] { 1.0, 2.0, 3.0 });
-            index.Add(1, new double[] { 1.0, 2.0, 3.0 });
-            index.Add(2, new double[] { 1.0, 2.0, 3.0 });
-            Assert.True(index.Contains(1));
-            Assert.True(index.Contains(2));
-            Assert.True(index.Contains(3));
-            Assert.Equal((uint)5, index.Size());
-        }
-    }
-
-    [Fact]
-    public void ItCanGetMultipleFloatVectorsForSingleKey()
-    {
-        using (var index = new USearchIndex(MetricKind.Cos, ScalarKind.Float32, 3, multi: true))
-        {
-            var inputVectors = new float[][] {
-                    new float[] { 1.0f, 6.0f, 11.0f },
-                    new float[] { 2.0f, 7.0f, 12.0f },
-                    new float[] { 3.0f, 8.0f, 13.0f },
-                    new float[] { 5.0f, 10.0f, 15.0f }
-            };
-            index.Add(
-                new ulong[] { 2, 2, 2, 2 },
-                inputVectors
-            );
-            Assert.True(index.Contains(2));
-            Assert.Equal((uint)4, index.Size());
-            Assert.Equal(4, index.Count(2));
-
-            int foundVectorsCount = index.Get(2, 3, out float[][] retrievedVectors);
-            Assert.Equal(3, foundVectorsCount);
-        }
-    }
-
-    [Fact]
-    public void ItCanGetMultipleDoubleVectorsForSingleKey()
-    {
-        using (var index = new USearchIndex(MetricKind.Cos, ScalarKind.Float64, 3, multi: true))
-        {
-            var inputVectors = new double[][] {
-                new double[] { 1.0, 6.0, 11.0 },
-                new double[] { 2.0, 7.0, 12.0 },
-                new double[] { 3.0, 8.0, 13.0 },
-                new double[] { 5.0, 10.0, 15.0 }
-            };
-            index.Add(
-                new ulong[] { 2, 2, 2, 2 },
-                inputVectors
-            );
-            Assert.True(index.Contains(2));
-            Assert.Equal((uint)4, index.Size());
-            Assert.Equal(4, index.Count(2));
-
-            int foundVectorsCount = index.Get(2, 3, out double[][] retrievedVectors);
-            Assert.Equal(3, foundVectorsCount);
-        }
-    }
-
-    [Fact]
-    public void AddFloatVectorSucceeds()
-    {
-        using (var index = new USearchIndex(MetricKind.Cos, ScalarKind.Float32, 3))
-        {
-            index.Add(1, new float[] { 1.0f, 2.0f, 3.0f });
-            Assert.Equal((uint)1, index.Size());
-            Assert.True(index.Contains(1));
-            Assert.False(index.Contains(2));
-        }
-    }
-
-    [Fact]
-    public void AddFloatVectorsUnderSameKeySucceeds()
-    {
-        using (var index = new USearchIndex(MetricKind.Cos, ScalarKind.Float32, 3, multi: true))
-        {
-            index.Add(1, new float[] { 1.0f, 2.0f, 3.0f });
-            index.Add(2, new float[] { 1.0f, 2.0f, 3.0f });
-            index.Add(3, new float[] { 1.0f, 2.0f, 3.0f });
-            index.Add(1, new float[] { 1.0f, 2.0f, 3.0f });
-            index.Add(2, new float[] { 1.0f, 2.0f, 3.0f });
-            Assert.True(index.Contains(1));
-            Assert.True(index.Contains(2));
-            Assert.True(index.Contains(3));
-            Assert.Equal((uint)5, index.Size());
-        }
-    }
-
-    [Fact]
-    public void AddGetFloatVectorSucceeds()
-    {
-        using (var index = new USearchIndex(MetricKind.Cos, ScalarKind.Float32, 3))
-        {
-            var inputVector = new float[] { 1.0f, 2.0f, 3.0f };
-            index.Add(1, inputVector);
-            Assert.Equal((uint)1, index.Size());
-            Assert.True(index.Contains(1));
-            Assert.False(index.Contains(2));
-            Assert.True(index.Get(1, out float[] retrievedVector) == 1);
-            Assert.NotNull(retrievedVector);
-            bool areEqual = inputVector
-                .Zip(retrievedVector, (a, b) => (a, b))
-                .All(pair => Math.Abs(pair.a - pair.b) <= Epsilon);
-
-            Assert.True(areEqual);
-        }
-    }
-
-    [Fact]
-    public void AddGetDoubleVectorSucceeds()
-    {
-        using (var index = new USearchIndex(MetricKind.Cos, ScalarKind.Float32, 3))
-        {
-            var inputVector = new double[] { 1.0, 2.0, 3.33 };
-            index.Add(1, inputVector);
-            Assert.Equal((uint)1, index.Size());
-            Assert.True(index.Contains(1));
-            Assert.False(index.Contains(2));
-            Assert.True(index.Get(1, out double[] retrievedVector) == 1);
-            Assert.NotNull(retrievedVector);
-            bool areEqual = inputVector
-                .Zip(retrievedVector, (a, b) => (a, b))
-                .All(pair => Math.Abs(pair.a - pair.b) <= Epsilon);
-
-            Assert.True(areEqual);
-        }
-    }
-
-    [Fact]
-    public void ItThrowsException_AddAddWithSameKeyAndGetVector()
-    {
-        using (var index = new USearchIndex(MetricKind.Cos, ScalarKind.Float32, 3))
-        {
-            ulong key = 1;
-            float[] vector1 = { 1.0f, 2.0f, 33.3f };
-            index.Add(key, vector1);
-            float[] vector2 = { 3.0f, 4.0f, 34.2f };
-            Assert.Throws<USearchException>(() => index.Add(key, vector2));
-        }
-    }
-
-    [Fact]
-    public void TestAddRemoveAddAndGet()
-    {
-        using (var index = new USearchIndex(MetricKind.Cos, ScalarKind.Float32, 2))
-        {
-            ulong key = 1;
-            float[] vector = { 1.0f, 2.0f };
-
-            index.Add(key, vector);
-            Assert.True(index.Contains(key));
-            index.Remove(key);
-            Assert.False(index.Contains(key));
-            index.Add(key, vector);
-            Assert.True(index.Contains(key));
-            Assert.True(index.Get(key, out float[] retrievedVector) == 1);
-            Assert.Equal(vector, retrievedVector);
-        }
-    }
-
-    [Fact]
-    public void TestAddRemoveAddWithSameKeyVectorAndGet()
-    {
-        using (var index = new USearchIndex(MetricKind.Cos, ScalarKind.Float32, 2))
-        {
-            ulong key = 1;
-            float[] vector = { 1.0f, 2.0f };
-
-            index.Add(key, vector);
-            Assert.True(index.Contains(key));
-            index.Remove(key);
-            Assert.False(index.Contains(key));
-            index.Add(key, vector);
-            Assert.True(index.Contains(key));
-            Assert.True(index.Get(key, out float[] retrievedVector) == 1);
-            Assert.Equal(vector, retrievedVector);
-        }
-    }
-
-    [Fact]
-    public void TestGetKeyThatNotExist()
-    {
-        using (var index = new USearchIndex(MetricKind.Cos, ScalarKind.Float32, 2))
-        {
-            Assert.True(index.Get(1, out float[] retrievedVector) == 0);
-            Assert.False(index.Contains(1));
-        }
-    }
-
-    [Fact]
-    public void Search_FindsExpectedResults()
-    {
-        using (var index = new USearchIndex(MetricKind.L2sq, ScalarKind.Float32, 2))
-        {
-            index.Add(
-                Enumerable.Range(1, 5).Select(i => (ulong)i).ToArray(),
-                new float[][]
-                {
-                    new float[] { -0.5f, -0.6f },
-                    new float[] { -0.1f, -0.1f },
-                    new float[] { 0.2f, 0.2f },
-                    new float[] { 0.7f, 0.8f },
-                    new float[] { 0.9f, 1.0f }
-                }
-            );
-            var queryVector = new float[] { 0.0f, 0.0f };
-
-            var matches = index.Search(queryVector, 2, out ulong[] keys, out float[] distances);
-
-            Assert.Equal(2, matches);
-            Assert.Contains(2UL, keys);
-            Assert.Contains(3UL, keys);
-            Assert.Equal(0.02, distances[0], Epsilon);
-            Assert.Equal(0.08, distances[1], Epsilon);
-        }
-    }
-
-    [Fact]
-    public void Search_AfterRemovingKey_FindsExpectedResults()
-    {
-        using (var index = new USearchIndex(MetricKind.L2sq, ScalarKind.Float32, 2))
-        {
-            index.Add(1, new float[] { 0.1f, 0.2f });
-            index.Add(2, new float[] { 0.2f, 0.3f });
-            index.Add(3, new float[] { 0.3f, 0.4f });
-            index.Remove(2);
-            var queryVector = new float[] { 0.2f, 0.3f };
-
-            var matches = index.Search(queryVector, 2, out ulong[] keys, out float[] distances);
-
-            Assert.Equal(2, matches);
-            Assert.Contains(1UL, keys);
-            Assert.Contains(3UL, keys);
-            Assert.DoesNotContain(2UL, keys);
-        }
-    }
-
-    [Fact]
-    public void Search_WithVectorsLessThanResultsLimit()
-    {
-        using (var index = new USearchIndex(MetricKind.L2sq, ScalarKind.Float32, 2))
-        {
-            index.Add(1, new float[] { 0.9f, 0.9f });
-            index.Add(2, new float[] { 0.8f, 0.8f });
-            var queryVector = new float[] { 0.1f, 0.2f };
-
-            var matches = index.Search(queryVector, 10, out ulong[] keys, out float[] distances);
-
-            Assert.Equal(2, matches);
-            Assert.Contains(1UL, keys);
-            Assert.Contains(2UL, keys);
-        }
-    }
-
-    [Fact]
-    public void ItCanRenameKey()
-    {
-        using (var index = new USearchIndex(MetricKind.L2sq, ScalarKind.Float32, 2))
-        {
-            index.Add(1, new float[] { 0.9f, 0.9f });
-            index.Add(2, new float[] { 0.8f, 0.8f });
-            index.Rename(1, 3);
-            Assert.False(index.Contains(1));
-            Assert.True(index.Contains(2));
-            Assert.True(index.Contains(3));
-        }
-    }
-
-}