Struct faiss::index::id_map::IdMap

pub struct IdMap<I> { /* private fields */ }

Wrapper for implementing arbitrary ID mapping to an index.

See the module level documentation for more information.

Implementations

impl<I> IdMap<I> where
    I: NativeIndex, 

pub fn new(index: I) -> Result<Self>

Augment an index with arbitrary ID mapping.

pub fn id_map(&self) -> &[Idx]

Retrieve a slice of the internal ID map.

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

Obtain the raw pointer to the internal index.

Safety

While this method is safe, note that the returned index pointer is already owned by this ID map. Therefore, it is undefined behavior to create a high-level index value from this pointer without first decoupling this ownership. See [into_inner] for a safe alternative.

pub fn into_inner(self) -> I where
    I: FromInnerPtr, 

Discard the ID map, recovering the index originally created without it.

pub fn try_into_inner(self) -> Result<I> where
    I: TryFromInnerPtr, 

Discard the ID map, recovering the index originally created without it. Safety build managed index from pointer.

pub fn try_cast_inner_index<B>(self) -> Result<IdMap<B>> where
    B: TryFromInnerPtr, 

Specialization of the index type inside IdMap.

Trait Implementations

impl<I> ConcurrentIndex for IdMap<I> where
    I: 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<I: Debug> Debug for IdMap<I>

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

Formats the value using the given formatter.

impl<I> Drop for IdMap<I>

fn drop(&mut self)

Executes the destructor for this type.

impl<I> Index for IdMap<I>

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<I> NativeIndex for IdMap<I>

fn inner_ptr(&self) -> *mut FaissIndex

Retrieve a pointer to the native index object.

impl<I: CpuIndex> CpuIndex for IdMap<I>

impl<I: Send> Send for IdMap<I>

impl<I: Sync> Sync for IdMap<I>