Struct HnswBackend 

pub struct HnswBackend { /* private fields */ }

The in-memory HNSW backend persisted to a single fjall map.

Implementations

impl HnswBackend

pub fn open( base: &str, config: &NitriteConfig, params: &VectorIndexConfig, ) -> NitriteResult<(Self, bool)>

Opens (loading from the store) or creates the HNSW backend. The second return value is true when existing index data was unreadable and the (now wiped) index must be rebuilt from the collection.

pub fn dim(&self) -> usize

The index dimension.

pub fn metric(&self) -> Metric

The index metric.

pub fn len(&self) -> usize

Number of indexed vectors.

pub fn is_empty(&self) -> bool

Whether the index has no vectors.

pub fn insert(&self, id: u64, vector: Vec<f32>) -> NitriteResult<()>

Inserts or replaces the vector for id, persisting the change.

pub fn remove(&self, id: u64) -> NitriteResult<()>

Removes the vector for id, persisting the change.

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

Returns the k nearest document ids to query with their distances (smaller = closer), ordered ascending.

Trait Implementations

impl Clone for HnswBackend

fn clone(&self) -> HnswBackend

Returns a duplicate of the value.

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

Performs copy-assignment from source.