Struct ngt::Index

pub struct Index { /* fields omitted */ }

Implementations

impl Index

pub fn create<P: AsRef<Path>>(path: P, prop: Properties) -> Result<Self, Error>

Create an empty index with the given properies.

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Open the already existing index at the specified path.

pub fn search(
    &self,
    vec: &[f64],
    res_size: u64,
    epsilon: f32
) -> Result<Vec<SearchResult>, Error>

Search the nearest vectors to the specified query vector. The index must have been built beforehand.

pub fn insert<F: Into<f64>>(&mut self, vec: Vec<F>) -> Result<VecId, Error>

Insert the specified vector into the index. However note that it is not discoverable yet. The method build must be called after inserting vectors.

pub fn insert_batch<F: Into<f64>>(
    &mut self,
    batch: Vec<Vec<F>>
) -> Result<(), Error>

Insert the multiple vectors into the index. However note that they are not discoverable yet. The method build must be called after inserting vectors.

pub fn build(&mut self, num_threads: u32) -> Result<(), Error>

Build the index for the vectors that have been inserted so far.

pub fn persist(&mut self) -> Result<(), Error>

Persist the index to the disk.

pub fn remove(&mut self, id: VecId) -> Result<(), Error>

Remove the specified vector.

pub fn get_vec(&self, id: VecId) -> Result<Vec<f32>, Error>

Get the specified vector.

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.

impl Send for Index

impl Sync for Index