rvf-quant 0.2.0

RuVector Format temperature-tiered vector quantization (f32/f16/u8/binary)
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

//! Common quantization trait shared by all quantizer types.

use crate::tier::TemperatureTier;
use alloc::vec::Vec;

/// Trait for vector quantization codecs.
///
/// Every quantizer can encode a float vector into a compact byte representation
/// and decode it back to an approximate float vector.
///
/// The `Any` supertrait allows codecs to recover the concrete quantizer type
/// (e.g. for serializing its parameters) via trait upcasting.
pub trait Quantizer: core::any::Any {
    /// Encode a float vector into compact codes.
    fn encode(&self, vector: &[f32]) -> Vec<u8>;

    /// Decode compact codes back to an approximate float vector.
    fn decode(&self, codes: &[u8]) -> Vec<f32>;

    /// The temperature tier this quantizer is designed for.
    fn tier(&self) -> TemperatureTier;

    /// The dimensionality this quantizer was trained for.
    fn dim(&self) -> usize;
}