Renamed Vstore to vztor and made nmslib external dep

Author: B-R-P

build.zig

@@ -9,9 +9,9 @@ pub fn build(b: *std.Build) void {
     // ------------------------------------------------------------
     // Dependencies
     // ------------------------------------------------------------
-    const nmslib_dep = b.dependency("nmslib", .{});
+    const nmslib_dep = b.dependency("nmslib", .{
+    });
     const lmdbx_dep  = b.dependency("lmdbx",  .{
-        .optimize = .Debug,
     });
 
     // ------------------------------------------------------------
@@ -24,29 +24,33 @@ pub fn build(b: *std.Build) void {
     // ------------------------------------------------------------
     // Executable (fast debug build)
     // ------------------------------------------------------------
-    const exe_root = b.createModule(.{
+    const lib_root = b.createModule(.{
         .root_source_file = b.path("src/main.zig"),
         .target = target,
         .optimize = .Debug,
     });
 
-    const exe = b.addExecutable(.{
-        .name = "VStore",
-        .root_module = exe_root,
+    // const nmslib_lib = nmslib_dep.artifact("nmslib");
+    const nmslib_mod = nmslib_dep.module("nmslib");
+
+    const lib = b.addLibrary(.{
+        .name = "Vztor",
+        .linkage = .static,
+        .root_module = lib_root,
     });
 
-    exe.root_module.addImport("build_opts", build_opts.createModule());
-    exe.root_module.addImport("utils", b.createModule(.{
+    lib.root_module.addImport("build_opts", build_opts.createModule());
+    lib.root_module.addImport("utils", b.createModule(.{
         .root_source_file = b.path("src/utils.zig"),
     }));
 
-    exe.root_module.addImport("lmdbx", lmdbx_dep.module("lmdbx"));
-    exe.root_module.addImport("nmslib", nmslib_dep.module("nmslib"));
+    lib.root_module.addImport("lmdbx", lmdbx_dep.module("lmdbx"));
+    lib.root_module.addImport("nmslib", nmslib_mod);
 
-    exe.linkLibCpp();
-    b.installArtifact(exe);
 
-    const run_cmd = b.addRunArtifact(exe);
+    b.installArtifact(lib);
+
+    const run_cmd = b.addRunArtifact(lib);
     const run_step = b.step("run", "Run VStore in debug mode");
     run_step.dependOn(&run_cmd.step);
 
@@ -63,16 +67,14 @@ pub fn build(b: *std.Build) void {
         .root_module = test_root,
     });
 
-    // mirror imports so tests see same world as exe
+    // mirror imports so tests see same world as lib
     tests.root_module.addImport("build_opts", build_opts.createModule());
     tests.root_module.addImport("utils", b.createModule(.{
         .root_source_file = b.path("src/utils.zig"),
     }));
     tests.root_module.addImport("lmdbx", lmdbx_dep.module("lmdbx"));
-    tests.root_module.addImport("nmslib", nmslib_dep.module("nmslib"));
-
-    tests.linkLibCpp();
-
+    tests.root_module.addImport("nmslib", nmslib_mod);
+ 
     const run_tests = b.addRunArtifact(tests);
     const test_step = b.step("test", "Run VStore tests");
     test_step.dependOn(&run_tests.step);

build.zig.zon

@@ -6,7 +6,7 @@
     //
     // It is redundant to include "zig" in this name because it is already
     // within the Zig package namespace.
-    .name = .VStore,
+    .name = .Vztor,
     // This is a [Semantic Version](https://semver.org/).
     // In a future version of Zig it will be used for package deduplication.
     .version = "0.0.0",
@@ -22,7 +22,7 @@
     // original project's identity. Thus it is recommended to leave the comment
     // on the following line intact, so that it shows up in code reviews that`
     // modify the field.
-    .fingerprint = 0x93a1ca272d548e10, // Changing this has security and trust implications.
+    .fingerprint = 0x7a652a7af8d35233, // Changing this has security and trust implications.
     // Tracks the earliest Zig version that the package considers to be a
     // supported use case.
     .minimum_zig_version = "0.16.0-dev.457+f90510b08",
@@ -32,9 +32,6 @@
     // Once all dependencies are fetched, `zig build` no longer requires
     // internet connectivity.
     .dependencies = .{
-        .nmslib = .{
-            .path = "../nmslib-zig", // path to your library project
-        },
         // See `zig fetch --save <url>` for a command-line interface for adding dependencies.
         //.example = .{
         //    // When updating this field to a new URL, be sure to delete the corresponding
@@ -68,6 +65,10 @@
             .url = "https://github.com/theseyan/lmdbx-zig/archive/refs/tags/v0.2.0.tar.gz",
             .hash = "lmdbx-0.1.2-WlIvzjFVAwDUzL6W5PcOnaxpazqXl9wEyx0K0H0Gv_9R",
         },
+        .nmslib = .{
+            .url = "https://github.com/B-R-P/NMSLIB-ZIG/archive/refs/heads/main.tar.gz",
+            .hash = "nmslib-0.1.0-7XQ0QQJrDwBigBxLkzWxkEZJPBDCEI91mwm6fQtmEfu0",
+        },
     },
     // Specifies the set of files and directories that are included in this package.
     // Only files and directories listed here are included in the `hash` that

src/main.zig

@@ -19,7 +19,7 @@ const searchResult = struct {
 };
 
 
-pub const VStore = struct {
+pub const Vztor = struct {
     const Self = @This();
 
     arena: std.heap.ArenaAllocator,
@@ -182,7 +182,7 @@ pub const VStore = struct {
         // Commit setup transaction; DB and txn handles go out of scope here
         try txn.commit();
 
-        // Store everything into VStore
+        // Store everything into Vztor
         store.env = env;
         store.rnd = rnd;
         store.counter = counter;
@@ -289,7 +289,7 @@ pub const VStore = struct {
 
         try txn.commit();
 
-        // Return keys that were allocated with stable_alloc (owned by VStore)
+        // Return keys that were allocated with stable_alloc (owned by Vztor)
         return nnkeys;
     }
 
@@ -346,7 +346,7 @@ pub const VStore = struct {
 
     fn search(self: *Self, vector: nmslib.QueryPoint, k: usize) ![]searchResult {
 
-        // Stable allocator for returned results (owned by VStore)
+        // Stable allocator for returned results (owned by Vztor)
         const stable_alloc = self.arena.allocator();
 
         const knn_result = try self.index.knnQuery(vector, k);
@@ -426,7 +426,7 @@ pub fn main() !void {
     const dist_type = nmslib.DistType.Float;
     std.debug.assert(nmslib.isValidSpaceType(space_type));
 
-    var store = try VStore.init(allocator, db_path, space_type, vector_type, dist_type, max_readers);
+    var store = try Vztor.init(allocator, db_path, space_type, vector_type, dist_type, max_readers);
     defer store.deinit() catch unreachable;
 
 
@@ -452,8 +452,8 @@ pub fn main() !void {
 
 
 
-test "VStore: basic put/get/save and reload" {
-    std.debug.print("[ ] VStore: basic put/get/save and reload\n", .{});
+test "Vztor: basic put/get/save and reload" {
+    std.debug.print("[ ] Vztor: basic put/get/save and reload\n", .{});
 
     const allocator = std.heap.page_allocator;
     const db_path = "testdb_vstore_zigtest";
@@ -462,7 +462,7 @@ test "VStore: basic put/get/save and reload" {
     const dist_type = nmslib.DistType.Float;
 
     // Initialize the store
-    var store = try VStore.init(allocator, db_path, space_type, vector_type, dist_type, 16);
+    var store = try Vztor.init(allocator, db_path, space_type, vector_type, dist_type, 16);
 
     // Prepare two sparse vectors and payloads
     const vectors = [_][]const nmslib.SparseElem{
@@ -498,7 +498,7 @@ test "VStore: basic put/get/save and reload" {
     try store.deinit();
 
     // Re-open the store from the same path (index should be loaded from disk)
-    var reopened = try VStore.init(allocator, db_path, space_type, vector_type, dist_type, 16);
+    var reopened = try Vztor.init(allocator, db_path, space_type, vector_type, dist_type, 16);
 
     // Re-fetch using the copied key (not owned by the arena)
     const got2 = try reopened.batchGet(key_copy);
@@ -512,21 +512,21 @@ test "VStore: basic put/get/save and reload" {
     const cwd = std.fs.cwd();
     cwd.deleteTree(db_path) catch {};
 
-    std.debug.print("[x] VStore: basic put/get/save and reload\n", .{});
+    std.debug.print("[x] Vztor: basic put/get/save and reload\n", .{});
 }
 
 
 
-test "VStore: batchPut returns unique keys on repeated insert" {
-    std.debug.print("[ ] VStore: batchPut returns unique keys on repeated insert\n", .{});
+test "Vztor: batchPut returns unique keys on repeated insert" {
+    std.debug.print("[ ] Vztor: batchPut returns unique keys on repeated insert\n", .{});
 
     const allocator = std.heap.page_allocator;
     const db_path = "testdb_vstore_unique_keys";
     const space_type = "negdotprod_sparse";
     const vector_type = nmslib.DataType.SparseVector;
     const dist_type = nmslib.DistType.Float;
 
-    var store = try VStore.init(allocator, db_path, space_type, vector_type, dist_type, 16);
+    var store = try Vztor.init(allocator, db_path, space_type, vector_type, dist_type, 16);
 
     const vectors = [_][]const nmslib.SparseElem{
         &[_]nmslib.SparseElem{
@@ -557,21 +557,21 @@ test "VStore: batchPut returns unique keys on repeated insert" {
     const cwd = std.fs.cwd();
     cwd.deleteTree(db_path) catch {};
 
-    std.debug.print("[x] VStore: batchPut returns unique keys on repeated insert\n", .{});
+    std.debug.print("[x] Vztor: batchPut returns unique keys on repeated insert\n", .{});
 }
 
 
 
-test "VStore: batchGet returns KeyNotFound for missing key" {
-    std.debug.print("[ ] VStore: batchGet returns KeyNotFound for missing key\n", .{});
+test "Vztor: batchGet returns KeyNotFound for missing key" {
+    std.debug.print("[ ] Vztor: batchGet returns KeyNotFound for missing key\n", .{});
     const allocator = std.heap.page_allocator;
     const db_path = "testdb_vstore_missing_key";
     const space_type = "negdotprod_sparse";
     const vector_type = nmslib.DataType.SparseVector;
     const dist_type = nmslib.DistType.Float;
 
     {
-        var store = try VStore.init(allocator, db_path, space_type, vector_type, dist_type, 8);
+        var store = try Vztor.init(allocator, db_path, space_type, vector_type, dist_type, 8);
 
         // Attempt to get a key that does not exist
         const res = store.batchGet("no-such-key");
@@ -583,19 +583,19 @@ test "VStore: batchGet returns KeyNotFound for missing key" {
 
     const cwd = std.fs.cwd();
     cwd.deleteTree(db_path) catch {};
-    std.debug.print("[x] VStore: batchGet returns KeyNotFound for missing key\n", .{});
+    std.debug.print("[x] Vztor: batchGet returns KeyNotFound for missing key\n", .{});
 }
 
 
-test "VStore: bulk 10 insert and retrieve" {
-    std.debug.print("[ ] VStore: bulk 10 insert and retrieve\n", .{});
+test "Vztor: bulk 10 insert and retrieve" {
+    std.debug.print("[ ] Vztor: bulk 10 insert and retrieve\n", .{});
     const allocator = std.heap.page_allocator;
     const db_path = "testdb_vstore_bulk10";
     const space_type = "negdotprod_sparse";
     const vector_type = nmslib.DataType.SparseVector;
     const dist_type = nmslib.DistType.Float;
 
-    var store = try VStore.init(allocator, db_path, space_type, vector_type, dist_type, 16);
+    var store = try Vztor.init(allocator, db_path, space_type, vector_type, dist_type, 16);
     defer store.deinit() catch unreachable;
 
     const vectors = [_][]const nmslib.SparseElem{
@@ -636,11 +636,11 @@ test "VStore: bulk 10 insert and retrieve" {
 
     const cwd = std.fs.cwd();
     cwd.deleteTree(db_path) catch {};
-    std.debug.print("[x] VStore: bulk 10 insert and retrieve\n", .{});
+    std.debug.print("[x] Vztor: bulk 10 insert and retrieve\n", .{});
 }
 
-test "VStore: init tolerates empty IDX directory" {
-    std.debug.print("[ ] VStore: init tolerates empty IDX directory\n", .{});
+test "Vztor: init tolerates empty IDX directory" {
+    std.debug.print("[ ] Vztor: init tolerates empty IDX directory\n", .{});
     const allocator = std.heap.page_allocator;
     const db_path = "testdb_vstore_empty_idx";
     const space_type = "negdotprod_sparse";
@@ -656,7 +656,7 @@ test "VStore: init tolerates empty IDX directory" {
     try cwd.makePath(db_path ++ "/IDX");
 
     // This call used to fail when IDX existed but had no index.
-    var store = try VStore.init(allocator, db_path, space_type, vector_type, dist_type, 16);
+    var store = try Vztor.init(allocator, db_path, space_type, vector_type, dist_type, 16);
     defer store.deinit() catch unreachable;
 
     // Store should be usable: do a simple put/get round-trip
@@ -672,5 +672,5 @@ test "VStore: init tolerates empty IDX directory" {
 
     // Cleanup
     cwd.deleteTree(db_path) catch {};
-    std.debug.print("[x] VStore: init tolerates empty IDX directory\n", .{});
+    std.debug.print("[x] Vztor: init tolerates empty IDX directory\n", .{});
 }