Struct PqConfig 

pub struct PqConfig {
    pub num_subspaces: usize,
    pub num_centroids: usize,
    pub dimension: usize,
}

Configuration parameters for a product quantizer.

Fields

num_subspaces: usize

Number of sub-spaces M.

num_centroids: usize

Number of centroids per sub-space K (typically 256).

dimension: usize

Full dimensionality of the input vectors.

Implementations

impl PqConfig

pub fn new( dimension: usize, num_subspaces: usize, num_centroids: usize, ) -> Result<Self, String>

Create a new PqConfig.

Returns an error if dimension is not divisible by num_subspaces, or if either num_subspaces or num_centroids is zero.

pub fn subspace_dim(&self) -> usize

Return the dimensionality of a single sub-space: dimension / num_subspaces.

Trait Implementations

impl Clone for PqConfig

fn clone(&self) -> PqConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PqConfig

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

Formats the value using the given formatter.