Struct faiss::index::lsh::LshIndex

pub struct LshIndex { /* private fields */ }

Implementations

impl LshIndex

pub fn new(d: u32, nbits: u32) -> Result<Self>

Create a new LSH index.

pub fn new_with_options(
    d: u32,
    nbits: u32,
    rotate_data: bool,
    train_thresholds: bool
) -> Result<Self>

Create a new LSH index.

pub fn nbits(&self) -> u32

pub fn rotate_data(&self) -> bool

pub fn train_thresholds(&self) -> bool

pub fn bytes_per_vec(&self) -> usize

impl LshIndex

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 ConcurrentIndex for LshIndex

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 LshIndex

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

Formats the value using the given formatter.

impl Drop for LshIndex

fn drop(&mut self)

Executes the destructor for this type.

impl FromInnerPtr for LshIndex

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

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

impl Index for LshIndex

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<i64>

Remove data vectors represented by IDs.

impl NativeIndex for LshIndex

fn inner_ptr(&self) -> *mut FaissIndex

Retrieve a pointer to the native index object.

impl CpuIndex for LshIndex

impl Send for LshIndex

impl Sync for LshIndex