Struct faiss::index::IndexImpl

pub struct IndexImpl { /* fields omitted */ }

Native implementation of a Faiss Index running on the CPU.

Implementations

impl IndexImpl

pub fn as_flat(self) -> Result<FlatIndexImpl>

👎 Deprecated since 0.8.0:

Non-idiomatic name, prefer into_flat instead

Attempt a dynamic cast of an index to the flat index type.

pub fn into_flat(self) -> Result<FlatIndexImpl>

Attempt a dynamic cast of an index to the flat index type.

impl IndexImpl

pub fn into_ivf_flat(self) -> Result<IVFFlatIndexImpl>

Attempt a dynamic cast of an index to the IVF flat index type.

impl IndexImpl

pub fn into_scalar_quantizer(self) -> Result<ScalarQuantizerIndexImpl>

Attempt a dynamic cast of an index to the Scalar Quantizer index type.

impl IndexImpl

pub fn into_ivf_scalar_quantizer(
    self
) -> Result<IVFScalarQuantizerIndexImpl<IndexImpl>>

Attempt a dynamic cast of an index to the IVF Scalar Quantizer index type.

impl IndexImpl

pub fn as_lsh(self) -> Result<LshIndex>

👎 Deprecated since 0.8.0:

Non-idiomatic name, prefer into_lsh instead

Attempt a dynamic cast of an index to the LSH index type.

pub fn into_lsh(self) -> Result<LshIndex>

Attempt a dynamic cast of an index to the LSH index type.

impl IndexImpl

pub fn into_pre_transform(self) -> Result<PreTransformIndexImpl<IndexImpl>>

impl IndexImpl

pub fn to_gpu<'gpu, G: 'gpu>(
    &self,
    gpu_res: &'gpu G,
    device: i32
) -> Result<GpuIndexImpl<'gpu, IndexImpl>> where
    G: GpuResourcesProvider, 

Build a GPU index from the given CPU native index.

Errors

The operation fails if the index type does not provide GPU support.

pub fn into_gpu<'gpu, G: 'gpu>(
    self,
    gpu_res: &'gpu G,
    device: i32
) -> Result<GpuIndexImpl<'gpu, IndexImpl>> where
    G: GpuResourcesProvider, 

Build a GPU index from the given CPU native index. The index residing in CPU memory is discarded in the process.

Errors

The operation fails if the index does not provide GPU support.

pub fn to_gpu_multiple<'gpu, G: 'gpu>(
    &self,
    gpu_res: &'gpu [G],
    devices: &[i32]
) -> Result<GpuIndexImpl<'gpu, IndexImpl>> where
    G: GpuResourcesProvider, 

Build a GPU index from the given CPU native index.

Errors

The operation fails if the number of GPU resources and number of devices do not match, or the index does not provide GPU support.

pub fn into_gpu_multiple<'gpu, G: 'gpu>(
    self,
    gpu_res: &'gpu [G],
    devices: &[i32]
) -> Result<GpuIndexImpl<'gpu, IndexImpl>> where
    G: GpuResourcesProvider, 

Build a GPU index from the given CPU native index. The index residing in CPU memory is discarded in the process.

Errors

The operation fails if the number of GPU resources and number of devices do not match, or the index does not provide GPU support.

impl IndexImpl

pub fn inner_ptr(&self) -> *mut FaissIndex

impl IndexImpl

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

Create an independent clone of this index.

Errors

May result in a native error if the clone operation is not supported for the internal type of index.

Trait Implementations

impl Debug for IndexImpl

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

Formats the value using the given formatter.

impl Drop for IndexImpl

fn drop(&mut self)

Executes the destructor for this type.

impl FromInnerPtr for IndexImpl

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

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

impl Index for IndexImpl

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 IndexImpl

fn inner_ptr(&self) -> *mut FaissIndex

Retrieve a pointer to the native index object.

impl TryFromInnerPtr for IndexImpl

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

impl CpuIndex for IndexImpl

impl Send for IndexImpl

impl Sync for IndexImpl