Struct faiss_next::CpuIndex

pub struct CpuIndex {
    pub inner: *mut FaissIndex,
}

Index use cpu

Examples

use faiss_next as faiss;
use faiss::Index;
let mut index = faiss::index_factory(128, "Flat", faiss::FaissMetricType::METRIC_L2).expect("failed to create index");
index.add(&vec![0.0;128 * 128]).expect("failed to add feature");
let ret = index.search(&vec![0.0;128], 1).expect("failed to search");

Fields

inner: *mut FaissIndex

Trait Implementations

impl Clone for CpuIndex

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CpuIndex

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

Formats the value using the given formatter.

impl Drop for CpuIndex

fn drop(&mut self)

Executes the destructor for this type.

impl Index for CpuIndex

fn inner(&self) -> *mut FaissIndex

return inner pointer

fn add<T: AsRef<[f32]> + ?Sized>(&mut self, x: &T) -> Result<()>

add vectors to index, x.len() should be a multiple of d

fn search<T: AsRef<[f32]> + ?Sized>( &self, x: &T, k: usize ) -> Result<SearchResult>

search vector against index, x.len() should be a multiple of d, k means top k

fn d(&self) -> usize

return dimension of index

fn train<T: AsRef<[f32]> + ?Sized>(&mut self, x: &T) -> Result<()>

train index when some index impl is used, is_trained is todo

fn remove_ids(&mut self, sel: IDSelector) -> Result<usize>

remove feature with IDSelector

fn save<P: AsRef<str>>(&self, pth: P) -> Result<()>

save index to disk

fn load<P: AsRef<str>>(pth: P) -> Result<CpuIndex>

load index from disk