Skip to main content

HnswIndex

Struct HnswIndex 

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

Wrapper around usearch::Index providing a typed interface.

Implementations§

Source§

impl HnswIndex

Source

pub fn new( dim: usize, vtype: VectorType, metric: DistanceMetric, params: Option<HnswParams>, ) -> Result<Self, IndexError>

Create a new empty HNSW index.

Source

pub fn len(&self) -> usize

Number of vectors in the index.

Source

pub fn is_empty(&self) -> bool

Source

pub fn add(&self, key: u64, blob: &[u8]) -> Result<(), IndexError>

Add a vector to the index. The blob must match the index’s type and dimension.

Source

pub fn search( &self, query_blob: &[u8], k: usize, ) -> Result<Vec<(u64, f32)>, IndexError>

Search for k nearest neighbors. Returns vec of (key, distance) pairs sorted by distance ascending.

Source

pub fn remove(&self, key: u64) -> Result<(), IndexError>

Remove a vector by key (soft delete).

Source

pub fn save_to_buffer(&self) -> Result<Vec<u8>, IndexError>

Serialize the index to a byte buffer.

Source

pub fn load_from_buffer(&self, buf: &[u8]) -> Result<(), IndexError>

Load index state from a byte buffer. Replaces current index contents.

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, 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, 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.