Struct ngt::NgtIndex

pub struct NgtIndex<T> { /* private fields */ }

Implementations

impl<T> NgtIndex<T>where T: NgtObjectType,

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

Creates an empty ANNG index with the given NgtProperties.

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

Open the already existing index at the specified path.

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

Search the nearest vectors to the specified query vector.

The index must have been built beforehand.

pub fn search_query(&self, query: NgtQuery<'_, T>) -> Result<Vec<SearchResult>>

Search the nearest vectors to the specified NgtQuery.

The index must have been built beforehand.

pub fn insert(&mut self, vec: Vec<T>) -> Result<VecId>

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(&mut self, batch: Vec<Vec<T>>) -> Result<()>

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: usize) -> Result<()>

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

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

Persist the index to the disk.

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

Remove the specified vector.

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

Get the specified vector.

pub fn nb_inserted(&self) -> usize

The number of vectors inserted (but not necessarily indexed).

pub fn nb_indexed(&self) -> usize

The number of indexed vectors, available after build.

Trait Implementations

impl<T: Debug> Debug for NgtIndex<T>

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

Formats the value using the given formatter.

impl<T> Drop for NgtIndex<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Send for NgtIndex<T>

impl<T> Sync for NgtIndex<T>