Struct faiss::index::scalar_quantizer::ScalarQuantizerIndexImpl

pub struct ScalarQuantizerIndexImpl { /* private fields */ }

Native implementation of a scalar quantizer index.

Implementations

impl ScalarQuantizerIndexImpl

pub fn new(d: u32, qt: QuantizerType, metric: MetricType) -> Result<Self>

Create a new scalar quantizer index.

Trait Implementations

impl ConcurrentIndex for ScalarQuantizerIndexImplwhere Self: Index + NativeIndex,

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

Similar to search, but only provides the labels.

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

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

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

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

impl Debug for ScalarQuantizerIndexImpl

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

Formats the value using the given formatter.

impl Drop for ScalarQuantizerIndexImpl

fn drop(&mut self)

Executes the destructor for this type.

impl FromInnerPtr for ScalarQuantizerIndexImpl

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

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

impl Index for ScalarQuantizerIndexImpl

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: &[f32]) -> 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: &[f32], 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: &[f32]) -> Result<()>

Train the underlying index with the given data.

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

Similar to search, but only provides the labels.

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

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

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

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

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 for ScalarQuantizerIndexImpl

fn inner_ptr(&self) -> *mut FaissIndex

Retrieve a pointer to the native index object.

impl TryClone for ScalarQuantizerIndexImpl

fn try_clone(&self) -> Result<Self>where Self: Sized,

Create an independent clone of this index.

impl CpuIndex for ScalarQuantizerIndexImpl

impl Send for ScalarQuantizerIndexImpl

impl Sync for ScalarQuantizerIndexImpl