Struct IVFPQIndex 

pub struct IVFPQIndex {
    pub config: IVFPQConfig,
    pub centroids_version: u64,
    pub codebook_version: u64,
    pub clusters: ClusterStorage<PQVector>,
}

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)

clusters: ClusterStorage<PQVector>

Cluster storage with PQ codes

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_ids: Option<&[u32]>, ) -> Self

Build index from vectors using provided coarse centroids and PQ codebook

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

Add a single vector to the index

pub fn search( &self, coarse_centroids: &CoarseCentroids, codebook: &PQCodebook, query: &[f32], k: usize, nprobe: Option<usize>, ) -> Vec<(u32, f32)>

Search for k nearest neighbors

pub fn search_mips( &self, coarse_centroids: &CoarseCentroids, codebook: &PQCodebook, query: &[f32], k: usize, nprobe: Option<usize>, ) -> Vec<(u32, f32)>

Search using inner product (MIPS - Maximum Inner Product Search)

pub fn merge_into( &mut self, other: &IVFPQIndex, doc_id_offset: u32, ) -> Result<(), &'static str>

Merge another index into this one (instance method)

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 to_bytes(&self) -> Result<Vec<u8>>

Serialize to bytes

pub fn from_bytes(data: &[u8]) -> Result<Self>

Deserialize from bytes

pub fn merge( indexes: &[&IVFPQIndex], doc_offsets: &[u32], ) -> Result<Self, &'static str>

Static merge function for backward compatibility with segment merger

Note: This is named merge for backward compatibility with existing code. It merges multiple indexes into a new one.

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.

impl<'de> Deserialize<'de> for IVFPQIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for IVFPQIndex

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

where __S: Serializer,

Serialize this value into the given Serde serializer.