Struct PQIndex 

pub struct PQIndex { /* private fields */ }

Enhanced Product Quantization index with residual and multi-codebook support

Implementations

impl PQIndex

pub fn new(config: PQConfig) -> Self

Create a new PQ index

pub fn train(&mut self, training_vectors: &[Vector]) -> Result<()>

Train the PQ index with training vectors

pub fn encode(&self, vector: &Vector) -> Result<Vec<u8>>

Public method to encode a vector (for OPQ)

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

Public method to decode codes (for OPQ)

pub fn reconstruct(&self, vector: &Vector) -> Result<Vector>

Reconstruct a vector by encoding and then decoding (for OPQ)

pub fn compression_ratio(&self) -> f32

Get compression ratio

pub fn stats(&self) -> PQStats

Get index statistics

pub fn is_trained(&self) -> bool

Check if the index is trained

pub fn compute_distance(&self, query: &Vector, codes: &[u8]) -> Result<f32>

Compute distance between query and encoded vector (for IVF compatibility)

pub fn decode_vector(&self, codes: &[u8]) -> Result<Vector>

Decode codes to vector (for IVF compatibility)

impl PQIndex

pub fn search(&self, query: &Vector, k: usize) -> Result<Vec<(String, f32)>>

Public search method for use by OPQ and other modules

Trait Implementations

impl Clone for PQIndex

fn clone(&self) -> PQIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PQIndex

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

Formats the value using the given formatter.

impl VectorIndex for PQIndex

fn insert(&mut self, uri: String, vector: Vector) -> Result<()>

Insert a vector with associated URI

fn search_knn(&self, query: &Vector, k: usize) -> Result<Vec<(String, f32)>>

Find k nearest neighbors

fn search_threshold( &self, query: &Vector, threshold: f32, ) -> Result<Vec<(String, f32)>>

Find all vectors within threshold similarity

fn get_vector(&self, _uri: &str) -> Option<&Vector>

Get a vector by its URI

fn add_vector( &mut self, id: VectorId, vector: Vector, _metadata: Option<HashMap<String, String>>, ) -> Result<()>

Add a vector with associated ID and metadata

fn update_vector(&mut self, id: VectorId, vector: Vector) -> Result<()>

Update an existing vector

fn update_metadata( &mut self, _id: VectorId, _metadata: HashMap<String, String>, ) -> Result<()>

Update metadata for a vector

fn remove_vector(&mut self, _id: VectorId) -> Result<()>

Remove a vector by its ID