Struct usearch::ffi::Index

#[repr(C)]
pub struct Index { /* private fields */ }

Represents the USearch index.

Implementations

impl Index

pub fn reserve(&self, capacity: usize) -> Result<(), Exception>

Reserves memory for a specified number of incoming vectors.

Arguments

• capacity - The desired total capacity including the current size.

impl Index

pub fn dimensions(&self) -> usize

Retrieves the number of dimensions in the vectors indexed.

impl Index

pub fn connectivity(&self) -> usize

Retrieves the connectivity parameter that limits connections-per-node in the graph.

impl Index

pub fn size(&self) -> usize

Retrieves the current number of vectors in the index.

impl Index

pub fn capacity(&self) -> usize

Retrieves the total capacity of the index, including reserved space.

impl Index

pub fn serialized_length(&self) -> usize

Reports expected file size after serialization.

impl Index

pub fn add(&self, key: u64, vector: &[f32]) -> Result<(), Exception>

Adds a vector with a specified key to the index.

Arguments

• key - The key associated with the vector.
• vector - A slice containing the vector data.

impl Index

pub fn add_i8(&self, key: u64, vector: &[i8]) -> Result<(), Exception>

impl Index

pub fn add_f16(&self, key: u64, vector: &[u16]) -> Result<(), Exception>

impl Index

pub fn add_f32(&self, key: u64, vector: &[f32]) -> Result<(), Exception>

impl Index

pub fn add_f64(&self, key: u64, vector: &[f64]) -> Result<(), Exception>

impl Index

pub fn search(&self, query: &[f32], count: usize) -> Result<Matches, Exception>

Performs k-Approximate Nearest Neighbors (kANN) Search for closest vectors to the provided query.

Arguments

• query - A slice containing the query vector data.
• count - The maximum number of neighbors to search for.

Returns

A Result containing the matches found.

impl Index

pub fn search_i8( &self, query: &[i8], count: usize ) -> Result<Matches, Exception>

impl Index

pub fn search_f16( &self, query: &[u16], count: usize ) -> Result<Matches, Exception>

impl Index

pub fn search_f32( &self, query: &[f32], count: usize ) -> Result<Matches, Exception>

impl Index

pub fn search_f64( &self, query: &[f64], count: usize ) -> Result<Matches, Exception>

impl Index

pub fn remove(&self, key: u64) -> Result<bool, Exception>

Removes the vector associated with the given key from the index.

Arguments

• key - The key of the vector to be removed.

Returns

true if the vector is successfully removed, false otherwise.

impl Index

pub fn rename(&self, from: u64, to: u64) -> Result<bool, Exception>

Renames the vector under a certain key.

Arguments

• from - The key of the vector to be renamed.
• to - The new name.

Returns

true if the vector is successfully renamed, false otherwise.

impl Index

pub fn contains(&self, key: u64) -> bool

Checks if the index contains a vector with a specified key.

Arguments

• key - The key to be checked.

Returns

true if the index contains the vector with the given key, false otherwise.

impl Index

pub fn save(&self, path: &str) -> Result<(), Exception>

Saves the index to a specified file.

Arguments

• path - The file path where the index will be saved.

impl Index

pub fn load(&self, path: &str) -> Result<(), Exception>

Loads the index from a specified file.

Arguments

• path - The file path from where the index will be loaded.

impl Index

pub fn view(&self, path: &str) -> Result<(), Exception>

Creates a view of the index from a file without loading it into memory.

Arguments

• path - The file path from where the view will be created.

impl Index

pub fn save_to_buffer(&self, buffer: &mut [u8]) -> Result<(), Exception>

Saves the index to a specified file.

Arguments

• path - The file path where the index will be saved.

impl Index

pub fn load_from_buffer(&self, buffer: &[u8]) -> Result<(), Exception>

Loads the index from a specified file.

Arguments

• path - The file path from where the index will be loaded.

impl Index

pub fn view_from_buffer(&self, buffer: &[u8]) -> Result<(), Exception>

Creates a view of the index from a file without loading it into memory.

Arguments

• path - The file path from where the view will be created.

Trait Implementations

impl ExternType for Index

type Kind = Opaque

Either cxx::kind::Opaque or cxx::kind::Trivial.

type Id

A type-level representation of the type’s C++ namespace and type name.

impl UniquePtrTarget for Index