usearch 2.8.7 → 2.8.8

package/swift/Index+Sugar.swift

@@ -1,153 +0,0 @@
-//
-//  Index+Sugar.swift
-//
-//
-//  Created by Ash Vardanian on 5/11/23.
-//
-
-@available(iOS 13, macOS 10.15, tvOS 13.0, watchOS 6.0, *)
-extension USearchIndex {
-    public typealias Key = USearchKey
-    public typealias Metric = USearchMetric
-    public typealias Scalar = USearchScalar
-
-    /// Adds a labeled vector to the index.
-    /// - Parameter key: Unique identifer for that object.
-    /// - Parameter vector: Single-precision vector.
-    /// - Throws: If runs out of memory.
-    public func add(key: USearchKey, vector: ArraySlice<Float32>) {
-        vector.withContiguousStorageIfAvailable {
-            addSingle(key: key, vector: $0.baseAddress!)
-        }
-    }
-
-    /// Adds a labeled vector to the index.
-    /// - Parameter key: Unique identifer for that object.
-    /// - Parameter vector: Single-precision vector.
-    /// - Throws: If runs out of memory.
-    public func add(key: USearchKey, vector: Array<Float32>) {
-        add(key: key, vector: vector[...])
-    }
-
-    /// Approximate nearest neighbors search.
-    /// - Parameter vector: Single-precision query vector.
-    /// - Parameter count: Upper limit on the number of matches to retrieve.
-    /// - Returns: Labels and distances to closest approximate matches in decreasing similarity order.
-    /// - Throws: If runs out of memory.
-    public func search(vector: ArraySlice<Float32>, count: Int) -> ([Key], [Float]) {
-        var matches: [Key] = Array(repeating: 0, count: count)
-        var distances: [Float] = Array(repeating: 0, count: count)
-        let results = vector.withContiguousStorageIfAvailable {
-            searchSingle(vector: $0.baseAddress!, count: CUnsignedInt(count), keys: &matches, distances: &distances)
-        }
-        matches.removeLast(count - Int(results!))
-        distances.removeLast(count - Int(results!))
-        return (matches, distances)
-    }
-
-    /// Approximate nearest neighbors search.
-    /// - Parameter vector: Single-precision query vector.
-    /// - Parameter count: Upper limit on the number of matches to retrieve.
-    /// - Returns: Labels and distances to closest approximate matches in decreasing similarity order.
-    /// - Throws: If runs out of memory.
-    public func search(vector: Array<Float32>, count: Int) -> ([Key], [Float]) {
-        return search(vector: vector[...], count: count)
-    }
-
-    /// Adds a labeled vector to the index.
-    /// - Parameter key: Unique identifer for that object.
-    /// - Parameter vector: Double-precision vector.
-    /// - Throws: If runs out of memory.
-    public func add(key: Key, vector: ArraySlice<Float64>) {
-        vector.withContiguousStorageIfAvailable {
-            addDouble(key: key, vector: $0.baseAddress!)
-        }
-    }
-
-    /// Adds a labeled vector to the index.
-    /// - Parameter key: Unique identifer for that object.
-    /// - Parameter vector: Double-precision vector.
-    /// - Throws: If runs out of memory.
-    public func add(key: Key, vector: Array<Float64>) {
-        add(key: key, vector: vector[...])
-    }
-
-    /// Approximate nearest neighbors search.
-    /// - Parameter vector: Double-precision query vector.
-    /// - Parameter count: Upper limit on the number of matches to retrieve.
-    /// - Returns: Labels and distances to closest approximate matches in decreasing similarity order.
-    /// - Throws: If runs out of memory.
-    public func search(vector: ArraySlice<Float64>, count: Int) -> ([Key], [Float]) {
-        var matches: [Key] = Array(repeating: 0, count: count)
-        var distances: [Float] = Array(repeating: 0, count: count)
-        let results = vector.withContiguousStorageIfAvailable {
-            searchDouble(vector: $0.baseAddress!, count: CUnsignedInt(count), keys: &matches, distances: &distances)
-        }
-        matches.removeLast(count - Int(results!))
-        distances.removeLast(count - Int(results!))
-        return (matches, distances)
-    }
-
-    /// Approximate nearest neighbors search.
-    /// - Parameter vector: Double-precision query vector.
-    /// - Parameter count: Upper limit on the number of matches to retrieve.
-    /// - Returns: Labels and distances to closest approximate matches in decreasing similarity order.
-    /// - Throws: If runs out of memory.
-    public func search(vector: Array<Float64>, count: Int) -> ([Key], [Float]) {
-        search(vector: vector[...], count: count)
-    }
-
-    #if arch(arm64)
-
-        /// Adds a labeled vector to the index.
-        /// - Parameter key: Unique identifer for that object.
-        /// - Parameter vector: Half-precision vector.
-        /// - Throws: If runs out of memory.
-        @available(macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
-        public func add(key: Key, vector: ArraySlice<Float16>) {
-            vector.withContiguousStorageIfAvailable { buffer in
-                addHalf(key: key, vector: buffer.baseAddress!)
-            }
-        }
-
-        /// Adds a labeled vector to the index.
-        /// - Parameter key: Unique identifer for that object.
-        /// - Parameter vector: Half-precision vector.
-        /// - Throws: If runs out of memory.
-        @available(macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
-        public func add(key: Key, vector: Array<Float16>) {
-            add(key: key, vector: vector[...])
-        }
-
-        /// Approximate nearest neighbors search.
-        /// - Parameter vector: Half-precision query vector.
-        /// - Parameter count: Upper limit on the number of matches to retrieve.
-        /// - Returns: Labels and distances to closest approximate matches in decreasing similarity order.
-        /// - Throws: If runs out of memory.
-        @available(macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
-        public func search(vector: ArraySlice<Float16>, count: Int) -> ([Key], [Float]) {
-            var matches: [Key] = Array(repeating: 0, count: count)
-            var distances: [Float] = Array(repeating: 0, count: count)
-            let results = vector.withContiguousStorageIfAvailable {
-                searchHalf(vector: $0.baseAddress!, count: CUnsignedInt(count), keys: &matches, distances: &distances)
-            }
-            matches.removeLast(count - Int(results!))
-            distances.removeLast(count - Int(results!))
-            return (matches, distances)
-        }
-
-        /// Approximate nearest neighbors search.
-        /// - Parameter vector: Half-precision query vector.
-        /// - Parameter count: Upper limit on the number of matches to retrieve.
-        /// - Returns: Labels and distances to closest approximate matches in decreasing similarity order.
-        /// - Throws: If runs out of memory.
-        @available(macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
-        public func search(vector: Array<Float16>, count: Int) -> ([Key], [Float]) {
-            search(vector: vector[...], count: count)
-        }
-
-    #endif
-
-    /// Number of vectors in the index.
-    public var count: Int { return Int(length) }
-}

package/swift/README.md

@@ -1,48 +0,0 @@
-# USearch for Swift
-
-## Installation
-
-```txt
-https://github.com/unum-cloud/usearch
-```
-
-## Quickstart
-
-```swift
-let index = USearchIndex.make(metric: .Cos, dimensions: 3, connectivity: 8)
-let vectorA: [Float32] = [0.3, 0.5, 1.2] // `Float32` and `Float64` are always supported
-let vectorB: [Float32] = [0.4, 0.2, 1.2] // `Float16` supports on the OS & hardware version
-index.add(key: 42, vector: vectorA) // Pass full arrays or slices
-index.add(key: 43, vector: vectorB)
-
-let results = index.search(vector: vectorA, count: 10)
-assert(results.0[0] == 42)
-```
-
-If using in a SwiftUI application, make sure to annulate the void responses:
-
-```swift
-import SwiftUI
-import USearch
-
-@main
-struct USearchMobileApp: App {
-    var body: some Scene {
-        WindowGroup {
-            let index = USearchIndex.make(metric: .IP, dimensions: 2, connectivity: 16, quantization: .F32)
-            let _ = index.reserve(10)
-            let coordiantes: Array<Float32> = [40.177200, 44.503490]
-            let _ = index.add(key: 10, vector: coordiantes)            
-            VStack {
-                Text("USearch index contains \(index.length) vectors")
-                Spacer()
-            }
-
-        }
-    }
-}
-```
-
-You can find a working example of using USearch with SwiftUI maps at [ashvardanian/SwiftVectorSearch](https://github.com/ashvardanian/SwiftVectorSearch).
-
-[![](https://media.githubusercontent.com/media/ashvardanian/SwiftVectorSearch/main/USearch%2BSwiftUI.gif)](https://github.com/ashvardanian/SwiftVectorSearch)

package/swift/Test.swift

@@ -1,37 +0,0 @@
-//
-//  File.swift
-//
-//
-//  Created by Ash Vardanian on 5/11/23.
-//
-
-import Foundation
-import USearch
-import XCTest
-
-@available(iOS 13, macOS 10.15, tvOS 13.0, watchOS 6.0, *)
-class Test: XCTestCase {
-    func testUnit() throws {
-        let index = USearchIndex.make(metric: USearchMetric.l2sq, dimensions: 4, connectivity: 8, quantization: USearchScalar.F32)
-        let vectorA: [Float32] = [0.3, 0.5, 1.2, 1.4]
-        let vectorB: [Float32] = [0.4, 0.2, 1.2, 1.1]
-        index.reserve(2)
-        
-        // Adding a slice
-        index.add(key: 42, vector: vectorA[...])
-        
-        // Adding a vector
-        index.add(key: 43, vector: vectorB)
-        
-        let results = index.search(vector: vectorA, count: 10)
-        assert(results.0[0] == 42)
-        
-        assert(index.contains(key: 42))
-        assert(index.count(key: 42) == 1)
-        assert(index.count(key: 49) == 0)
-        index.rename(from: 42, to: 49)
-        assert(index.count(key: 49) == 1)
-        index.remove(key: 49)
-        assert(index.count(key: 49) == 0)
-    }
-}

package/swift/USearch.swift

@@ -1,8 +0,0 @@
-//
-//  File.swift
-//
-//
-//  Created by Ash Vardanian on 5/11/23.
-//
-
-@_exported import USearchObjective

package/wasm/CMakeLists.txt

@@ -1,7 +0,0 @@
-include(emscripten)
-
-# Setting the compiler globally is never a good idea! set(CMAKE_C_COMPILER emcc) set(CMAKE_CXX_COMPILER em++)
-
-add_executable(usearch_wasm lib.cpp)
-setup_target(usearch_wasm)
-set_target_properties(usearch_wasm PROPERTIES CXX_STANDARD 11)

package/wasm/README.md

@@ -1,13 +0,0 @@
-# USearch for WebAssembly
-
-## Installation
-
-```txt
-https://github.com/unum-cloud/usearch
-```
-
-## Quickstart
-
-```wolfram
-
-```

package/wasm/lib.cpp

@@ -1,5 +0,0 @@
-#define USEARCH_EXPORT EMSCRIPTEN_KEEPALIVE
-
-#include <emscripten/emscripten.h>
-
-#include <../c/lib.cpp>

package/wolfram/CMakeLists.txt

@@ -1,18 +0,0 @@
-
-if(NOT WOLFRAM_PATH)
-    set(WOLFRAM_PATH "/usr/local/Wolfram/Mathematica")
-endif()
-
-set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${WOLFRAM_PATH}/SystemFiles/Links/WSTP/DeveloperKit/Linux-x86-64/CompilerAdditions/")
-include(WSTP)
-include_directories("${WOLFRAM_PATH}/SystemFiles/IncludeFiles/C/")
-link_directories("${WOLFRAM_PATH}/SystemFiles/Libraries/Linux-x86-64/")
-
-add_library(usearchWFM SHARED lib.cpp)
-
-# Link against the Wolfram LibraryLink library
-target_link_libraries(usearchWFM WSTP::STATIC_LIBRARY)
-
-# Set the output name of the library to be compatible with Wolfram Language
-set_target_properties(usearchWFM PROPERTIES PREFIX "" OUTPUT_NAME "usearchWFM")
-set_target_properties(usearchWFM PROPERTIES CXX_STANDARD 11)

package/wolfram/README.md

@@ -1,13 +0,0 @@
-# USearch for Wolfram
-
-## Installation
-
-```txt
-https://github.com/unum-cloud/usearch
-```
-
-## Quickstart
-
-```wolfram
-
-```

package/wolfram/lib.cpp

@@ -1,160 +0,0 @@
-#include "WolframLibrary.h"
-#include <usearch/index_dense.hpp>
-
-using namespace unum::usearch;
-
-using distance_t = distance_punned_t;
-using index_t = index_dense_t;
-using vector_view_t = span_gt<float>;
-
-using add_result_t = typename index_t::add_result_t;
-using search_result_t = typename index_t::search_result_t;
-using vector_key_t = typename index_t::vector_key_t;
-
-EXTERN_C DLLEXPORT int WolframLibrary_initialize(WolframLibraryData libData) { return LIBRARY_NO_ERROR; }
-EXTERN_C DLLEXPORT void WolframLibrary_uninitialize(WolframLibraryData libData) { return; }
-
-EXTERN_C DLLEXPORT int IndexCreate(WolframLibraryData libData, mint Argc, MArgument* Args, MArgument Res) {
-    index_config_t config;
-    char* quantization_cstr = nullptr;
-    char* metric_cstr = nullptr;
-    try {
-        quantization_cstr = MArgument_getUTF8String(Args[1]);
-        metric_cstr = MArgument_getUTF8String(Args[0]);
-        std::size_t dimensions = static_cast<std::size_t>(MArgument_getInteger(Args[2]));
-        std::size_t capacity = static_cast<std::size_t>(MArgument_getInteger(Args[3]));
-        config.connectivity = static_cast<std::size_t>(MArgument_getInteger(Args[4]));
-        config.expansion_add = static_cast<std::size_t>(MArgument_getInteger(Args[5]));
-        config.expansion_search = static_cast<std::size_t>(MArgument_getInteger(Args[6]));
-
-        scalar_kind_t quantization = scalar_kind_from_name(quantization_cstr, std::strlen(quantization_cstr));
-        metric_kind_t metric_kind = metric_from_name(metric_cstr, std::strlen(metric_cstr));
-        index_t index = make_punned<index_t>(metric_kind, dimensions, quantization, config);
-        index.reserve(capacity);
-
-        index_t* result_ptr = new index_t(std::move(index));
-        MArgument_setInteger(Res, (long)result_ptr);
-
-    } catch (...) {
-        return LIBRARY_FUNCTION_ERROR;
-    }
-
-    libData->UTF8String_disown(quantization_cstr);
-    libData->UTF8String_disown(metric_cstr);
-    return LIBRARY_NO_ERROR;
-}
-
-EXTERN_C DLLEXPORT int IndexSave(WolframLibraryData libData, mint Argc, MArgument* Args, MArgument Res) {
-    char* path_cstr = nullptr;
-    index_t* c_ptr = (index_t*)MArgument_getUTF8String(Args[0]);
-    try {
-        path_cstr = MArgument_getUTF8String(Args[1]);
-        c_ptr->save(path_cstr);
-    } catch (...) {
-        return LIBRARY_FUNCTION_ERROR;
-    }
-    libData->UTF8String_disown(path_cstr);
-    return LIBRARY_NO_ERROR;
-}
-
-EXTERN_C DLLEXPORT int IndexLoad(WolframLibraryData libData, mint Argc, MArgument* Args, MArgument Res) {
-    char* path_cstr = nullptr;
-    index_t* c_ptr = (index_t*)MArgument_getUTF8String(Args[0]);
-    try {
-        path_cstr = MArgument_getUTF8String(Args[1]);
-        c_ptr->load(path_cstr);
-    } catch (...) {
-        return LIBRARY_FUNCTION_ERROR;
-    }
-    libData->UTF8String_disown(path_cstr);
-    return LIBRARY_NO_ERROR;
-}
-
-EXTERN_C DLLEXPORT int IndexView(WolframLibraryData libData, mint Argc, MArgument* Args, MArgument Res) {
-    char* path_cstr = nullptr;
-    index_t* c_ptr = (index_t*)MArgument_getUTF8String(Args[0]);
-    try {
-        path_cstr = MArgument_getUTF8String(Args[1]);
-        c_ptr->view(path_cstr);
-    } catch (...) {
-        return LIBRARY_FUNCTION_ERROR;
-    }
-    libData->UTF8String_disown(path_cstr);
-    return LIBRARY_NO_ERROR;
-}
-
-EXTERN_C DLLEXPORT int IndexDestroy(WolframLibraryData libData, mint Argc, MArgument* Args, MArgument Res) {
-    delete (index_t*)MArgument_getUTF8String(Args[0]);
-    return LIBRARY_NO_ERROR;
-}
-
-EXTERN_C DLLEXPORT int IndexSize(WolframLibraryData libData, mint Argc, MArgument* Args, MArgument Res) {
-    std::size_t res = ((index_t*)MArgument_getUTF8String(Args[0]))->size();
-    MArgument_setInteger(Res, res);
-    return LIBRARY_NO_ERROR;
-}
-
-EXTERN_C DLLEXPORT int IndexConnectivity(WolframLibraryData libData, mint Argc, MArgument* Args, MArgument Res) {
-    std::size_t res = ((index_t*)MArgument_getUTF8String(Args[0]))->connectivity();
-    MArgument_setInteger(Res, res);
-    return LIBRARY_NO_ERROR;
-}
-
-EXTERN_C DLLEXPORT int IndexDimensions(WolframLibraryData libData, mint Argc, MArgument* Args, MArgument Res) {
-    std::size_t res = ((index_t*)MArgument_getUTF8String(Args[0]))->dimensions();
-    MArgument_setInteger(Res, res);
-    return LIBRARY_NO_ERROR;
-}
-
-EXTERN_C DLLEXPORT int IndexCapacity(WolframLibraryData libData, mint Argc, MArgument* Args, MArgument Res) {
-    std::size_t res = ((index_t*)MArgument_getUTF8String(Args[0]))->capacity();
-    MArgument_setInteger(Res, res);
-    return LIBRARY_NO_ERROR;
-}
-
-EXTERN_C DLLEXPORT int IndexAdd(WolframLibraryData libData, mint Argc, MArgument* Args, MArgument Res) {
-    char* path_cstr = nullptr;
-    index_t* c_ptr = (index_t*)MArgument_getUTF8String(Args[0]);
-    float* vector_data = nullptr;
-    try {
-        int key = MArgument_getInteger(Args[1]);
-        MTensor tens = MArgument_getMTensor(Args[2]);
-        std::size_t len = libData->MTensor_getFlattenedLength(tens);
-        vector_data = (float*)libData->MTensor_getRealData(tens);
-        vector_view_t vector_span = vector_view_t{vector_data, len};
-        c_ptr->add(key, vector_span);
-    } catch (...) {
-        return LIBRARY_FUNCTION_ERROR;
-    }
-    return LIBRARY_NO_ERROR;
-}
-
-EXTERN_C DLLEXPORT int IndexSearch(WolframLibraryData libData, mint Argc, MArgument* Args, MArgument Res) {
-    index_t* c_ptr = (index_t*)MArgument_getUTF8String(Args[0]);
-    MTensor matches;
-    mint dims[] = {1};
-    int wanted = MArgument_getInteger(Args[2]);
-    float* vector_data = nullptr;
-    int* matches_data = nullptr;
-    std::size_t found = 0;
-
-    try {
-        libData->MTensor_new(MType_Integer, 1, dims, &matches);
-
-        MTensor tens = MArgument_getMTensor(Args[1]);
-        std::size_t len = libData->MTensor_getFlattenedLength(tens);
-        vector_data = (float*)libData->MTensor_getRealData(tens);
-        vector_view_t vector_span = vector_view_t{vector_data, len};
-
-        matches_data = (int*)std::malloc(sizeof(int) * wanted);
-        found = c_ptr->search(vector_span, static_cast<std::size_t>(wanted), matches_data, nullptr);
-        for (mint i = 0; i < found; i++)
-            libData->MTensor_setInteger(matches, &i, matches_data[i]);
-
-        MArgument_setMTensor(Res, matches);
-    } catch (...) {
-        return LIBRARY_FUNCTION_ERROR;
-    }
-    std::free(matches_data);
-    return LIBRARY_NO_ERROR;
-}

package/wolfram/test.wls

@@ -1,27 +0,0 @@
-#!/usr/bin/env wolframscript
-
-IndexCreate = LibraryFunctionLoad["wolfram/usearchWFM.so", "IndexCreate", {"UTF8String", "UTF8String", Integer, Integer, Integer, Integer, Integer}, Integer]
-IndexSave = LibraryFunctionLoad["wolfram/usearchWFM.so", "IndexSave", {Integer, "UTF8String"}, "Void"]
-IndexLoad = LibraryFunctionLoad["wolfram/usearchWFM.so", "IndexLoad", {Integer, "UTF8String"}, "Void"]
-IndexView = LibraryFunctionLoad["wolfram/usearchWFM.so", "IndexView", {Integer, "UTF8String"}, "Void"]
-IndexDestroy = LibraryFunctionLoad["wolfram/usearchWFM.so", "IndexDestroy", {Integer}, "Void"]
-IndexSize = LibraryFunctionLoad["wolfram/usearchWFM.so", "IndexSize", {Integer}, Integer]
-IndexConnectivity = LibraryFunctionLoad["wolfram/usearchWFM.so", "IndexConnectivity", {Integer}, Integer]
-IndexDimensions = LibraryFunctionLoad["wolfram/usearchWFM.so", "IndexDimensions", {Integer}, Integer]
-IndexCapacity = LibraryFunctionLoad["wolfram/usearchWFM.so", "IndexCapacity", {Integer}, Integer]
-IndexAdd = LibraryFunctionLoad["wolfram/usearchWFM.so", "IndexAdd", {Integer, Integer, {Real, 1}}, "Void"]
-IndexSearch = LibraryFunctionLoad["wolfram/usearchWFM.so", "IndexSearch", {Integer, {Real, 1}, Integer}, {Integer, 1}]
-Print["Functions Loaded"]
-
-$index = IndexCreate["cos", "f16", 10, 10, 10, 10, 10]
-Print["New Index Address: ", $index]
-Print["Index Size: ", IndexSize[$index]]
-Print["Index Capacity: ", IndexCapacity[$index]]
-Print["Index Connectivity: ", IndexConnectivity[$index]]
-$arr = {1.0, 2.0, 3.0, 4.0, 5.0};
-IndexAdd[$index, 42, $arr]
-Print["Added Array: ", $arr]
-$res = IndexSearch[$index, $arr, 42]
-Print["Searched: ", $res]
-IndexDestroy[$index]
-Print["Index Destroyed"]