Struct faiss::index::pretransform::PreTransformIndexImpl
source · pub struct PreTransformIndexImpl<I> { /* private fields */ }
Expand description
Native implementation of a flat index.
Implementations§
source§impl<I> PreTransformIndexImpl<I>where
I: NativeIndex,
impl<I> PreTransformIndexImpl<I>where I: NativeIndex,
pub fn new<LT: NativeVectorTransform>(lt: LT, sub_index: I) -> Result<Self>
pub fn prepend_transform<LT: NativeVectorTransform>( &mut self, ltrans: LT ) -> Result<()>
Trait Implementations§
source§impl<I> ConcurrentIndex for PreTransformIndexImpl<I>where
I: ConcurrentIndex,
impl<I> ConcurrentIndex for PreTransformIndexImpl<I>where I: ConcurrentIndex,
source§fn 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.source§fn 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.source§fn 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.
source§impl<I: Debug> Debug for PreTransformIndexImpl<I>
impl<I: Debug> Debug for PreTransformIndexImpl<I>
source§impl<I> Drop for PreTransformIndexImpl<I>
impl<I> Drop for PreTransformIndexImpl<I>
source§impl FromInnerPtr for PreTransformIndexImpl<IndexImpl>
impl FromInnerPtr for PreTransformIndexImpl<IndexImpl>
source§unsafe 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
source§impl<I> Index for PreTransformIndexImpl<I>
impl<I> Index for PreTransformIndexImpl<I>
source§fn is_trained(&self) -> bool
fn is_trained(&self) -> bool
Whether the Index does not require training, or if training is done already
source§fn metric_type(&self) -> MetricType
fn metric_type(&self) -> MetricType
The metric type assumed by the index
source§fn 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
.source§fn 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.source§fn 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.source§fn 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.source§fn 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.
source§fn remove_ids(&mut self, sel: &IdSelector) -> Result<usize>
fn remove_ids(&mut self, sel: &IdSelector) -> Result<usize>
Remove data vectors represented by IDs.
source§fn set_verbose(&mut self, value: bool)
fn set_verbose(&mut self, value: bool)
Set Index verbosity level
source§impl<I> NativeIndex for PreTransformIndexImpl<I>
impl<I> NativeIndex for PreTransformIndexImpl<I>
source§fn inner_ptr(&self) -> *mut FaissIndex
fn inner_ptr(&self) -> *mut FaissIndex
Retrieve a pointer to the native index object.
source§impl<I> TryClone for PreTransformIndexImpl<I>
impl<I> TryClone for PreTransformIndexImpl<I>
impl<I: CpuIndex> CpuIndex for PreTransformIndexImpl<I>
impl<I: Send> Send for PreTransformIndexImpl<I>
impl<I> Sync for PreTransformIndexImpl<I>
Auto Trait Implementations§
impl<I> RefUnwindSafe for PreTransformIndexImpl<I>where I: RefUnwindSafe,
impl<I> Unpin for PreTransformIndexImpl<I>where I: Unpin,
impl<I> UnwindSafe for PreTransformIndexImpl<I>where I: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more