usearch 0.1.6 → 0.1.8

package/.github/workflows/release.yml

@@ -108,6 +108,28 @@ jobs:
       with:
           registry-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}          
 
+  publish_java:
+    name: Publish Java
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+    - uses: actions/checkout@v3
+    - run: git submodule update --init --recursive
+    - uses: actions/setup-java@v3
+      with:
+        java-version: '11'
+        distribution: 'adopt'
+    - name: Setup Gradle
+      uses: gradle/gradle-build-action@v2    
+    - name: Execute Gradle build
+      run: gradle clean build
+    - name: Publish package
+      run: gradle publish
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
   deploy_docs:
     name: Deploy Docs
     environment: 

package/.vscode/settings.json

@@ -105,5 +105,6 @@
         "ndim",
         "simsimd",
         "usearch"
-    ]
+    ],
+    "java.configuration.updateBuildConfiguration": "interactive"
 }

package/{CMakeListsInstructuons.md → CMakeListsInstructions.md}

@@ -74,13 +74,20 @@ cargo publish
 
 ### Java
 
+```sh
+gradle clean build
+java -cp . -Djava.library.path=/Users/av/github/usearch/build/libs/usearch/shared java/cloud/unum/usearch/Index.java
+```
+
+Or step by-step:
+
 ```sh
 cs java/unum/cloud/usearch
 javac -h . Index.java
 
 # Ubuntu:
 g++ -c -fPIC -I${JAVA_HOME}/include -I${JAVA_HOME}/include/linux cloud_unum_usearch_Index.cpp -o cloud_unum_usearch_Index.o
-g++ -shared -fPIC -o libUSearchJNI.so cloud_unum_usearch_Index.o -lc
+g++ -shared -fPIC -o libusearch.so cloud_unum_usearch_Index.o -lc
 
 # Windows
 g++ -c -I%JAVA_HOME%\include -I%JAVA_HOME%\include\win32 cloud_unum_usearch_Index.cpp -o cloud_unum_usearch_Index.o
@@ -90,7 +97,7 @@ g++ -shared -o USearchJNI.dll cloud_unum_usearch_Index.o -Wl,--add-stdcall-alias
 g++ -std=c++11 -c -fPIC \
     -I../../../../include -I../../../../src -I../../../../fp16/include -I../../../../simsimd/include \
     -I${JAVA_HOME}/include -I${JAVA_HOME}/include/darwin cloud_unum_usearch_Index.cpp -o cloud_unum_usearch_Index.o
-g++ -dynamiclib -o libUSearchJNI.dylib cloud_unum_usearch_Index.o -lc
+g++ -dynamiclib -o libusearch.dylib cloud_unum_usearch_Index.o -lc
 # Run linking to that directory
 java -cp . -Djava.library.path=/Users/av/github/usearch/java/cloud/unum/usearch/ Index.java
 java -cp . -Djava.library.path=/Users/av/github/usearch/java cloud.unum.usearch.Index

package/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "usearch"
-version = "0.1.6"
+version = "0.1.8"
 authors = ["Ashot Vardanian <1983160+ashvardanian@users.noreply.github.com>"]
 description = "The Mighty Tiny Vector Search Engine with Automatic Quantization and Hardware Acceleration"
 edition = "2021"

package/README.md

@@ -29,9 +29,11 @@ Compact, yet Powerful<br/>
 - [x] Don't copy vectors if not needed.
 - [x] Bring your threads.
 - [x] Multiple vectors per label.
-- [x] Python bindings: `pip install usearch`
-- [x] JavaScript bindings: `npm install usearch`
-- [x] Rust bindings: `cargo add usearch`
+- [x] Python bindings: `pip install usearch`.
+- [x] JavaScript bindings: `npm install usearch`.
+- [x] Rust bindings: `cargo add usearch`.
+- [x] Java bindings: `cloud.unum:usearch` on GitHub.
+- [ ] GoLang bindings.
 - [ ] Wolfram language bindings.
 - [x] For Linux: GCC, Clang.
 - [x] For MacOS: Apple Clang.
@@ -42,26 +44,85 @@ Compact, yet Powerful<br/>
 
 ## Usage
 
+There are two usage patters:
+
+- Bare-bones with `usearch/usearch.hpp`, only available in C++.
+- Full-fat version with it's own threads, mutexes, type-punning, quantization, that is available both in C++ and is wrapped for higher-level bindings.
+
 ### C++
 
 To use in a C++ project simply copy the `include/usearch/usearch.hpp` header into your project.
+Alternatively fetch it with CMake:
+
+```cmake
+FetchContent_Declare(usearch GIT_REPOSITORY https://github.com/unum-cloud/usearch.git)
+FetchContent_MakeAvailable(usearch)
+```
+
+The simple usage example would require including the `unum::usearch` namespace and choosing the right "distance" function.
+That can be one of the following templates:
+
+- `cos_gt<float>` for "Cosine" or "Angular" distance.
+- `ip_gt<float>` for "Inner Product" or "Dot Product" distance.
+- `l2_squared_gt<float>` for the squared "L2" or "Euclidean" distance.
+- `jaccard_gt<int>` for "Jaccard" distance between two ordered sets of unique elements.
+- `bit_hamming_gt<uint>` for "Hamming" distance, as the number of shared bits in hashes.
+- `pearson_correlation_gt<float>` for "Pearson" correlation between probability distributions.
+- `haversine_gt<float>` for "Haversine" or "Great Circle" distance between coordinates.
+
+That list is easily extendible, and can include similarity measures for vectors that have a different number of elements/dimensions.
+The minimal example would be.
 
 ```c++
 using namespace unum::usearch;
 
 index_gt<cos_gt<float>> index;
 float vec[3] = {0.1, 0.3, 0.2};
+
+index.reserve(10);
 index.add(/* label: */ 42, /* vector: */ {&vec, 3});
 index.search(
-  /* query: */ {&vec, 3}, 10 /* results */,
-  /* callback: */ [](std::size_t label, float distance) { });
+  /* query: */ {&vec, 3}, /* top */ 5 /* results */,
+  /* with callback: */ [](std::size_t label, float distance) { });
+
+index.save("index.usearch"); // Serializing to disk
+index.load("index.usearch"); // Reconstructing from disk
+index.view("index.usearch"); // Memory-mapping from disk
 ```
 
-Alternatively fetch it with CMake:
+The `add` is thread-safe for concurrent index construction.
 
-```cmake
-FetchContent_Declare(usearch GIT_REPOSITORY https://github.com/unum-cloud/usearch.git)
-FetchContent_MakeAvailable(usearch)
+### Python
+
+Python bindings are implemented with [`pybind/pybind11`](https://github.com/pybind/pybind11).
+Assuming the presence of Global Interpreter Lock in Python, on large insertions we spawn threads in the C++ layer.
+
+```sh
+$ pip install usearch
+
+import numpy as np
+import usearch
+
+index = usearch.Index(
+    dim=256, # Define the number of dimensions in input vectors
+    metric='cos', # Choose the "metric" or "distance", default = 'ip', optional
+    dtype='f16', # Quantize to 'f16' or 'i8q100' if needed, default = 'f32', optional
+    connectivity=16, # How frequent should the connections in the graph be, optional
+    expansion_add=128, # Control the recall of indexing, optional
+    expansion_search=64, # Control the quality of search, optional
+)
+
+n = 100
+labels = np.array(range(n), dtype=np.longlong)
+vectors = np.random.uniform(0, 0.3, (n, index.ndim)).astype(np.float32)
+
+# You can avoid copying the data
+# Handy when build 1B+ indexes of memory-mapped files
+index.add(labels, vectors, copy=True)
+assert len(index) == n
+
+# You can search a batch at once
+matches, distances, counts = index.search(vectors, 10)
 ```
 
 ## Features
@@ -70,7 +131,6 @@ FetchContent_MakeAvailable(usearch)
 
 ## Performance
 
-
 ## TODO
 
 - JavaScript: Allow calling from "worker threads".

package/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.8

package/build.gradle

@@ -2,7 +2,6 @@ import org.gradle.internal.jvm.Jvm
 
 plugins {
     id 'java-library'
-    id 'c'
     id 'cpp'
     id 'maven-publish'
 }
@@ -21,7 +20,7 @@ sourceSets {
     main {
         java {
             srcDir "java/"
-            exclude "java/test/"
+            exclude "test/"
         }
     }
     test {
@@ -42,11 +41,11 @@ model {
             sources {
                 cpp {
                     source {
-                        srcDirs "cloud/unum/usearch"
+                        srcDirs "java/cloud/unum/usearch"
                         include "**/*.cpp"
                     }
                     exportedHeaders {
-                        srcDirs "include", "src", "${Jvm.current().javaHome}/include"
+                        srcDirs "include", "src", "fp16/include", "simsimd/include", "${Jvm.current().javaHome}/include"
                     }
                 }
             }
@@ -61,6 +60,7 @@ model {
                     cppCompiler.args '-I', "${Jvm.current().javaHome}/include/darwin"
                     cppCompiler.args '-D_FILE_OFFSET_BITS=64'
                 }
+                cppCompiler.args '-std=c++11'
             }
         }
     }
@@ -77,7 +77,10 @@ test {
 
 jar {
     dependsOn("usearchSharedLibrary")
-    from("$buildDir/libs/usearch/shared/libUSearchJNI.dylib")
+    into("usearch") {
+        from("$buildDir/libs/usearch/shared/libusearch.dylib")
+        from("$buildDir/libs/usearch/shared/libusearch.so")
+    }
 }
 
 publishing {
@@ -98,13 +101,26 @@ publishing {
             }
         }
     }
+
+    // Publishing to GitHub is much easier ;)
+    // repositories {
+    //     maven {
+    //         name = "OSSRH"
+    //         url = "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
+    //         credentials {
+    //             username = System.getenv("MAVEN_USERNAME")
+    //             password = System.getenv("MAVEN_PASSWORD")
+    //         }
+    //     }
+    // }
+
     repositories {
         maven {
-            name = "OSSRH"
-            url = "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
+            name = "GitHubPackages"
+            url = "https://maven.pkg.github.com/unum-cloud/usearch"
             credentials {
-                username = System.getenv("MAVEN_USERNAME")
-                password = System.getenv("MAVEN_PASSWORD")
+                username = System.getenv("GITHUB_ACTOR")
+                password = System.getenv("GITHUB_TOKEN")
             }
         }
     }

package/include/usearch/usearch.hpp

@@ -7,21 +7,25 @@
  *  @copyright Copyright (c) 2023
  */
 #pragma once
-#include <atomic>
-#include <bitset>  // `std::bitset`
-#include <climits> // `CHAR_BIT`
-#include <cmath>   // `std::sqrt`
-#include <cstring> // `std::memset`
-#include <mutex>
-#include <random>
-#include <utility> // `std::exchange`
-#include <vector>
-
+#include <algorithm> // `std::sort_heap`
+#include <atomic>    // `std::atomic`
+#include <bitset>    // `std::bitset`
+#include <climits>   // `CHAR_BIT`
+#include <cmath>     // `std::sqrt`
+#include <cstring>   // `std::memset`
+#include <mutex>     // `std::unique_lock` - replacement candidate
+#include <random>    // `std::default_random_engine` - replacement candidate
+#include <unistd.h>  // `open`, `close`
+#include <utility>   // `std::exchange`
+#include <vector>    // `std::vector`
+
+#if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__NT__)
+#else
 #include <fcntl.h>    // `fallocate`
 #include <stdlib.h>   // `posix_memalign`
 #include <sys/mman.h> // `mmap`
 #include <sys/stat.h> // `fstat` for file size
-#include <unistd.h>   // `open`, `close`
+#endif
 
 #if defined(__GNUC__)
 // https://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html
@@ -965,6 +969,9 @@ class index_gt {
      *  Compatibility: Linux, MacOS.
      */
     void view(char const* file_path) noexcept(false) {
+#if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__NT__)
+        throw std::logic_error("Memory-mapping is not yet available for Windows");
+#else
         state_t state;
         int open_flags = O_RDONLY;
 #if __linux__
@@ -1012,6 +1019,7 @@ class index_gt {
         }
 
         viewed_file_descriptor_ = descriptor;
+#endif
     }
 
 #pragma endregion

package/java/cloud/unum/usearch/Index.java

@@ -1,5 +1,10 @@
 package cloud.unum.usearch;
 
+import java.io.File;
+import java.nio.file.Files;
+import java.nio.file.StandardCopyOption;
+import java.io.InputStream;
+
 /**
  * @brief Java bindings for Unum USearch.
  * 
@@ -124,7 +129,7 @@ public class Index {
   }
 
   static {
-    System.loadLibrary("USearchJNI");
+    System.loadLibrary("usearch");
   }
 
   public static void main(String[] args) {

package/java/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0-bin.zip
+networkTimeout=10000
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

package/java/gradlew

@@ -0,0 +1,244 @@
+#!/bin/sh
+
+#
+# Copyright © 2015-2021 the original authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+#
+#   Gradle start up script for POSIX generated by Gradle.
+#
+#   Important for running:
+#
+#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+#       noncompliant, but you have some other compliant shell such as ksh or
+#       bash, then to run this script, type that shell name before the whole
+#       command line, like:
+#
+#           ksh Gradle
+#
+#       Busybox and similar reduced shells will NOT work, because this script
+#       requires all of these POSIX shell features:
+#         * functions;
+#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+#         * compound commands having a testable exit status, especially «case»;
+#         * various built-in commands including «command», «set», and «ulimit».
+#
+#   Important for patching:
+#
+#   (2) This script targets any POSIX shell, so it avoids extensions provided
+#       by Bash, Ksh, etc; in particular arrays are avoided.
+#
+#       The "traditional" practice of packing multiple parameters into a
+#       space-separated string is a well documented source of bugs and security
+#       problems, so this is (mostly) avoided, by progressively accumulating
+#       options in "$@", and eventually passing that to Java.
+#
+#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+#       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
+#       see the in-line comments for details.
+#
+#       There are tweaks for specific operating systems such as AIX, CygWin,
+#       Darwin, MinGW, and NonStop.
+#
+#   (3) This script is generated from the Groovy template
+#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       within the Gradle project.
+#
+#       You can find Gradle at https://github.com/gradle/gradle/.
+#
+##############################################################################
+
+# Attempt to set APP_HOME
+
+# Resolve links: $0 may be a link
+app_path=$0
+
+# Need this for daisy-chained symlinks.
+while
+    APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
+    [ -h "$app_path" ]
+do
+    ls=$( ls -ld "$app_path" )
+    link=${ls#*' -> '}
+    case $link in             #(
+      /*)   app_path=$link ;; #(
+      *)    app_path=$APP_HOME$link ;;
+    esac
+done
+
+# This is normally unused
+# shellcheck disable=SC2034
+APP_BASE_NAME=${0##*/}
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD=maximum
+
+warn () {
+    echo "$*"
+} >&2
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+} >&2
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "$( uname )" in                #(
+  CYGWIN* )         cygwin=true  ;; #(
+  Darwin* )         darwin=true  ;; #(
+  MSYS* | MINGW* )  msys=true    ;; #(
+  NONSTOP* )        nonstop=true ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD=$JAVA_HOME/jre/sh/java
+    else
+        JAVACMD=$JAVA_HOME/bin/java
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD=java
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+    case $MAX_FD in #(
+      max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045
+        MAX_FD=$( ulimit -H -n ) ||
+            warn "Could not query maximum file descriptor limit"
+    esac
+    case $MAX_FD in  #(
+      '' | soft) :;; #(
+      *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045
+        ulimit -n "$MAX_FD" ||
+            warn "Could not set maximum file descriptor limit to $MAX_FD"
+    esac
+fi
+
+# Collect all arguments for the java command, stacking in reverse order:
+#   * args from the command line
+#   * the main class name
+#   * -classpath
+#   * -D...appname settings
+#   * --module-path (only if needed)
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "$cygwin" || "$msys" ; then
+    APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+    CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
+
+    JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    for arg do
+        if
+            case $arg in                                #(
+              -*)   false ;;                            # don't mess with options #(
+              /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
+                    [ -e "$t" ] ;;                      #(
+              *)    false ;;
+            esac
+        then
+            arg=$( cygpath --path --ignore --mixed "$arg" )
+        fi
+        # Roll the args list around exactly as many times as the number of
+        # args, so each arg winds up back in the position where it started, but
+        # possibly modified.
+        #
+        # NB: a `for` loop captures its iteration list before it begins, so
+        # changing the positional parameters here affects neither the number of
+        # iterations, nor the values presented in `arg`.
+        shift                   # remove old arg
+        set -- "$@" "$arg"      # push replacement arg
+    done
+fi
+
+# Collect all arguments for the java command;
+#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
+#     shell script including quotes and variable substitutions, so put them in
+#     double quotes to make sure that they get re-expanded; and
+#   * put everything else in single quotes, so that it's not re-expanded.
+
+set -- \
+        "-Dorg.gradle.appname=$APP_BASE_NAME" \
+        -classpath "$CLASSPATH" \
+        org.gradle.wrapper.GradleWrapperMain \
+        "$@"
+
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+#   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
+#   set -- "${ARGS[@]}" "$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- $(
+        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
+        xargs -n1 |
+        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+        tr '\n' ' '
+    )" '"$@"'
+
+exec "$JAVACMD" "$@"

package/java/test/IndexTest.java

@@ -6,7 +6,6 @@ import org.junit.Test;
 import cloud.unum.usearch.Index;
 
 public class IndexTest {
-
     public static void deleteDirectoryFiles(String path) {
         File directory = new File(path);
         if (!directory.isDirectory())
@@ -20,7 +19,7 @@ public class IndexTest {
     public void test() {
         String path = "./tmp/";
         deleteDirectoryFiles(path);
-        new Index();
+        // new Index("cos", "f32", 1, 10, 1, 1, 1);
         System.out.println("Java Tests Passed!");
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "usearch",
-    "version": "0.1.6",
+    "version": "0.1.8",
     "description": "The Mighty Tiny Vector Search Engine with Automatic Quantization and Hardware Acceleration",
     "author": "Ashot Vardanian",
     "license": "Apache 2.0",

package/python/lib.cpp

@@ -198,6 +198,12 @@ PYBIND11_MODULE(usearch, m) {
         py::arg("count") = 10       //
     );
 
+    i.def("__len__", &native_index_t::size);
+    i.def_property_readonly("size", &native_index_t::size);
+    i.def_property_readonly("ndim", &native_index_t::dimensions);
+    i.def_property_readonly("connectivity", &native_index_t::connectivity);
+    i.def_property_readonly("capacity", &native_index_t::capacity);
+
     i.def("save", &save_index, py::arg("path"));
     i.def("load", &load_index, py::arg("path"));
     i.def("view", &view_index, py::arg("path"));

package/pom.xml

@@ -1,8 +0,0 @@
-<dependencies>
-  <dependency>
-    <groupId>junit</groupId>
-    <artifactId>junit</artifactId>
-    <version>4.12</version>
-    <scope>test</scope>
-  </dependency>
-</dependencies>