usearch 0.4.0 → 0.8.0

package/.clang-tidy

@@ -0,0 +1,60 @@
+Checks: '*,
+         -altera-id-dependent-backward-branch,
+         -altera-struct-pack-align,
+         -altera-unroll-loops,
+         -android-cloexec-fopen,
+         -bugprone-easily-swappable-parameters,
+         -cert-err58-cpp,
+         -concurrency-mt-unsafe,
+         -cppcoreguidelines-avoid-const-or-ref-data-members,
+         -cppcoreguidelines-avoid-do-while,
+         -cppcoreguidelines-avoid-goto,
+         -cppcoreguidelines-avoid-magic-numbers,
+         -cppcoreguidelines-avoid-non-const-global-variables,
+         -cppcoreguidelines-macro-usage,
+         -cppcoreguidelines-pro-bounds-array-to-pointer-decay,
+         -cppcoreguidelines-pro-bounds-constant-array-index,
+         -cppcoreguidelines-pro-bounds-pointer-arithmetic,
+         -cppcoreguidelines-pro-type-reinterpret-cast,
+         -cppcoreguidelines-pro-type-union-access,
+         -cppcoreguidelines-rvalue-reference-param-not-moved,
+         -cppcoreguidelines-virtual-class-destructor,
+         -fuchsia-default-arguments-calls,
+         -fuchsia-default-arguments-declarations,
+         -fuchsia-overloaded-operator,
+         -google-explicit-constructor,
+         -google-readability-function-size,
+         -google-runtime-int,
+         -google-runtime-references,
+         -hicpp-avoid-goto,
+         -hicpp-explicit-conversions,
+         -hicpp-function-size,
+         -hicpp-no-array-decay,
+         -hicpp-no-assembler,
+         -hicpp-signed-bitwise,
+         -hicpp-uppercase-literal-suffix,
+         -llvm-header-guard,
+         -llvm-include-order,
+         -llvmlibc-*,
+         -misc-use-anonymous-namespace,
+         -misc-confusable-identifiers,
+         -misc-no-recursion,
+         -misc-non-private-member-variables-in-classes,
+         -modernize-concat-nested-namespaces,
+         -modernize-type-traits,
+         -modernize-use-nodiscard,
+         -modernize-use-trailing-return-type,
+         -readability-function-cognitive-complexity,
+         -readability-function-size,
+         -readability-identifier-length,
+         -readability-magic-numbers,
+         -readability-redundant-access-specifiers,
+         -readability-simplify-boolean-expr,
+         -readability-uppercase-literal-suffix'
+
+CheckOptions:
+  - key: hicpp-special-member-functions.AllowSoleDefaultDtor
+    value: 1
+
+WarningsAsErrors: '*'
+HeaderFilterRegex: '.*hpp$'

package/.github/workflows/release.yml

@@ -54,12 +54,7 @@ jobs:
       - name: Install CIBuildWheel
         run: python -m pip install cibuildwheel
 
-      - name: Build wheels for Windows
-        if: matrix.os == 'windows-2022'
-        run: python -m cibuildwheel
-
-      - name: Build wheels for POSIX
-        if: matrix.os != 'windows-2022'
+      - name: Build wheels
         run: python -m cibuildwheel
 
       - uses: actions/upload-artifact@v3
@@ -165,21 +160,18 @@ jobs:
     - name: Run tests
       run: swift test
 
-  deploy_docs:
-    name: Deploy Docs
-    environment: 
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
+  build_docs:
+    name: Build Docs
     runs-on: ubuntu-22.04
     if: ${{ always() }}
     needs: [publish_python, publish_javascript, publish_rust, publish_java, publish_swift]
+    permissions:
+      contents: write
     steps:
       - name: Checkout
         uses: actions/checkout@v3
         with:
           ref: 'main'   
-      - name: Setup GitHub Pages
-        uses: actions/configure-pages@v2
       - name: Install dependencies
         run: sudo apt update && sudo apt install -y doxygen graphviz dia git && pip install sphinx breathe furo m2r2 sphinxcontrib-googleanalytics==0.2.dev20220708 sphinxcontrib-jquery
       - name: Install USearch from PyPi
@@ -188,11 +180,45 @@ jobs:
         run: cd docs && make html
       - name: Copy assets
         run: cp -r assets build/docs/html/
+      - name: Compress assets
+        run: tar -czvf docs.tar.gz build/docs/html/
+      - name: Upload docs to release
+        uses: xresloader/upload-to-github-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          file: docs.tar.gz
+          asset_name: docs.tar.gz
+
+  deploy_docs_pages:
+    name: Deploy GitHub Pages
+    environment: 
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-22.04
+    needs: build_docs
+    if: ${{ github.event.build_docs.conclusion == 'success' }}
+    steps:
+      - uses: robinraju/release-downloader@v1.8
+        with:
+          latest: true
+          fileName: docs.tar.gz
+      - name: Setup GitHub Pages
+        uses: actions/configure-pages@v2
       - name: Upload artifacts
         uses: actions/upload-pages-artifact@v1
-        with:
-          # Upload entire repository
-          path: "./build/docs/html/"
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v1
+
+  deploy_docs_vercel:
+    name: Deploy Vercel
+    runs-on: ubuntu-22.04
+    needs: build_docs
+    if: ${{ github.event.build_docs.conclusion == 'success' }}
+    steps:
+      - name: Notify Vercel
+        uses: fjogeleit/http-request-action@v1
+        with:
+          url: ${{ secrets.DOCS_VERCEL }}
+          method: 'POST'

package/.github/workflows/update_version.sh

@@ -2,5 +2,6 @@
 
 echo $1 > VERSION && 
     sed -i "s/\"version\": \".*\"/\"version\": \"$1\"/" package.json &&
+    sed -i "s/^version: .*/version: $1/" CITATION.cff &&
     sed -i "s/version = \".*\"/version = \"$1\"/" Cargo.toml &&
     sed -i "s/version = '.*'/version = '$1'/" conanfile.py

package/.vscode/launch.json

@@ -4,6 +4,28 @@
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
+        {
+            "name": "Unit Test C++",
+            "type": "cppdbg",
+            "request": "launch",
+            "program": "${workspaceFolder}/build_debug/test",
+            "cwd": "${workspaceFolder}",
+            "environment": [
+                {
+                    "name": "ASAN_OPTIONS",
+                    "value": "detect_leaks=0:atexit=1:strict_init_order=1:strict_string_checks=1"
+                }
+            ],
+            "stopAtEntry": false,
+            "linux": {
+                "preLaunchTask": "Linux Build C++ Bench Debug",
+                "MIMode": "gdb"
+            },
+            "osx": {
+                "preLaunchTask": "MacOS Build C++ Bench Debug",
+                "MIMode": "lldb"
+            }
+        },
         {
             "name": "Debug C++ Bench on Wiki 1M @Cos",
             "type": "cppdbg",

package/.vscode/settings.json

@@ -103,8 +103,10 @@
     },
     "cSpell.words": [
         "astype",
+        "Availible",
         "BLAS",
         "cflags",
+        "citerator",
         "downcasted",
         "Downcasting",
         "dtype",
@@ -112,12 +114,15 @@
         "FAISS",
         "hashable",
         "HNSW",
+        "hnswlib",
         "jaccard",
         "longlong",
         "memmap",
         "Napi",
+        "ndarray",
         "ndim",
         "Numba",
+        "OPENMP",
         "preprocess",
         "Quickstart",
         "simsimd",

package/.vscode/tasks.json

@@ -3,7 +3,7 @@
     "tasks": [
         {
             "label": "Linux Build C++ Bench Debug",
-            "command": "cmake -DCMAKE_CXX_COMPILER=gcc-12 -DCMAKE_CXX_COMPILER=g++-12 -DCMAKE_BUILD_TYPE=Debug -B ./build_debug && make bench -C ./build_debug",
+            "command": "cmake -DCMAKE_CXX_COMPILER=gcc-12 -DCMAKE_CXX_COMPILER=g++-12 -DCMAKE_BUILD_TYPE=Debug -B ./build_debug && make -C ./build_debug",
             "args": [],
             "type": "shell",
             "problemMatcher": [
@@ -12,7 +12,7 @@
         },
         {
             "label": "Linux Build C++ Bench Release",
-            "command": "cmake -DCMAKE_CXX_COMPILER=gcc-12 -DCMAKE_CXX_COMPILER=g++-12 -DCMAKE_BUILD_TYPE=RelWithDebInfo -B ./build_release && make bench -C ./build_release",
+            "command": "cmake -DCMAKE_CXX_COMPILER=gcc-12 -DCMAKE_CXX_COMPILER=g++-12 -DCMAKE_BUILD_TYPE=RelWithDebInfo -B ./build_release && make -C ./build_release",
             "args": [],
             "type": "shell",
             "problemMatcher": [
@@ -21,13 +21,13 @@
         },
         {
             "label": "MacOS Build C++ Bench Debug",
-            "command": "cmake -DCMAKE_C_COMPILER=/opt/homebrew/opt/llvm/bin/clang -DCMAKE_CXX_COMPILER=/opt/homebrew/opt/llvm/bin/clang++ -DCMAKE_BUILD_TYPE=Debug -B ./build_debug && make bench -C ./build_debug",
+            "command": "cmake -DCMAKE_C_COMPILER=/opt/homebrew/opt/llvm/bin/clang -DCMAKE_CXX_COMPILER=/opt/homebrew/opt/llvm/bin/clang++ -DCMAKE_BUILD_TYPE=Debug -B ./build_debug && make -C ./build_debug",
             "args": [],
             "type": "shell",
         },
         {
             "label": "MacOS Build C++ Bench Release",
-            "command": "cmake -DCMAKE_C_COMPILER=/opt/homebrew/opt/llvm/bin/clang -DCMAKE_CXX_COMPILER=/opt/homebrew/opt/llvm/bin/clang++ -DCMAKE_BUILD_TYPE=RelWithDebInfo -B ./build_release && make bench -C ./build_release",
+            "command": "cmake -DCMAKE_C_COMPILER=/opt/homebrew/opt/llvm/bin/clang -DCMAKE_CXX_COMPILER=/opt/homebrew/opt/llvm/bin/clang++ -DCMAKE_BUILD_TYPE=RelWithDebInfo -B ./build_release && make -C ./build_release",
             "args": [],
             "type": "shell"
         }

package/CITATION.cff

@@ -0,0 +1,11 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Vardanian"
+  given-names: "Ashot"
+  orcid: "https://orcid.org/0000-0002-4882-1815"
+title: "USearch"
+version: 0.3.0
+doi: 10.5281/zenodo.7949416
+date-released: 2022-06-12
+url: "https://github.com/unum-cloud/usearch"

package/CMakeLists.txt

@@ -1,107 +1,120 @@
-cmake_minimum_required(VERSION 3.11 FATAL_ERROR)
-project(usearch LANGUAGES CXX)
-
-set(CMAKE_CXX_STANDARD 11)
-set(CMAKE_CXX_STANDARD_REQUIRED YES)
-set(CMAKE_CXX_EXTENSIONS NO)
-
-option(USEARCH_USE_JEMALLOC "Use JeMalloc for Faster Memory Allocations" OFF)
-option(USEARCH_USE_OPENMP "Use OpenMP for a thread pool" OFF)
-option(USEARCH_USE_SIMD "Use SIMD hardware acceleration" OFF)
-
-option(USEARCH_BUILD_BENCHMARK "Compile a native benchmark in C++" ON)
-option(USEARCH_BUILD_WOLFRAM "Compile Wolfram Language bindings" OFF)
-
-# Make "Release" by default
-if(NOT CMAKE_BUILD_TYPE)
-    set(CMAKE_BUILD_TYPE Release)
+# This CMake file is heavily inspired by following `usearch` CMake:
+# https://github.com/nlohmann/json/blob/develop/CMakeLists.txt
+cmake_minimum_required(VERSION 3.1)
+project(usearch VERSION 0.6.0 LANGUAGES CXX)
+
+# Determine if USearch is built as a subproject (using `add_subdirectory`) or if it is the main project
+set(USEARCH_IS_MAIN_PROJECT OFF)
+if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
+    set(USEARCH_IS_MAIN_PROJECT ON)
 endif()
 
-# List of all possible compiler IDs:
-# https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_COMPILER_ID.html
-if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
-    set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -fsanitize=address")
-    set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -Wall -Wextra -Wno-conversion -Wno-unknown-pragmas")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -march=native")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fmax-errors=1")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fopenmp")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pedantic")
-
-elseif(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
-    set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -Wfatal-errors")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fopenmp")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pedantic")
-
-elseif(CMAKE_CXX_COMPILER_ID STREQUAL "NVIDIA" OR CMAKE_CXX_COMPILER_ID STREQUAL "NVHPC")
-    set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} --expt-relaxed-constexpr --extended-lambda")
-    set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} -gencode arch=compute_86,code=sm_86")
-    set_property(SOURCE src/bench.cpp PROPERTY LANGUAGE CUDA)
-    set_target_properties(bench PROPERTIES POSITION_INDEPENDENT_CODE ON)
-    set_target_properties(bench PROPERTIES CUDA_ARCHITECTURES "86")
-
-elseif(CMAKE_CXX_COMPILER_ID STREQUAL "IntelLLVM")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -w")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -ferror-limit=1")
+# Options
+option(USEARCH_INSTALL "Install CMake targets" OFF)
+option(USEARCH_BUILD_TEST "Compile a native unit test in C++" ${USEARCH_IS_MAIN_PROJECT})
+option(USEARCH_BUILD_BENCHMARK "Compile a native benchmark in C++" ${USEARCH_IS_MAIN_PROJECT})
+option(USEARCH_BUILD_WOLFRAM "Compile Wolfram Language bindings" OFF)
 
-elseif(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
-    set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /DEBUG")
-    set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /O2")
-    set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} /O2 /DEBUG")
+# Includes
+set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH})
+include(ExternalProject)
+
+# Allow CMake 3.13+ to override options when using FetchContent / add_subdirectory
+if (POLICY CMP0077)
+    cmake_policy(SET CMP0077 NEW)
+endif ()
+
+# Configuration
+include(GNUInstallDirs)
+set(USEARCH_TARGET_NAME               ${PROJECT_NAME})
+set(USEARCH_CONFIG_INSTALL_DIR        "${CMAKE_INSTALL_DATADIR}/cmake/${PROJECT_NAME}" CACHE INTERNAL "")
+set(USEARCH_INCLUDE_INSTALL_DIR       "${CMAKE_INSTALL_INCLUDEDIR}")
+set(USEARCH_TARGETS_EXPORT_NAME       "${PROJECT_NAME}Targets")
+set(USEARCH_CMAKE_CONFIG_TEMPLATE     "cmake/config.cmake.in")
+set(USEARCH_CMAKE_CONFIG_DIR          "${CMAKE_CURRENT_BINARY_DIR}")
+set(USEARCH_CMAKE_VERSION_CONFIG_FILE "${USEARCH_CMAKE_CONFIG_DIR}/${PROJECT_NAME}ConfigVersion.cmake")
+set(USEARCH_CMAKE_PROJECT_CONFIG_FILE "${USEARCH_CMAKE_CONFIG_DIR}/${PROJECT_NAME}Config.cmake")
+set(USEARCH_CMAKE_PROJECT_TARGETS_FILE "${USEARCH_CMAKE_CONFIG_DIR}/${PROJECT_NAME}Targets.cmake")
+set(USEARCH_PKGCONFIG_INSTALL_DIR      "${CMAKE_INSTALL_DATADIR}/pkgconfig")
+
+
+# Define our header-only library
+add_library(${USEARCH_TARGET_NAME} INTERFACE)
+add_library(${PROJECT_NAME}::${USEARCH_TARGET_NAME} ALIAS ${USEARCH_TARGET_NAME})
+set(USEARCH_INCLUDE_BUILD_DIR "${PROJECT_SOURCE_DIR}/include/")
+if (${CMAKE_VERSION} VERSION_LESS "3.8.0")
+    target_compile_features(${USEARCH_TARGET_NAME} INTERFACE cxx_range_for)
 else()
-    set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -g -O0")
-    set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -O3")
-    set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} -O3 -pg -g")
+    target_compile_features(${USEARCH_TARGET_NAME} INTERFACE cxx_std_11)
 endif()
 
-if(APPLE)
-    set(CMAKE_THREAD_LIBS_INIT "-lpthread")
-    set(CMAKE_HAVE_THREADS_LIBRARY 1)
-    set(CMAKE_USE_WIN32_THREADS_INIT 0)
-    set(CMAKE_USE_PTHREADS_INIT 1)
-    set(THREADS_PREFER_PTHREAD_FLAG ON)
+target_compile_definitions(
+    ${USEARCH_TARGET_NAME}
+    INTERFACE
+    $<$<NOT:$<BOOL:${JSON_GlobalUDLs}>>:USEARCH_USE_OPENMP=0>
+)
+target_include_directories(
+    ${USEARCH_TARGET_NAME}
+    ${USEARCH_SYSTEM_INCLUDE} INTERFACE
+    $<BUILD_INTERFACE:${USEARCH_INCLUDE_BUILD_DIR}>
+    $<INSTALL_INTERFACE:include>
+)
+
+# Install a pkg-config file, so other tools can find this
+configure_file(
+    "${CMAKE_CURRENT_SOURCE_DIR}/cmake/pkg-config.pc.in"
+    "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc"
+)
+
+# Install a custom package version config file instead of
+# write_basic_package_version_file to ensure that it's architecture-independent
+# https://github.com/nlohmann/json/issues/1697
+include(CMakePackageConfigHelpers)
+configure_file(
+    "cmake/usearchConfigVersion.cmake.in"
+    ${USEARCH_CMAKE_VERSION_CONFIG_FILE}
+    @ONLY
+)
+configure_file(
+    ${USEARCH_CMAKE_CONFIG_TEMPLATE}
+    ${USEARCH_CMAKE_PROJECT_CONFIG_FILE}
+    @ONLY
+)
+
+if(USEARCH_INSTALL)
+    install(
+        DIRECTORY ${USEARCH_INCLUDE_BUILD_DIR}
+        DESTINATION ${USEARCH_INCLUDE_INSTALL_DIR}
+    )
+    install(
+        FILES ${USEARCH_CMAKE_PROJECT_CONFIG_FILE} ${USEARCH_CMAKE_VERSION_CONFIG_FILE}
+        DESTINATION ${USEARCH_CONFIG_INSTALL_DIR}
+    )
+    export(
+        TARGETS ${USEARCH_TARGET_NAME}
+        NAMESPACE ${PROJECT_NAME}::
+        FILE ${USEARCH_CMAKE_PROJECT_TARGETS_FILE}
+    )
+    install(
+        TARGETS ${USEARCH_TARGET_NAME}
+        EXPORT ${USEARCH_TARGETS_EXPORT_NAME}
+        INCLUDES DESTINATION ${USEARCH_INCLUDE_INSTALL_DIR}
+    )
+    install(
+        EXPORT ${USEARCH_TARGETS_EXPORT_NAME}
+        NAMESPACE ${PROJECT_NAME}::
+        DESTINATION ${USEARCH_CONFIG_INSTALL_DIR}
+    )
+    install(
+        FILES "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc"
+        DESTINATION ${USEARCH_PKGCONFIG_INSTALL_DIR}
+    )
 endif()
 
-find_package(Threads REQUIRED)
-
-if(${USEARCH_USE_OPENMP})
-    find_package(OpenMP REQUIRED)
-    include_directories(${OPENMP_INCLUDE_DIRS})
-endif()
-
-if(${USEARCH_USE_JEMALLOC})
-    include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/jemalloc.cmake")
-endif()
-
-include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/clipp.cmake")
-
-include_directories("${CMAKE_CURRENT_SOURCE_DIR}/include")
-include_directories("${CMAKE_CURRENT_SOURCE_DIR}/fp16/include")
-include_directories("${CMAKE_CURRENT_SOURCE_DIR}/simsimd/include")
-include_directories("${CMAKE_CURRENT_SOURCE_DIR}/src")
-
-# Define our header-only library.
-add_library(usearch INTERFACE)
-target_sources(usearch INTERFACE "${CMAKE_CURRENT_SOURCE_DIR}/include/usearch/usearch.hpp")
-target_include_directories(usearch INTERFACE "${CMAKE_CURRENT_SOURCE_DIR}/include")
-
-# Define the targets
-if(${USEARCH_BUILD_BENCHMARK})
-    add_executable(bench src/bench.cpp)
-    target_link_libraries(bench PRIVATE Threads::Threads)
-
-    if(${USEARCH_USE_SIMD})
-        target_compile_definitions(bench PRIVATE USEARCH_USE_SIMD=1)
-    endif()
-
-    if(${USEARCH_USE_OPENMP})
-        target_link_libraries(bench PRIVATE ${OPENMP_LIBRARIES})
-    endif()
-
-    if(${USEARCH_USE_JEMALLOC})
-        target_link_libraries(bench PRIVATE ${JEMALLOC_LIBRARIES})
-    endif()
+if(${USEARCH_BUILD_TEST} OR ${USEARCH_BUILD_BENCHMARK})
+    add_subdirectory(src)
 endif()
 
 if(${USEARCH_BUILD_WOLFRAM})
     add_subdirectory(wolfram)
-endif()
+endif()

package/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "usearch"
-version = "0.4.0"
+version = "0.8.0"
 authors = ["Ashot Vardanian <1983160+ashvardanian@users.noreply.github.com>"]
 description = "Smaller & Faster Single-File Vector Search Engine from Unum"
 edition = "2021"

package/Dockerfile

@@ -0,0 +1,14 @@
+# syntax=docker/dockerfile:1
+
+FROM ubuntu:23.04
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends python3.11 python3-pip && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
+RUN pip3 install --no-cache-dir --break-system-packages ucall usearch
+
+WORKDIR /usearch
+COPY python/usearch/server.py server.py
+
+CMD ["python3", "./server.py"]
+EXPOSE 8545

package/README.md

@@ -157,10 +157,11 @@ 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}, /* top */ 5 /* results */,
-  /* with callback: */ [](std::size_t label, float distance) { });
+index.add(/* label: */ 42, /* vector: */ {&vec[0], 3});
+auto results = index.search(/* query: */ {&vec[0], 3}, 5 /* neighbors */);
+
+for (std::size_t i = 0; i != results.size(); ++i)
+    results[i].member.label, results[i].member.vector, results[i].distance;
 ```
 
 The `add` is thread-safe for concurrent index construction.
@@ -235,7 +236,7 @@ from usearch.index import Index
 
 index = Index(
     ndim=3, # Define the number of dimensions in input vectors
-    metric='cos', # Choose 'l2', 'haversine' or other metric, default = 'ip'
+    metric='cos', # Choose 'l2sq', 'haversine' or other metric, default = 'ip'
     dtype='f32', # Quantize to 'f16' or 'f8' if needed, default = 'f32'
     connectivity=16, # How frequent should the connections in the graph be, optional
     expansion_add=128, # Control the recall of indexing, optional
@@ -405,7 +406,7 @@ assert!(index.view("index.usearch").is_ok());
 #### Metrics
 
 ```rust
-assert!(new_l2(3, &quant, 0, 0, 0).is_ok());
+assert!(new_l2sq(3, &quant, 0, 0, 0).is_ok());
 assert!(new_cos(3, &quant, 0, 0, 0).is_ok());
 assert!(new_haversine(&quant, 0, 0, 0).is_ok());
 ```
@@ -444,7 +445,7 @@ https://github.com/unum-cloud/usearch
 #### Quickstart
 
 ```swift
-let index = Index.l2(dimensions: 3, connectivity: 8)
+let index = Index.l2sq(dimensions: 3, connectivity: 8)
 let vectorA: [Float32] = [0.3, 0.5, 1.2]
 let vectorB: [Float32] = [0.4, 0.2, 1.2]
 index.add(label: 42, vector: vectorA[...])

package/VERSION

@@ -1 +1 @@
-0.4.0
+0.8.0

package/binding.gyp

@@ -15,8 +15,8 @@
             "dependencies": [
                 "<!(node -p \"require('node-addon-api').gyp\")"
             ],
-            "cflags": ["-fexceptions", "-Wunknown-pragmas", "-std=c99"],
-            "cflags_cc": ["-fexceptions", "-Wunknown-pragmas", "-std=c++11"],
+            "cflags": ["-fexceptions", "-Wno-unknown-pragmas"],
+            "cflags_cc": ["-fexceptions", "-Wno-unknown-pragmas", "-std=c++11"],
             "xcode_settings": {
                 "GCC_ENABLE_CPP_EXCEPTIONS": "YES",
                 "CLANG_CXX_LIBRARY": "libc++",

package/build.rs

@@ -2,7 +2,7 @@ fn main() {
     cxx_build::bridge("rust/lib.rs")
         .file("rust/lib.cpp")
         .flag_if_supported("-std=c++11")
-        .flag_if_supported("-Wunknown-pragmas")
+        .flag_if_supported("-Wno-unknown-pragmas")
         .include("include")
         .include("rust")
         .include("src")
@@ -13,6 +13,6 @@ fn main() {
     println!("cargo:rerun-if-changed=rust/lib.rs");
     println!("cargo:rerun-if-changed=rust/lib.cpp");
     println!("cargo:rerun-if-changed=rust/lib.hpp");
-    println!("cargo:rerun-if-changed=src/advanced.hpp");
+    println!("cargo:rerun-if-changed=src/punned.hpp");
     println!("cargo:rerun-if-changed=include/usearch/usearch.hpp");
 }

package/cmake/config.cmake.in

@@ -0,0 +1,15 @@
+include(FindPackageHandleStandardArgs)
+set(${CMAKE_FIND_PACKAGE_NAME}_CONFIG ${CMAKE_CURRENT_LIST_FILE})
+find_package_handle_standard_args(@PROJECT_NAME@ CONFIG_MODE)
+
+if(NOT TARGET @PROJECT_NAME@::@USEARCH_TARGET_NAME@)
+    include("${CMAKE_CURRENT_LIST_DIR}/@USEARCH_TARGETS_EXPORT_NAME@.cmake")
+    if((NOT TARGET @USEARCH_TARGET_NAME@) AND
+       (NOT @PROJECT_NAME@_FIND_VERSION OR
+        @PROJECT_NAME@_FIND_VERSION VERSION_LESS 3.2.0))
+        add_library(@USEARCH_TARGET_NAME@ INTERFACE IMPORTED)
+        set_target_properties(@USEARCH_TARGET_NAME@ PROPERTIES
+            INTERFACE_LINK_LIBRARIES @PROJECT_NAME@::@USEARCH_TARGET_NAME@
+        )
+    endif()
+endif()

package/cmake/pkg-config.pc.in

@@ -0,0 +1,4 @@
+Name: ${PROJECT_NAME}
+Description: Smaller & Faster Single-File Vector Search Engine from Unum
+Version: ${PROJECT_VERSION}
+Cflags: -I${CMAKE_INSTALL_FULL_INCLUDEDIR}

package/cmake/usearchConfigVersion.cmake.in

@@ -0,0 +1,20 @@
+# This is essentially cmake's BasicConfigVersion-SameMajorVersion.cmake.in but
+# without the 32/64-bit check.  Since USearch is a header-only library, it doesn't
+# matter if it was built on a different platform than what it is used on (see
+# https://github.com/nlohmann/json/issues/1697).
+set(PACKAGE_VERSION "@PROJECT_VERSION@")
+
+if(PACKAGE_VERSION VERSION_LESS PACKAGE_FIND_VERSION)
+  set(PACKAGE_VERSION_COMPATIBLE FALSE)
+else()
+
+  if(PACKAGE_FIND_VERSION_MAJOR STREQUAL "@PROJECT_VERSION_MAJOR@")
+    set(PACKAGE_VERSION_COMPATIBLE TRUE)
+  else()
+    set(PACKAGE_VERSION_COMPATIBLE FALSE)
+  endif()
+
+  if(PACKAGE_FIND_VERSION STREQUAL PACKAGE_VERSION)
+      set(PACKAGE_VERSION_EXACT TRUE)
+  endif()
+endif()

package/conanfile.py

@@ -4,7 +4,7 @@ from conans import ConanFile
 class USearchConan(ConanFile):
 
     name = 'USearch'
-    version = '0.4.0'
+    version = '0.8.0'
     license = 'Apache 2.0'
     url = 'https://github.com/unum-cloud/usearch'
     description = 'Smaller & Faster Single-File Vector Search Engine from Unum'

package/docs/benchmarks.md

@@ -77,7 +77,7 @@ SYNOPSIS
         ./build_release/bench [--vectors <path>] [--queries <path>] [--neighbors <path>] [-b] [-j
                               <integer>] [-c <integer>] [--expansion-add <integer>]
                               [--expansion-search <integer>] [--native|--f16quant|--i8quant]
-                              [--ip|--l2|--cos|--haversine] [-h]
+                              [--ip|--l2sq|--cos|--haversine] [-h]
 
 OPTIONS
         --vectors <path>
@@ -106,7 +106,7 @@ OPTIONS
         --f16quant  Enable `f16_t` quantization
         --i8quant   Enable `int8_t` quantization
         --ip        Choose Inner Product metric
-        --l2        Choose L2 Euclidean metric
+        --l2sq        Choose L2 Euclidean metric
         --cos       Choose Angular metric
         --haversine Choose Haversine metric
         -h, --help  Print this help information on this tool and exit
@@ -170,6 +170,15 @@ mkdir -p datasets/deep_1B/ && \
 
 ## Profiling
 
+Enabling Huge Pages:
+
+```sh
+sudo cat /proc/sys/vm/nr_hugepages
+sudo sysctl -w vm.nr_hugepages=2048
+sudo reboot
+sudo cat /proc/sys/vm/nr_hugepages
+```
+
 With `perf`:
 
 ```sh