Struct PqParams 

pub struct PqParams {
    pub num_subquantizers: usize,
    pub bits_per_code: u8,
}

Product-quantization parameters for the RAM-resident approximate tier.

Fields

num_subquantizers: usize

Number of subquantizers (subspaces). The vector dimensionality must be divisible by this value.

bits_per_code: u8

Bits per subspace code. 8 gives the standard 256-centroid codebook.

Implementations

impl PqParams

pub const fn centroids_per_subspace(&self) -> usize

Number of centroids per subspace (2^bits_per_code).

pub fn validate(&self) -> Result<()>

Validate the PQ parameters in isolation (divisibility against the vector dimensionality is checked by BuildConfig::validate).

Trait Implementations

impl Clone for PqParams

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PqParams

impl Debug for PqParams

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

Formats the value using the given formatter.

impl Default for PqParams

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PqParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PqParams

impl PartialEq for PqParams

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for PqParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PqParams