Struct faiss::index::refine_flat::RefineFlatIndexImpl

pub struct RefineFlatIndexImpl<BI> { /* private fields */ }

Native implementation of a RefineFlat index.

Implementations

impl<BI: NativeIndex> RefineFlatIndexImpl<BI>

pub fn new(base_index: BI) -> Result<Self>

pub fn set_k_factor(&mut self, kf: f32)

pub fn k_factor(&self) -> f32

Trait Implementations

impl<BI> ConcurrentIndex for RefineFlatIndexImpl<BI>where BI: ConcurrentIndex,

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<BI: Debug> Debug for RefineFlatIndexImpl<BI>

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

Formats the value using the given formatter.

impl<BI> Drop for RefineFlatIndexImpl<BI>

fn drop(&mut self)

Executes the destructor for this type.

impl FromInnerPtr for RefineFlatIndexImpl<IndexImpl>

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

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

impl<BI> Index for RefineFlatIndexImpl<BI>

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<BI> NativeIndex for RefineFlatIndexImpl<BI>

fn inner_ptr(&self) -> *mut FaissIndex

Retrieve a pointer to the native index object.

impl<I> TryClone for RefineFlatIndexImpl<I>

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

Create an independent clone of this index.

impl TryFromInnerPtr for RefineFlatIndexImpl<IndexImpl>

unsafe fn try_from_inner_ptr(inner_ptr: *mut FaissIndex) -> Result<Self>where Self: Sized,

Create an index using the given pointer to a native object, checking that the index behind the given pointer is compatible with the target index type. If the inner index is not compatible with the intended target type (e.g. creating a FlatIndex out of a FaissIndexLSH), an error is returned.

impl<BI: CpuIndex> CpuIndex for RefineFlatIndexImpl<BI>

impl<BI: Send> Send for RefineFlatIndexImpl<BI>

impl<BI: Sync> Sync for RefineFlatIndexImpl<BI>