Struct IvfIndex 

pub struct IvfIndex { /* private fields */ }

IVF Index for approximate nearest neighbor search

Implementations

impl IvfIndex

pub fn new(config: IvfConfig) -> Self

Create a new IVF index (untrained)

pub fn with_dimension(dimension: usize) -> Self

Create with default config for given dimension

pub fn train(&mut self, vectors: &[Vec<f32>])

Train the index using k-means clustering

pub fn add(&mut self, vector: Vec<f32>) -> NodeId

Add a single vector

pub fn add_with_id(&mut self, id: NodeId, vector: Vec<f32>)

Add a vector with specific ID

pub fn add_batch(&mut self, vectors: Vec<Vec<f32>>) -> Vec<NodeId>

Add multiple vectors

pub fn add_batch_with_ids(&mut self, items: Vec<(NodeId, Vec<f32>)>)

Add multiple vectors with IDs

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

Remove a vector by ID

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

Search for k nearest neighbors

pub fn search_with_probes( &self, query: &[f32], k: usize, n_probes: usize, ) -> Vec<DistanceResult>

Search with custom number of probes

pub fn get(&self, id: NodeId) -> Option<&[f32]>

Get a vector by ID

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

Check if index contains an ID

pub fn len(&self) -> usize

Get total vector count

pub fn is_empty(&self) -> bool

Check if empty

pub fn n_lists(&self) -> usize

Get number of clusters

pub fn stats(&self) -> IvfStats

Get cluster statistics

pub fn to_bytes(&self) -> Vec<u8>

Serialize the index to bytes for storage.

The IVF1 payload byte layout is owned by reddb-file (ADR 0046); this only projects the engine state into reddb_file::IvfIndexFrame.

pub fn from_bytes(bytes: &[u8]) -> Result<Self, String>

Deserialize an index from bytes via the reddb-file codec.