Struct Index

pub struct Index(/* private fields */);

Ivf-Flat ANN Index

Implementations

impl Index

pub fn build<T: Into<ManagedTensor>>( res: &Resources, params: &IndexParams, dataset: T, ) -> Result<Index>

Builds a new Index from the dataset for efficient search.

Arguments

• res - Resources to use
• params - Parameters for building the index
• dataset - A row-major matrix on either the host or device to index

pub fn new() -> Result<Index>

Creates a new empty index

pub fn search( self, res: &Resources, params: &SearchParams, queries: &ManagedTensor, neighbors: &ManagedTensor, distances: &ManagedTensor, ) -> Result<()>

Perform a Approximate Nearest Neighbors search on the Index

Arguments

• res - Resources to use
• params - Parameters to use in searching the index
• queries - A matrix in device memory to query for
• neighbors - Matrix in device memory that receives the indices of the nearest neighbors
• distances - Matrix in device memory that receives the distances of the nearest neighbors

Trait Implementations

impl Debug for Index

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Index

fn drop(&mut self)

Executes the destructor for this type.