pub struct LshIndex { /* private fields */ }
Implementations
sourceimpl LshIndex
impl LshIndex
Trait Implementations
sourceimpl ConcurrentIndex for LshIndex where
Self: Index + NativeIndex,
impl ConcurrentIndex for LshIndex where
Self: Index + NativeIndex,
sourcefn assign(&self, query: &[f32], k: usize) -> Result<AssignSearchResult>
fn assign(&self, query: &[f32], k: usize) -> Result<AssignSearchResult>
Similar to search
, but only provides the labels.
sourcefn search(&self, query: &[f32], k: usize) -> Result<SearchResult>
fn search(&self, query: &[f32], k: usize) -> Result<SearchResult>
Perform a search for the k
closest vectors to the given query vectors.
sourcefn range_search(&self, query: &[f32], radius: f32) -> Result<RangeSearchResult>
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. Read more
sourceimpl FromInnerPtr for LshIndex
impl FromInnerPtr for LshIndex
sourceunsafe fn from_inner_ptr(inner_ptr: *mut FaissIndex) -> Self
unsafe fn from_inner_ptr(inner_ptr: *mut FaissIndex) -> Self
Create an index using the given pointer to a native object. Read more
sourceimpl Index for LshIndex
impl Index for LshIndex
sourcefn is_trained(&self) -> bool
fn is_trained(&self) -> bool
Whether the Index does not require training, or if training is done already
sourcefn metric_type(&self) -> MetricType
fn metric_type(&self) -> MetricType
The metric type assumed by the index
sourcefn add(&mut self, x: &[f32]) -> Result<()>
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
. Read more
sourcefn add_with_ids(&mut self, x: &[f32], xids: &[Idx]) -> Result<()>
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. Read more
sourcefn assign(&mut self, query: &[f32], k: usize) -> Result<AssignSearchResult>
fn assign(&mut self, query: &[f32], k: usize) -> Result<AssignSearchResult>
Similar to search
, but only provides the labels.
sourcefn search(&mut self, query: &[f32], k: usize) -> Result<SearchResult>
fn search(&mut self, query: &[f32], k: usize) -> Result<SearchResult>
Perform a search for the k
closest vectors to the given query vectors.
sourcefn range_search(
&mut self,
query: &[f32],
radius: f32
) -> Result<RangeSearchResult>
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. Read more
sourcefn remove_ids(&mut self, sel: &IdSelector) -> Result<usize>
fn remove_ids(&mut self, sel: &IdSelector) -> Result<usize>
Remove data vectors represented by IDs.
sourcefn set_verbose(&mut self, value: bool)
fn set_verbose(&mut self, value: bool)
Set Index verbosity level
sourceimpl NativeIndex for LshIndex
impl NativeIndex for LshIndex
sourcefn inner_ptr(&self) -> *mut FaissIndex
fn inner_ptr(&self) -> *mut FaissIndex
Retrieve a pointer to the native index object.
sourceimpl TryFromInnerPtr for LshIndex
impl TryFromInnerPtr for LshIndex
sourceunsafe fn try_from_inner_ptr(inner_ptr: *mut FaissIndex) -> Result<Self> where
Self: Sized,
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. Read more
impl CpuIndex for LshIndex
impl Send for LshIndex
impl Sync for LshIndex
Auto Trait Implementations
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more