Struct ProductQuantizationIndex 

pub struct ProductQuantizationIndex { /* private fields */ }

The Product Quantization index.

Implementations

impl ProductQuantizationIndex

pub fn new(config: PqConfig) -> Result<Self>

Create a new (untrained) PQ index.

pub fn train(&mut self, training_data: &[Vec<f32>]) -> Result<()>

Train the codebooks using the provided training vectors.

pub fn is_trained(&self) -> bool

Whether the index has been trained.

pub fn add(&mut self, id: u64, vector: &[f32]) -> Result<()>

Add a vector with the given ID.

pub fn len(&self) -> usize

Number of indexed vectors.

pub fn is_empty(&self) -> bool

Whether the index is empty.

pub fn search(&self, query: &[f32], k: usize) -> Result<Vec<(u64, f32)>>

Search for the k nearest neighbours using asymmetric distance computation. Returns (id, approximate_distance) pairs sorted by ascending distance.

pub fn reconstruct(&self, id: u64) -> Result<Vec<f32>>

Reconstruct an approximate vector from its PQ codes.

pub fn clear(&mut self)

Remove all indexed vectors (keeps codebooks).

pub fn config(&self) -> &PqConfig

Get the PQ configuration.

pub fn compression_ratio(&self) -> f64

Compute the compression ratio (original bytes / encoded bytes).

Trait Implementations

impl Clone for ProductQuantizationIndex

fn clone(&self) -> ProductQuantizationIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProductQuantizationIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProductQuantizationIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProductQuantizationIndex

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

where __S: Serializer,

Serialize this value into the given Serde serializer.