Skip to main content

AnnIndex

Struct AnnIndex 

Source
pub struct AnnIndex {
    pub snapshot_max: u64,
    pub metric: Metric,
    pub dim: u16,
    /* private fields */
}
Expand description

In-memory ANN index over a (row_id, vector) snapshot.

Fields§

§snapshot_max: u64

Highest row_id in the snapshot.

§metric: Metric§dim: u16

Implementations§

Source§

impl AnnIndex

Source

pub fn build( rows: Vec<(u64, Vec<f32>)>, metric: Metric, dim: u16, ) -> Result<Self, AnnError>

Build an unfiltered index from (row_id, vector) pairs.

Source

pub fn build_with_attrs( rows: Vec<(u64, Vec<f32>, Vec<u32>)>, num_attrs: usize, metric: Metric, dim: u16, ) -> Result<Self, AnnError>

Build a filtered index from (row_id, vector, attr_codes) triples. Each attribute is a PRISM dimension; distinct tuples form the searchable cells.

Source

pub fn search(&self, query: &[f32], k: usize) -> Vec<(u64, f32)>

Top-k search returning (row_id, distance) ascending, at the default ef.

Source

pub fn search_with_ef( &self, query: &[f32], k: usize, ef: usize, ) -> Vec<(u64, f32)>

Unfiltered search with an explicit beam width ef.

Source

pub fn search_filtered_default_ef( &self, query: &[f32], k: usize, filter: &Filter, ) -> Vec<(u64, f32)>

Filtered search at the default ef.

Source

pub fn search_filtered( &self, query: &[f32], k: usize, ef: usize, filter: &Filter, ) -> Vec<(u64, f32)>

Filtered search; filter dims index the build_with_attrs attributes (Filter::none() matches all).

Source

pub fn indexed_len(&self) -> usize

Number of indexed rows.

Trait Implementations§

Source§

impl Debug for AnnIndex

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V