Struct IVFPQIndex 

pub struct IVFPQIndex {
    pub config: IVFPQConfig,
    pub centroids_version: u64,
    pub codebook_version: u64,
    /* private fields */
}

IVF-PQ index for a single segment

Fields

config: IVFPQConfig

Configuration

centroids_version: u64

Version of coarse centroids used (for merge compatibility)

codebook_version: u64

Version of PQ codebook used (for merge compatibility)

Implementations

impl IVFPQIndex

pub fn new( config: IVFPQConfig, centroids_version: u64, codebook_version: u64, ) -> Self

Create a new empty IVF-PQ index

pub fn build( config: IVFPQConfig, coarse_centroids: &CoarseCentroids, codebook: &PQCodebook, vectors: &[Vec<f32>], doc_id_ordinals: Option<&[(u32, u16)]>, ) -> Self

Build index from vectors using provided coarse centroids and PQ codebook

doc_id_ordinals: (doc_id, ordinal) pairs. If None, uses (index, 0).

pub fn add_vector( &mut self, coarse_centroids: &CoarseCentroids, codebook: &PQCodebook, doc_id: u32, ordinal: u16, vector: &[f32], )

Add a single vector to the index

pub fn add_vectors_parallel( &mut self, coarse_centroids: &CoarseCentroids, codebook: &PQCodebook, doc_id_ordinals: &[(u32, u16)], vectors: &[f32], ) -> Result<(), &'static str>

Add one contiguous vector batch in parallel while preserving input order inside every leaf. Callers can install this work on their bounded Rayon pool; normal segment builds use the current Rayon pool.

pub fn search_distinct_documents( &self, k: usize, plan: &IvfPqQueryPlan, ) -> Vec<(u32, u16, f32)>

Search a probe plan already computed from the global quantizer.

pub fn len(&self) -> usize

Number of indexed vectors

pub fn is_empty(&self) -> bool

pub fn num_clusters(&self) -> usize

Number of non-empty clusters

pub fn size_bytes(&self) -> usize

Memory usage estimate

pub fn estimated_memory_bytes(&self) -> usize

Estimated memory usage in bytes (alias for size_bytes)

Trait Implementations

impl Clone for IVFPQIndex

fn clone(&self) -> IVFPQIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IVFPQIndex

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

Formats the value using the given formatter.