Struct HnswIndex 

pub struct HnswIndex { /* private fields */ }

Hand-rolled HNSW index over f32 vectors.

Implementations

impl HnswIndex

pub fn new(distance: Distance, params: HnswParams) -> Self

Build an empty index.

pub fn len(&self) -> usize

Number of live (non-deleted) nodes.

pub fn is_empty(&self) -> bool

true when the index has no live nodes.

pub fn dim(&self) -> u16

Vector dimension, or 0 if the index is empty.

pub fn distance(&self) -> Distance

Distance metric this index was built with.

pub fn insert(&mut self, id: NodeId, vector: Vec<f32>) -> Result<(), IndexError>

Insert a new vector under id.

Errors

IndexError::Empty for a zero-dim vector, IndexError::DimensionMismatch when the vector’s dimension differs from the index’s frozen dimension, and IndexError::Duplicate when id is already in the index.

pub fn delete(&mut self, id: NodeId) -> bool

Soft-delete id. The node remains in the graph for connectivity but is filtered out of search results.

Returns true when the id was present, false otherwise.

pub fn search( &self, query: &[f32], k: usize, ef: Option<usize>, ) -> Result<Vec<SearchResult>, IndexError>

Search for the k nearest neighbours of query.

ef controls the search beam width. Pass None to use the index’s default ef_search. A larger ef trades CPU for recall.

Errors

Returns IndexError::DimensionMismatch when the query vector’s dimension does not match the index’s frozen dimension.

pub fn contains(&self, id: NodeId) -> bool

true when id is currently a live node in the index.

Trait Implementations

impl Clone for HnswIndex

fn clone(&self) -> HnswIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HnswIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HnswIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HnswIndex

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.