Struct BinaryIVFIndexImpl 

pub struct BinaryIVFIndexImpl { /* private fields */ }

Native implementation of a binary IVF index.

Implementations

impl BinaryIVFIndexImpl

pub fn nprobe(&self) -> u32

Get number of probes at query time

pub fn set_nprobe(&mut self, value: u32)

Set number of probes at query time

pub fn nlist(&self) -> u32

Get number of possible key values

pub fn max_codes(&self) -> u32

Get max number of codes to visit to do a query

pub fn set_max_codes(&self, value: u32)

Set max number of codes to visit to do a query

pub fn imbalance_factor(&self) -> f64

Check the inverted lists’ imbalance factor.

1 = perfectly balanced, > 1: imbalanced

Trait Implementations

impl ConcurrentIndex<u8, i32> for BinaryIVFIndexImpl

where Self: Index<u8, i32> + NativeIndex<u8, i32>,

fn assign(&self, query: &[u8], k: usize) -> Result<AssignSearchResult>

Similar to search, but only provides the labels.

fn search(&self, query: &[u8], k: usize) -> Result<SearchResult<i32>>

Perform a search for the k closest vectors to the given query vectors.

fn range_search(&self, query: &[u8], radius: i32) -> Result<RangeSearchResult>

Perform a ranged search for the vectors closest to the given query vectors by the given radius.

impl Debug for BinaryIVFIndexImpl

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

Formats the value using the given formatter.

impl Drop for BinaryIVFIndexImpl

fn drop(&mut self)

Executes the destructor for this type.

impl FromInnerPtr<u8, i32> for BinaryIVFIndexImpl

unsafe fn from_inner_ptr(inner_ptr: *mut FaissIndexBinary) -> Self

Create an index using the given pointer to a native object.

impl Index<u8, i32> for BinaryIVFIndexImpl

fn is_trained(&self) -> bool

Whether the Index does not require training, or if training is done already

fn ntotal(&self) -> u64

The total number of vectors indexed

fn d(&self) -> u32

The dimensionality of the indexed vectors

fn metric_type(&self) -> MetricType

The metric type assumed by the index

fn add(&mut self, x: &[u8]) -> Result<()>

Add new data vectors to the index. This assumes a C-contiguous memory slice of vectors, where the total number of vectors is x.len() / d.

fn add_with_ids(&mut self, x: &[u8], xids: &[Idx]) -> Result<()>

Add new data vectors to the index with IDs. This assumes a C-contiguous memory slice of vectors, where the total number of vectors is x.len() / d. Not all index types may support this operation.

fn train(&mut self, x: &[u8]) -> Result<()>

Train the underlying index with the given data.

fn assign(&mut self, query: &[u8], k: usize) -> Result<AssignSearchResult>

Similar to search, but only provides the labels.

fn search(&mut self, query: &[u8], k: usize) -> Result<SearchResult<i32>>

Perform a search for the k closest vectors to the given query vectors.

fn range_search( &mut self, query: &[u8], radius: i32, ) -> Result<RangeSearchResult>

Perform a ranged search for the vectors closest to the given query vectors by the given radius.

fn reconstruct(&self, idx: Idx, output: &mut [u8]) -> Result<()>

Reconstruct a single stored vector (or an approximation if lossy coding)

fn reconstruct_n( &self, first_key: Idx, count: usize, output: &mut [u8], ) -> Result<()>

Reconstruct vectors i0 to i0 + ni - 1.

fn reset(&mut self) -> Result<()>

Clear the entire index.

fn remove_ids(&mut self, sel: &IdSelector) -> Result<usize>

Remove data vectors represented by IDs.

fn verbose(&self) -> bool

Index verbosity level

fn set_verbose(&mut self, value: bool)

Set Index verbosity level

impl NativeIndex<u8, i32> for BinaryIVFIndexImpl

type Inner = FaissIndexBinary_H

The underlying native Faiss index.

fn inner_ptr(&self) -> *mut FaissIndexBinary

Retrieve a pointer to the native index object.

impl TryClone for BinaryIVFIndexImpl

fn try_clone(&self) -> Result<Self>

where Self: Sized,

Create an independent clone of this index.

impl CpuIndex<u8, i32> for BinaryIVFIndexImpl

impl Send for BinaryIVFIndexImpl

impl Sync for BinaryIVFIndexImpl