Struct TurbovecIndex 

pub struct TurbovecIndex { /* private fields */ }

Compressed vector index backed by TurboQuant.

Wraps turbovec::IdMapIndex with dimension validation and a consistent error-handling layer. Supports online ingest (no training step), filtered search with allowlists, and persistence via save/load.

Implementations

impl TurbovecIndex

pub fn new(dim: usize, bit_width: u8) -> Result<Self>

Create a new index for vectors of the given dimension.

bit_width must be 2 or 4, controlling the quantization level:

• 2-bit: 16x compression, lower recall at low k
• 4-bit: 8x compression, higher recall (recommended default)

pub fn bit_width(&self) -> u8

Quantization bit width (2 or 4).

pub fn load(path: &Path) -> Result<Self>

Load a previously saved index from disk.

This is an inherent method (not on the VectorIndex trait) so that the trait remains fully object-safe. Callers must use the concrete type: TurbovecIndex::load(path).

Trait Implementations

impl Debug for TurbovecIndex

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

Formats the value using the given formatter.

impl VectorIndex for TurbovecIndex

fn add(&mut self, vectors: &[Vec<f32>]) -> Result<()>

Add vectors with auto-assigned sequential IDs.

fn add_with_ids(&mut self, vectors: &[Vec<f32>], ids: &[u64]) -> Result<()>

Add vectors with explicit external IDs.

fn remove(&mut self, ids: &[u64]) -> Result<()>

Remove vectors by their external IDs.

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

Search for the k nearest neighbors of query.

fn search_filtered( &self, query: &[f32], k: usize, allowlist: &[u64], ) -> Result<Vec<SearchHit>>

Search restricted to an allowlist of candidate IDs.

fn len(&self) -> usize

Number of vectors currently indexed.

fn is_empty(&self) -> bool

Whether the index is empty.

fn dim(&self) -> usize

Vector dimensionality.

fn save(&self, path: &Path) -> Result<()>

Persist the index to disk.