usearch 2.7.6 → 2.8.0

package/.dockerignore

@@ -0,0 +1,93 @@
+# Ignore all files without an extension
+*
+!/**/
+!*.*
+
+# Temporary files
+.DS_Store
+*.fbin
+*.ibin
+datasets
+bin
+*.usearch
+.cache
+
+# C++ builds
+build
+build_release
+build_debug
+_deps
+CMakeCache.txt
+CMakeFiles
+cmake_install.cmake
+
+# Profiling with GProf and `perf` on Linux
+gmon.out
+perf.data
+
+# Python wrappers
+__pycache__
+*.egg-info
+dist/
+wheelhouse/
+
+# Python Environments
+venv/
+
+# JS wrappers
+package-lock.json
+node_modules/
+
+# Rust builds
+Cargo.lock
+target/
+
+# Java bindings
+.gradle
+*.class
+
+# ObjC and Swift
+.build
+.swiftpm
+
+# C# builds
+csharp/**/[Bb]in/
+csharp/**/[Oo]bj/
+csharp/lib
+csharp/packages
+
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Allow golang go.mod
+!go.mod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app

package/.github/workflows/Dockerfile.libs

@@ -11,9 +11,13 @@ RUN apt-get update && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/*
 
+ENV CC=gcc-12
+ENV CXX=g++-12
+
 COPY . .
 
-RUN cd c && make libusearch_c.so
+RUN cmake -DCMAKE_BUILD_TYPE=Release -DUSEARCH_BUILD_LIB_C=1 -DUSEARCH_BUILD_TEST_CPP=0 -DUSEARCH_BUILD_BENCH_CPP=0 -B ./build_release
+RUN cmake --build ./build_release --config Release
 
 RUN if [ "$TARGETPLATFORM" = "linux/amd64" ]; then \
         export arch="amd"; \
@@ -26,7 +30,7 @@ RUN if [ "$TARGETPLATFORM" = "linux/amd64" ]; then \
     mkdir -p usearch_linux_"$arch"_"$version"/usr/local/lib && \
     mkdir usearch_linux_"$arch"_"$version"/usr/local/include && \
     cp c/usearch.h usearch_linux_"$arch"_"$version"/usr/local/include/ && \
-    cp c/libusearch_so.a usearch_linux_"$arch"_"$version"/usr/local/lib/ && \
+    cp build_release/libusearch_c.so usearch_linux_"$arch"_"$version"/usr/local/lib/ && \
     echo "Package: usearch\nVersion: $version\nMaintainer: Ash Vardanian\nArchitecture: "$arch"\nDescription: Faster & Smaller Single-File Search Engine for Vectors & Texts" > usearch_linux_"$arch"_"$version"/DEBIAN/control && \
     dpkg-deb --build usearch_linux_"$arch"_"$version" && \
     sshpass -p "$user_pass" scp -o StrictHostKeyChecking=no usearch_linux_"$arch"_"$version".deb "$user_name"@"$docker_ip":/home/$user_name/work/usearch/usearch/

package/.github/workflows/prerelease.yml

@@ -7,302 +7,299 @@ on:
     branches: ["main-dev"]
 
 env:
-  BUILD_TYPE: Release
   GH_TOKEN: ${{ secrets.SEMANTIC_RELEASE_TOKEN }}
   PYTHONUTF8: 1
+  PYTHON_VERSION: 3.11
+  DOTNET_VERSION: 7.0.x
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: read
 
 jobs:
-  
-  test_cpp_c_ubuntu_gcc:
-    name: Test C++ Ubuntu (GCC)
-    runs-on: ubuntu-latest
-    
+  test_ubuntu_gcc:
+    name: Ubuntu (GCC 12)
+    runs-on: ubuntu-22.04
+    env:
+      CC: gcc-12
+      CXX: g++-12
+
     steps:
-    - uses: actions/checkout@v3
-      with:
-        ref: main-dev
-    - run: git submodule update --init --recursive
-    
-    - name: Install Dependencies
-      run: sudo apt update && sudo apt install -y cmake build-essential libjemalloc-dev libomp-dev g++-12
-        
-    - name: Build
-      run: |
-        export CC=gcc-12
-        export CXX=g++-12
-        cmake -B build -DCMAKE_BUILD_TYPE=Debug -DUSEARCH_BUILD_TEST_CPP=1 -DUSEARCH_BUILD_TEST_C=1 -DUSEARCH_USE_OPENMP=1 -DUSEARCH_USE_SIMSIMD=1 -DUSEARCH_USE_JEMALLOC=1
-        cmake --build build --config Debug
-        
-    - name: Run C++ tests
-      run: ./build/test_cpp
-    - name: Run C tests
-      run: ./build/test_c
+      - uses: actions/checkout@v3
+        with:
+          ref: main-dev
+      - run: git submodule update --init --recursive
 
+        # C/C++
+      - name: Build C/C++
+        run: |
+          sudo apt update
+          sudo apt install -y cmake build-essential libjemalloc-dev libomp-dev gcc-12 g++-12
+          cmake -B build_artifacts -DCMAKE_BUILD_TYPE=RelWithDebInfo -DUSEARCH_BUILD_TEST_CPP=1 -DUSEARCH_BUILD_TEST_C=1 -DUSEARCH_BUILD_LIB_C=1 -DUSEARCH_USE_OPENMP=1 -DUSEARCH_USE_SIMSIMD=1 -DUSEARCH_USE_JEMALLOC=1
+          cmake --build build_artifacts --config RelWithDebInfo
+      - name: Test C++
+        run: ./build_artifacts/test_cpp
+      - name: Test C
+        run: ./build_artifacts/test_c
 
-  test_cpp_c_ubuntu_clang:
-    name: Test C++ Ubuntu (Clang)
-    runs-on: ubuntu-latest
-    
-    steps:
-    - uses: actions/checkout@v3
-      with:
-        ref: main-dev
-    - run: git submodule update --init --recursive
-    
-    - name: Install Dependencies
-      run: sudo apt update && sudo apt install -y cmake build-essential libjemalloc-dev clang-15
-        
-    - name: Build
-      run: |
-        export CC=clang-15
-        export CXX=clang++-15
-        cmake -B build -DCMAKE_BUILD_TYPE=Debug -DUSEARCH_BUILD_TEST_CPP=1 -DUSEARCH_BUILD_TEST_C=1 -DUSEARCH_USE_SIMSIMD=1 -DUSEARCH_USE_JEMALLOC=1
-        cmake --build build --config Debug
-        
-    - name: Run C++ tests
-      run: ./build/test_cpp
-    - name: Run C tests
-      run: ./build/test_c
+        # Python
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Build Python
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest numpy
+          python -m pip install .
+      - name: Test Python
+        run: pytest python/scripts/ -s -x
 
+        # JavaScript
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Build JavaScript
+        run: npm install
+      - name: Test JavaScript
+        run: npm ci && npm test
 
-  test_cpp_c_macos:
-    name: Test C++ MacOS
-    runs-on: macos-latest
-    steps:
-    - uses: actions/checkout@v3
-      with:
-        ref: main-dev
-    - run: git submodule update --init --recursive
-    
-    - name: Install Dependencies
-      run: |
-        brew update
-        brew install cmake
-    
-    - name: Build
-      run: |
-        cmake -B build -DCMAKE_BUILD_TYPE=Debug -DUSEARCH_BUILD_TEST_CPP=1 -DUSEARCH_BUILD_TEST_C=1
-        cmake --build build --config Debug
-    - name: Run C++ tests
-      run: ./build/test_cpp
-    - name: Run C tests
-      run: ./build/test_c
+        # Rust
+      - name: Test Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
 
-  test_cpp_c_windows:
-    name: Test C++ Windows
-    runs-on: windows-latest
-    steps:
-    - uses: actions/checkout@v3
-      with:
-        ref: main-dev
-    - run: git submodule update --init --recursive
-    
-    - name: Install Dependencies
-      run: choco install cmake
-        
-    - name: Build
-      run: |
-        cmake -B build -DCMAKE_BUILD_TYPE=Debug -DUSEARCH_BUILD_TEST_CPP=1 -DUSEARCH_BUILD_TEST_C=1
-        cmake --build build --config Debug
-    - name: Run C++ tests
-      run: .\build\test_cpp
-    - name: Run C tests
-      run: .\build\test_c
-      
-  test_python_311:
-    name: Test Python
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-22.04, macOS-11, windows-2022]
-        python-version: ["3.11"]
+        # Java
+      - name: Setup Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: "11"
+          distribution: "adopt"
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2.4.2
+      - name: Test Java
+        run: gradle clean build
+
+        # C#
+      - name: Setup .NET ${{ env.DOTNET_VERSION }}
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: ${{ env.DOTNET_VERSION }}
+      - name: Test .NET
+        run: |
+          mkdir -p "${{ github.workspace }}/csharp/lib/runtimes/linux-x64/native"
+          cp "${{ github.workspace }}/build_artifacts/libusearch_c.so" "${{ github.workspace }}/csharp/lib/runtimes/linux-x64/native"
+          dotnet test -c Release
+        shell: bash
+        working-directory: ${{ github.workspace }}/csharp
+
+        # GoLang
+        # With `LD_DEBUG=all` we detect the addresses of the libraries that are loaded
+      - name: Test GoLang
+        run: |
+          sudo cp ${{ github.workspace }}/build_artifacts/libusearch_c.so /usr/lib/libusearch_c.so
+          sudo cp ${{ github.workspace }}/c/usearch.h /usr/include/usearch.h
+          LD_DEBUG=all go test -v
+        working-directory: ${{ github.workspace }}/golang/
+
+  test_ubuntu_clang:
+    name: Ubuntu (Clang 16)
+    runs-on: ubuntu-22.04
+    env:
+      CC: clang-16
+      CXX: clang++-16
 
     steps:
       - uses: actions/checkout@v3
+        with:
+          ref: main-dev
       - run: git submodule update --init --recursive
-      - name: Set up Python ${{ matrix.python-version }}
+
+        # C/C++
+        # Clang 16 isn't available from default repos on Ubuntu 22.04, so we have to install it manually
+      - name: Build C/C++
+        run: |
+          sudo apt update
+          sudo apt install -y cmake build-essential libjemalloc-dev
+          wget https://apt.llvm.org/llvm.sh
+          chmod +x llvm.sh
+          sudo ./llvm.sh 16
+          cmake -B build_artifacts -DCMAKE_BUILD_TYPE=RelWithDebInfo -DUSEARCH_BUILD_TEST_CPP=1 -DUSEARCH_BUILD_TEST_C=1 -DUSEARCH_BUILD_LIB_C=1 -DDUSEARCH_USE_OPENMP=0 -DUSEARCH_USE_SIMSIMD=1 -DUSEARCH_USE_JEMALLOC=1
+          cmake --build build_artifacts --config RelWithDebInfo
+      - name: Test C++
+        run: ./build_artifacts/test_cpp
+      - name: Test C
+        run: ./build_artifacts/test_c
+
+        # Python
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
         uses: actions/setup-python@v4
         with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Build Python
         run: |
           python -m pip install --upgrade pip
           pip install pytest numpy
-      - name: Build locally
-        run: python -m pip install .
-      - name: Test with PyTest
+          python -m pip install .
+      - name: Test Python
         run: pytest python/scripts/ -s -x
 
+        # JavaScript
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Build and test JavaScript
+        run: |
+          npm install
+          npm ci
+          npm test
+
+        # C#
+      - name: Setup .NET ${{ env.DOTNET_VERSION }}
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: ${{ env.DOTNET_VERSION }}
+      - name: Test .NET
+        run: |
+          mkdir -p "${{ github.workspace }}/csharp/lib/runtimes/linux-x64/native"
+          cp "${{ github.workspace }}/build_artifacts/libusearch_c.so" "${{ github.workspace }}/csharp/lib/runtimes/linux-x64/native"
+          dotnet test -c Release
+        shell: bash
+        working-directory: ${{ github.workspace }}/csharp
 
-  test_python_37:
-    name: Test Python 3.7
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-22.04]
-        python-version: ["3.7"]
+  test_macos:
+    name: MacOS
+    runs-on: macos-12
 
     steps:
       - uses: actions/checkout@v3
+        with:
+          ref: main-dev
       - run: git submodule update --init --recursive
-      
-      - name: Set up Python ${{ matrix.python-version }}
+
+        # C/C++
+      - name: Build C/C++
+        run: |
+          brew update
+          brew install cmake
+          cmake -B build_artifacts -DCMAKE_BUILD_TYPE=RelWithDebInfo -DUSEARCH_BUILD_TEST_CPP=1 -DUSEARCH_BUILD_TEST_C=1 -DUSEARCH_BUILD_LIB_C=1
+          cmake --build build_artifacts --config RelWithDebInfo
+      - name: Test C++
+        run: ./build_artifacts/test_cpp
+      - name: Test C
+        run: ./build_artifacts/test_c
+
+        # Python
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
         uses: actions/setup-python@v4
         with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install dependencies
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Build Python
         run: |
           python -m pip install --upgrade pip
           pip install pytest numpy
-
-      - name: Build locally
-        run: python -m pip install .
-      - name: Test with PyTest
+          python -m pip install .
+      - name: Test Python
         run: pytest python/scripts/ -s -x
 
-
-  test_javascript:
-    name: Test JavaScript
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - run: git submodule update --init --recursive
-      - uses: actions/setup-node@v3
+        # JavaScript
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
         with:
           node-version: 18
-      - run: npm install
-      - run: npm ci
-      - run: npm test
+      - name: Build JavaScript
+        run: npm install
+      - name: Test JavaScript
+        run: npm ci && npm test
 
-  test_rust:
-    name: Test Rust
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - run: git submodule update --init --recursive
-    - uses: actions-rs/toolchain@v1
-      with:
-          toolchain: stable
-          override: true
+        # ObjC/Swift
+      - name: Build ObjC/Swift
+        run: swift build
+      - name: Test ObjC/Swift
+        run: swift test
 
-  test_java:
-    name: Test Java
-    runs-on: ubuntu-latest
-    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.4.2
-    - name: Execute Gradle build
-      run: gradle clean build
-
-  test_swift:
-    name: Test ObjC & Swift
-    runs-on: macos-latest
-    steps:
-    - uses: actions/checkout@v3
-    - run: git submodule update --init --recursive
-    - name: Build
-      run: swift build
-    - name: Run tests
-      run: swift test
+        # C#
+      - name: Setup .NET ${{ env.DOTNET_VERSION }}
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: ${{ env.DOTNET_VERSION }}
+      - name: Test .NET
+        run: |
+          mkdir -p "${{ github.workspace }}/csharp/lib/runtimes/osx-x64/native"
+          cp "${{ github.workspace }}/build_artifacts/libusearch_c.dylib" "${{ github.workspace }}/csharp/lib/runtimes/osx-x64/native"
+          dotnet test -c Release
+        shell: bash
+        working-directory: ${{ github.workspace }}/csharp
 
-  test_csharp:
-    name: Test C#
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        dotnet-version: ['7.0.x']
+  test_windows:
+    name: Windows
+    runs-on: windows-2022
     steps:
       - uses: actions/checkout@v3
-      - run: git submodule update --init --recursive
-      - name: Setup .NET ${{ matrix.dotnet-version }}
-        uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: ${{ matrix.dotnet-version }}
-
-      - name: Ubuntu/macOS build native lib
-        if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
-        run: ./build_lib.sh
-        shell: bash
-        working-directory: ${{ github.workspace }}/csharp/eng/
+          ref: main-dev
+      - run: git submodule update --init --recursive
 
-      # Use cl.exe https://www.appveyor.com/docs/lang/cpp/#visual-studio-2017
-      # There is no support for c++11
-      - name: Windows MSVC build
-        if: matrix.os == 'windows-latest'
+        # C/C++
+      - name: Build C/C++
         run: |
-          call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Auxiliary\Build\vcvars64.bat"
-          where cl
-          cl /EHsc /std:c++14 /O2 /LD /Fe:libusearch_c.dll lib.cpp /I. /I../include/ /I../fp16/include/
-        working-directory: ${{ github.workspace }}/c
-        shell: cmd
+          choco install cmake
+          cmake -B build_artifacts -DCMAKE_BUILD_TYPE=RelWithDebInfo -DUSEARCH_BUILD_TEST_CPP=1 -DUSEARCH_BUILD_TEST_C=1 -DUSEARCH_BUILD_LIB_C=1
+          cmake --build build_artifacts --config RelWithDebInfo
+      - name: Test C++
+        run: .\build_artifacts\test_cpp.exe
+      - name: Test C
+        run: .\build_artifacts\test_c.exe
 
-      - name: Windows move dll to lib dir
-        if: matrix.os == 'windows-latest'
+        # Python
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Build Python
         run: |
-          mkdir -p "${GITHUB_WORKSPACE}/csharp/lib/runtimes/win-x64/native"
-          mv "${GITHUB_WORKSPACE}/c/libusearch_c.dll" "${GITHUB_WORKSPACE}/csharp/lib/runtimes/win-x64/native"
-        shell: bash
-
-      - name: Build and test
-        run: dotnet test -c Release
-        shell: bash
-        working-directory: ${{ github.workspace }}/csharp/
-
-  test_golang:
-    name: Test Golang
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-      with:
-        persist-credentials: false
-        ref: 'main-dev'
-    - run: git submodule update --init --recursive
+          python -m pip install --upgrade pip
+          pip install pytest numpy
+          python -m pip install .
+      - name: Test Python
+        run: pytest python/scripts/ -s -x
 
-    - name: Prepare environment
-      run: |
-        sudo apt update && 
-        sudo apt install -y build-essential
-      
-      # This is the weirdest step. GoLang runtime is having a hard time working with our static library...
-      # And doesn't want to link to the dynamic library... So instead, we rename the `.so` file `.a`, and
-      # it works just fine.
-    - name: Build library
-      run: |
-        cd golang/
-        make USEARCH_USE_OPENMP=0 USEARCH_USE_NATIVE_F16=0 USEARCH_USE_SIMSIMD=1 -C ../c libusearch_c.so
-        sudo cp ../c/libusearch_c.so /usr/local/lib/libusearch_c.a
-        sudo cp ../c/usearch.h /usr/local/include/usearch.h
+        # JavaScript
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Build JavaScript
+        run: npm install
+      - name: Test JavaScript
+        run: npm ci && npm test
 
-    - name: Run test
-      run: |
-        cd golang
-        go test -v
-        
+        # C#
+      - name: Setup .NET ${{ env.DOTNET_VERSION }}
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: ${{ env.DOTNET_VERSION }}
+      - name: Test .NET
+        run: |
+          mkdir -p "${{ github.workspace }}\csharp\lib\runtimes\win-x64\native"
+          cp "${{ github.workspace }}\build_artifacts\libusearch_c.dll" "${{ github.workspace }}\csharp\lib\runtimes\win-x64\native"
+          dotnet test -c Release
+        shell: bash
+        working-directory: ${{ github.workspace }}/csharp
 
   build_docker:
-    name: Test Docker Image
-    runs-on: ubuntu-latest
+    name: Docker
+    runs-on: ubuntu-22.04
     steps:
-    - uses: actions/checkout@v3
-    - run: git submodule update --init --recursive
-    - name: Build
-      uses: docker/build-push-action@v4
-      with:
-        context: .
-        load: true
-        push: false
+      - uses: actions/checkout@v3
+      - run: git submodule update --init --recursive
+      - name: Build
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          load: true
+          push: false