Skip to main content

AnnIndex

Struct AnnIndex 

Source
pub struct AnnIndex { /* private fields */ }
Expand description

A built RP-forest index over L2-normalized vectors.

Implementations§

Source§

impl AnnIndex

Source

pub fn build(data: &[Vec<f64>], config: &AnnConfig) -> Self

Build the index from raw (un-normalized) vectors. Each vector is L2-normalized internally. All vectors must have the same dimensionality. Panics if data is empty or dimensions disagree.

Source

pub fn build_normalized(normalized: Vec<Vec<f64>>, config: &AnnConfig) -> Self

Build from pre-normalized vectors (avoids a redundant normalization pass when the caller already has unit vectors). Enforces the same contract as Self::build: panics if normalized is empty or dimensions disagree.

Source

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

Find the k approximate nearest neighbors of query by cosine similarity. Returns (index, similarity) pairs sorted by descending similarity. query is L2-normalized internally.

Source

pub fn query_by_index(&self, index: usize, k: usize) -> Vec<(usize, f64)>

Find the k approximate nearest neighbors of the item at index (excludes self from results).

Source

pub fn knn_graph(&self, k: usize) -> Vec<Vec<usize>>

Build a full k-NN adjacency list for all items. Returns knn[i] = indices of the k nearest neighbors of item i (excluding self), sorted by descending similarity.

Source

pub fn knn_graph_with_sims(&self, k: usize) -> Vec<Vec<(usize, f64)>>

Like Self::knn_graph, but keeps each neighbor’s cosine similarity: graph[i] = (index, similarity) pairs for the k nearest neighbors of item i (excluding self), sorted by descending similarity.

Source

pub fn len(&self) -> usize

Number of indexed items.

Source

pub fn is_empty(&self) -> bool

True if the index contains no items.

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more