Struct faiss::index::flat::FlatIndexImpl

pub struct FlatIndexImpl { /* private fields */ }

Native implementation of a flat index.

Implementations

impl FlatIndexImpl

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

Create a new flat index.

pub fn new_l2(d: u32) -> Result<Self>

Create a new flat index with L2 as the metric type.

pub fn new_ip(d: u32) -> Result<Self>

Create a new flat index with IP (inner product) as the metric type.

pub fn xb(&self) -> &[f32]

Obtain a reference to the indexed data.

pub fn compute_distance_subset(
    &mut self,
    x: &[f32],
    labels: &[Idx]
) -> Result<Vec<f32>>

Compute distance with a subset of vectors. x is a sequence of query vectors, size n * d, where n is inferred from the length of x. labels is a sequence of indexed vector ID’s that should be compared for each query vector, size n * k, where k is inferred from the length of labels. Returns the corresponding output distances, size n * k.

impl FlatIndexImpl

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.

impl FlatIndexImpl

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

Build a GPU in from the given CPU native index, yielding two independent indices. The operation fails if the index does not provide GPU support.

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

Build a GPU in from the given CPU native index, discarding the CPU-backed index. The operation fails if the index does not provide GPU support.

Trait Implementations

impl ConcurrentIndex for FlatIndexImpl

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 FlatIndexImpl

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

Formats the value using the given formatter.

impl Drop for FlatIndexImpl

fn drop(&mut self)

Executes the destructor for this type.

impl FromInnerPtr for FlatIndexImpl

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

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

impl NativeIndex for FlatIndexImpl

fn inner_ptr(&self) -> *mut FaissIndex

Retrieve a pointer to the native index object.

impl CpuIndex for FlatIndexImpl

impl Send for FlatIndexImpl

impl Sync for FlatIndexImpl