vq 0.2.0

A vector quantization library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

//! Common traits for vector quantization algorithms.

use crate::core::error::VqResult;

/// A trait representing a vector quantizer.
///
/// All quantization algorithms implement this trait, providing a uniform
/// interface for encoding vectors into compact representations and
/// reconstructing approximate vectors from those representations.
///
/// # Type Parameters
///
/// * `QuantizedOutput` - The type of the quantized representation (e.g., `Vec<u8>`, `Vec<f16>`)
///
/// # Example
///
/// ```rust
/// use vq::{Quantizer, VqResult};
/// use vq::sq::ScalarQuantizer;
///
/// fn quantize_and_reconstruct<Q: Quantizer>(
///     quantizer: &Q,
///     vector: &[f32],
/// ) -> VqResult<Vec<f32>> {
///     let quantized = quantizer.quantize(vector)?;
///     quantizer.dequantize(&quantized)
/// }
/// ```
pub trait Quantizer {
    /// The output type of the quantization process.
    type QuantizedOutput;

    /// Quantizes a vector into a compact representation.
    ///
    /// # Arguments
    ///
    /// * `vector` - The input vector to quantize
    ///
    /// # Returns
    ///
    /// The quantized representation of the input vector
    ///
    /// # Errors
    ///
    /// Returns an error if the input vector has an invalid dimension or
    /// other algorithm-specific validation fails.
    fn quantize(&self, vector: &[f32]) -> VqResult<Self::QuantizedOutput>;

    /// Reconstructs an approximate vector from its quantized representation.
    ///
    /// # Arguments
    ///
    /// * `quantized` - The quantized representation to decode
    ///
    /// # Returns
    ///
    /// An approximate reconstruction of the original vector
    ///
    /// # Errors
    ///
    /// Returns an error if the quantized representation is invalid.
    fn dequantize(&self, quantized: &Self::QuantizedOutput) -> VqResult<Vec<f32>>;
}