Struct CompressionParams

pub struct CompressionParams(pub cuvsCagraCompressionParams_t);

Supplemental parameters to build CAGRA Index

Tuple Fields

0: cuvsCagraCompressionParams_t

Implementations

impl CompressionParams

pub fn new() -> Result<CompressionParams>

Returns a new CompressionParams

pub fn set_pq_bits(self, pq_bits: u32) -> CompressionParams

The bit length of the vector element after compression by PQ.

pub fn set_pq_dim(self, pq_dim: u32) -> CompressionParams

The dimensionality of the vector after compression by PQ. When zero, an optimal value is selected using a heuristic.

pub fn set_vq_n_centers(self, vq_n_centers: u32) -> CompressionParams

Vector Quantization (VQ) codebook size - number of “coarse cluster centers”. When zero, an optimal value is selected using a heuristic.

pub fn set_kmeans_n_iters(self, kmeans_n_iters: u32) -> CompressionParams

The number of iterations searching for kmeans centers (both VQ & PQ phases).

pub fn set_vq_kmeans_trainset_fraction( self, vq_kmeans_trainset_fraction: f64, ) -> CompressionParams

The fraction of data to use during iterative kmeans building (VQ phase). When zero, an optimal value is selected using a heuristic.

pub fn set_pq_kmeans_trainset_fraction( self, pq_kmeans_trainset_fraction: f64, ) -> CompressionParams

The fraction of data to use during iterative kmeans building (PQ phase). When zero, an optimal value is selected using a heuristic.

Trait Implementations

impl Debug for CompressionParams

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

Formats the value using the given formatter.

impl Drop for CompressionParams

fn drop(&mut self)

Executes the destructor for this type.