usearch 2.20.5 → 2.20.7

package/README.md

@@ -20,28 +20,28 @@ Similarity Search & Clustering Engine for <a href="https://github.com/ashvardani
 <p align="center">
 Spatial • Binary • Probabilistic • User-Defined Metrics
 <br/>
-<a href="https://unum-cloud.github.io/usearch/cpp">C++ 11</a> •
+<a href="https://unum-cloud.github.io/usearch/cpp">C++11</a> •
 <a href="https://unum-cloud.github.io/usearch/python">Python 3</a> •
 <a href="https://unum-cloud.github.io/usearch/javascript">JavaScript</a> •
 <a href="https://unum-cloud.github.io/usearch/java">Java</a> •
 <a href="https://unum-cloud.github.io/usearch/rust">Rust</a> •
-<a href="https://unum-cloud.github.io/usearch/c">C 99</a> •
+<a href="https://unum-cloud.github.io/usearch/c">C99</a> •
 <a href="https://unum-cloud.github.io/usearch/objective-c">Objective-C</a> •
 <a href="https://unum-cloud.github.io/usearch/swift">Swift</a> •
 <a href="https://unum-cloud.github.io/usearch/csharp">C#</a> •
-<a href="https://unum-cloud.github.io/usearch/golang">GoLang</a> •
+<a href="https://unum-cloud.github.io/usearch/golang">Go</a> •
 <a href="https://unum-cloud.github.io/usearch/wolfram">Wolfram</a>
 <br/>
-Linux • MacOS • Windows • iOS • Android • WebAssembly •
-<a href="https://unum-cloud.github.io/usearch/sqlite">SQLite3</a>
+Linux • macOS • Windows • iOS • Android • WebAssembly •
+<a href="https://unum-cloud.github.io/usearch/sqlite">SQLite</a>
 </p>
 
 <div align="center">
-<a href="https://pepy.tech/project/usearch"> <img alt="PyPI" src="https://static.pepy.tech/personalized-badge/usearch?period=total&units=abbreviation&left_color=black&right_color=blue&left_text=Python%20PyPi%20installs"> </a>
+<a href="https://pepy.tech/project/usearch"> <img alt="PyPI" src="https://static.pepy.tech/personalized-badge/usearch?period=total&units=abbreviation&left_color=black&right_color=blue&left_text=Python%20PyPI%20installs"> </a>
 <a href="https://www.npmjs.com/package/usearch"> <img alt="NPM" src="https://img.shields.io/npm/dy/usearch?label=JavaScript%20NPM%20installs"> </a>
 <a href="https://crates.io/crates/usearch"> <img alt="Crate" src="https://img.shields.io/crates/d/usearch?label=Rust%20Crate%20installs"> </a>
 <a href="https://www.nuget.org/packages/Cloud.Unum.USearch"> <img alt="NuGet" src="https://img.shields.io/nuget/dt/Cloud.Unum.USearch?label=CSharp%20NuGet%20installs"> </a>
-<a href="https://central.sonatype.com/artifact/cloud.unum/usearch/overview"> <img alt="Maven" src="https://img.shields.io/nexus/r/cloud.unum/usearch?server=https%3A%2F%2Fs01.oss.sonatype.org%2F&label=Java%20Maven%20version"> </a>
+<!-- Maven Central publishing is deprecated for now; fat-JAR download is the supported path. -->
 <img alt="GitHub code size in bytes" src="https://img.shields.io/github/languages/code-size/unum-cloud/usearch?label=Repo%20size">
 </div>
 
@@ -160,7 +160,7 @@ This can result in __20x cost reduction__ on AWS and other public clouds.
 ```py
 index.save("index.usearch")
 
-loaded_copy = index.load("index.usearch")
+index.load("index.usearch")
 view = Index.restore("index.usearch", view=True, ...)
 
 other_view = Index(ndim=..., metric=...)
@@ -201,6 +201,8 @@ You can use [Numba][numba], [Cppyy][cppyy], or [PeachPy][peachpy] to define your
 from numba import cfunc, types, carray
 from usearch.index import Index, MetricKind, MetricSignature, CompiledMetric
 
+ndim = 256
+
 @cfunc(types.float32(types.CPointer(types.float32), types.CPointer(types.float32)))
 def python_inner_product(a, b):
     a_array = carray(a, ndim)
@@ -352,7 +354,7 @@ By now, the core functionality is supported across all bindings.
 Broader functionality is ported per request.
 In some cases, like Batch operations, feature parity is meaningless, as the host language has full multi-threading capabilities and the USearch index structure is concurrent by design, so the users can implement batching/scheduling/load-balancing in the most optimal way for their applications.
 
-|                         | C++ 11 | Python 3 | C 99  | Java  | JavaScript | Rust  | GoLang | Swift |
+|                         | C++ 11 | Python 3 | C 99  | Java  | JavaScript | Rust  | Go     | Swift |
 | :---------------------- | :----: | :------: | :---: | :---: | :--------: | :---: | :----: | :---: |
 | Add, search, remove     |   ✅    |    ✅     |   ✅   |   ✅   |     ✅      |   ✅   |   ✅    |   ✅   |
 | Save, load, view        |   ✅    |    ✅     |   ✅   |   ✅   |     ✅      |   ✅   |   ✅    |   ✅   |
@@ -532,15 +534,14 @@ index = Index(ndim=ndim, metric=CompiledMetric(
 - [x] TiDB & TiFlash: [C++](https://github.com/pingcap/tiflash), [announcement](https://www.pingcap.com/article/introduce-vector-search-indexes-in-tidb/).
 - [x] YugaByte: [C++](https://github.com/yugabyte/yugabyte-db/blob/366b9f5e3c4df3a1a17d553db41d6dc50146f488/src/yb/vector_index/usearch_wrapper.cc).
 - [x] Google: [UniSim](https://github.com/google/unisim), [RetSim](https://arxiv.org/abs/2311.17264) paper.
-- [x] MemGraph: [C++](https://github.com/memgraph/memgraph/blob/784dd8520f65050d033aea8b29446e84e487d091/src/storage/v2/indices/vector_index.cpp), [announcement](https://memgraph.com/blog/simplify-data-retrieval-memgraph-vector-search).
+- [x] Memgraph: [C++](https://github.com/memgraph/memgraph/blob/784dd8520f65050d033aea8b29446e84e487d091/src/storage/v2/indices/vector_index.cpp), [announcement](https://memgraph.com/blog/simplify-data-retrieval-memgraph-vector-search).
 - [x] LanternDB: [C++](https://github.com/lanterndata/lantern), [Rust](https://github.com/lanterndata/lantern_extras), [docs](https://lantern.dev/blog/hnsw-index-creation).
 - [x] LangChain: [Python](https://github.com/langchain-ai/langchain/releases/tag/v0.0.257) and [JavaScript](https://github.com/hwchase17/langchainjs/releases/tag/0.0.125).
 - [x] Microsoft Semantic Kernel: [Python](https://github.com/microsoft/semantic-kernel/releases/tag/python-0.3.9.dev) and C#.
 - [x] GPTCache: [Python](https://github.com/zilliztech/GPTCache/releases/tag/0.1.29).
 - [x] Sentence-Transformers: Python [docs](https://www.sbert.net/docs/package_reference/quantization.html#sentence_transformers.quantization.semantic_search_usearch).
 - [x] Pathway: [Rust](https://github.com/pathwaycom/pathway).
-- [x] Memgraph: [C++ MVP](https://github.com/memgraph/memgraph/pull/2406), [C++ Stable](https://github.com/memgraph/memgraph/pull/2500), [docs](https://memgraph.com/docs/querying/vector-search)
-- [x] TiDB: [C++](https://github.com/pingcap/tiflash/pull/9486), [docs](https://docs.pingcap.com/tidb/stable/vector-search-index#vector-search-index)
+  
 
 ## Citations
 
@@ -550,7 +551,7 @@ doi = {10.5281/zenodo.7949416},
 author = {Vardanian, Ash},
 title = {{USearch by Unum Cloud}},
 url = {https://github.com/unum-cloud/usearch},
-version = {2.20.5},
+version = {2.20.7},
 year = {2023},
 month = oct,
 }

package/c/README.md

@@ -36,7 +36,7 @@ int main() {
     if (error) goto cleanup;
     
     // Check up:
-    assert(usearch_size(index, &error) == vectors_count);
+    assert(usearch_size(index, &error) == 1);
     assert(usearch_capacity(index, &error) == vectors_count);
     assert(usearch_contains(index, 42, &error));
 
@@ -47,8 +47,6 @@ int main() {
         index, &vector[0], usearch_scalar_f32_k, 10, 
         &found_keys[0], &found_distances[0], &error);
 
-    usearch_free(index, &error);
-
   cleanup:
     if (error) fprintf(stderr, "Error: %s\n", error);
     if (index) usearch_free(index, &error);
@@ -66,13 +64,13 @@ usearch_load(index, "index.usearch", &error);
 usearch_view(index, "index.usearch", &error);
 ```
 
-Before saving them do disk, you can determine exactly how much disk space the index will take:
+Before saving to disk, you can determine exactly how much disk space the index will take:
 
 ```c
 size_t bytes = usearch_serialized_length(index, &error);
 ```
 
-With a known size, you can serialize the index into an in-memory a buffer:
+With a known size, you can serialize the index into an in-memory buffer:
 
 ```c
 void* buffer = malloc(bytes);
@@ -158,7 +156,7 @@ size_t count_removed = usearch_remove(index, 43, &error);
 assert(count_renamed == count_removed);
 ```
 
-USearch can also be used for multi-indicies, where each key may map to multiple vectors.
+USearch can also be used for multi-indices, where each key may map to multiple vectors.
 That's a common case when implementing semantic search for long documents, where the entire documents can't fit into one input sequence in a transformer-model, and you have to split them into chunks.
 
 ```c
@@ -179,7 +177,7 @@ usearch_distance_t distance = usearch_distance(
     &vector_a[0], &vector_b[0], usearch_scalar_f32_k, dimensions, usearch_metric_cos_k, &error);
 ```
 
-Alternatively, you can benefir from faster thread-pools and priority queues for parallel exact batch-search.
+Alternatively, you can benefit from faster thread-pools and priority queues for parallel exact batch-search.
 
 ```c
 size_t threads = 0;
@@ -247,4 +245,3 @@ The second will print the memory usage of the index in bytes.
 printf("Hardware acceleration: %s\n", usearch_hardware_acceleration(index, &error));
 printf("Memory usage: %zu\n", usearch_memory_usage(index, &error));
 ```
-

package/c/usearch.h

@@ -478,8 +478,7 @@ USEARCH_EXPORT void usearch_exact_search(                            //
  *  @param[inout] index The handle to the USearch index to be modified.
  *  @param[out] error Pointer to a string where the error message will be stored, if an error occurs.
  */
-USEARCH_EXPORT void usearch_clear(usearch_index_t index,
-                                  usearch_error_t* error);
+USEARCH_EXPORT void usearch_clear(usearch_index_t index, usearch_error_t* error);
 
 #ifdef __cplusplus
 }

package/include/usearch/index.hpp

@@ -9,7 +9,7 @@
 
 #define USEARCH_VERSION_MAJOR 2
 #define USEARCH_VERSION_MINOR 20
-#define USEARCH_VERSION_PATCH 5
+#define USEARCH_VERSION_PATCH 7
 
 // Inferring C++ version
 // https://stackoverflow.com/a/61552074

package/javascript/README.md

@@ -28,6 +28,8 @@ assert.deepEqual(results.distances, new Float32Array([0]));
 index.remove(42n);
 ```
 
+Note: keys are 64-bit integers represented as JavaScript `BigInt` (e.g., `42n`).
+
 ## Serialization
 
 Persist and restore your index with serialization methods:

package/javascript/dist/cjs/usearch.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
     if (kind === "m") throw new TypeError("Private method is not writable");
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
@@ -38,7 +48,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var _Index_compiledIndex;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.exactSearch = exports.Index = exports.BatchMatches = exports.Matches = exports.ScalarKind = exports.MetricKind = void 0;
+exports.Index = exports.BatchMatches = exports.Matches = exports.ScalarKind = exports.MetricKind = void 0;
+exports.exactSearch = exactSearch;
 const node_gyp_build_1 = __importDefault(require("node-gyp-build"));
 const path = __importStar(require("path"));
 const fs_1 = require("fs");
@@ -512,7 +523,6 @@ function exactSearch(dataset, queries, dimensions, count, metric, threads = 0) {
         return new BatchMatches(...result, count);
     }
 }
-exports.exactSearch = exactSearch;
 const usearch = {
     Index,
     MetricKind,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "usearch",
-    "version": "2.20.5",
+    "version": "2.20.7",
     "description": "Smaller & Faster Single-File Vector Search Engine from Unum",
     "author": "Ash Vardanian (https://ashvardanian.com/)",
     "license": "Apache 2.0",
@@ -29,8 +29,8 @@
     ],
     "dependencies": {
         "bindings": "^1.5.0",
-        "node-addon-api": "^8.0.0",
-        "node-gyp-build": "^4.8.0"
+        "node-addon-api": "^8.5.0",
+        "node-gyp-build": "^4.8.4"
     },
     "scripts": {
         "test": "node --test ./javascript/usearch.test.js",
@@ -42,10 +42,10 @@
     },
     "devDependencies": {
         "@types/bindings": "^1.5.5",
-        "@types/node": "^20.12.4",
-        "node-gyp": "^10.1.0",
-        "prebuildify": "^6.0.0",
-        "typescript": "^5.4.4"
+        "@types/node": "^24.3.0",
+        "node-gyp": "^11.4.2",
+        "prebuildify": "^6.0.1",
+        "typescript": "^5.9.2"
     },
     "main": "javascript/dist/cjs/usearch.js",
     "module": "javascript/dist/esm/usearch.js",
@@ -55,4 +55,4 @@
             "require": "./javascript/dist/cjs/usearch.js"
         }
     }
-}
+}