Struct PQCodebook 

pub struct PQCodebook {
    pub config: PQConfig,
    pub rotation_matrix: Option<Vec<f32>>,
    pub centroids: Vec<f32>,
    pub version: u64,
}

Learned codebook for Product Quantization with OPQ rotation

Trained once, shared across all segments (like CoarseCentroids).

Fields

config: PQConfig

Configuration

rotation_matrix: Option<Vec<f32>>

OPQ rotation matrix (dim × dim), stored row-major

centroids: Vec<f32>

Centroids: M subspaces × K centroids × subspace_dim

version: u64

Version for merge compatibility checking

Implementations

impl PQCodebook

pub fn train(config: PQConfig, vectors: &[Vec<f32>], max_iters: usize) -> Self

Train the global residual codebook and OPQ rotation.

pub fn encode(&self, vector: &[f32], centroid: Option<&[f32]>) -> Vec<u8>

Encode one vector into an owned code for diagnostics and external use. Segment payload construction uses Self::encode_into to avoid one allocation per indexed vector.

pub fn decode(&self, codes: &[u8]) -> Vec<f32>

Decode PQ codes back to approximate vector

pub fn get_centroid(&self, subspace_idx: usize, code: u8) -> &[f32]

Get centroid for a specific subspace and code

pub fn rotate_query(&self, query: &[f32]) -> Vec<f32>

Rotate a query vector

pub fn size_bytes(&self) -> usize

Memory usage in bytes

Trait Implementations

impl Clone for PQCodebook

fn clone(&self) -> PQCodebook

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PQCodebook

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PQCodebook

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PQCodebook

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

where __S: Serializer,

Serialize this value into the given Serde serializer.