Skip to main content

ScalarQuantizer

Struct ScalarQuantizer 

Source
pub struct ScalarQuantizer { /* private fields */ }
Expand description

Scalar quantizer: f32 -> u8 with per-dimension min/max scaling.

Training learns the min/max value for each dimension, then quantizes values to [0, 255] range. This achieves 4x compression with typically

97% recall retention.

§Example

use grafeo_core::index::vector::quantization::ScalarQuantizer;

// Training vectors
let vectors = vec![
    vec![0.0f32, 0.5, 1.0],
    vec![0.2, 0.3, 0.8],
    vec![0.1, 0.6, 0.9],
];

// Train quantizer
let refs: Vec<&[f32]> = vectors.iter().map(|v| v.as_slice()).collect();
let quantizer = ScalarQuantizer::train(&refs);

// Quantize a vector
let quantized = quantizer.quantize(&[0.1, 0.4, 0.85]);
assert_eq!(quantized.len(), 3);

// Compute approximate distance
let q2 = quantizer.quantize(&[0.15, 0.45, 0.9]);
let dist = quantizer.distance_squared_u8(&quantized, &q2);
assert!(dist < 1000.0);

Implementations§

Source§

impl ScalarQuantizer

Source

pub fn train(vectors: &[&[f32]]) -> Self

Trains a scalar quantizer from sample vectors.

Learns the min/max value per dimension from the training data. The more representative the training data, the better the quantization.

§Arguments
  • vectors - Training vectors (should be representative of the dataset)
§Panics

Panics if vectors is empty or if vectors have different dimensions.

Source

pub fn with_ranges(min: Vec<f32>, max: Vec<f32>) -> Self

Creates a quantizer with explicit ranges (useful for testing).

Source

pub fn dimensions(&self) -> usize

Returns the number of dimensions.

Source

pub fn min_values(&self) -> &[f32]

Returns the min values per dimension.

Source

pub fn quantize(&self, vector: &[f32]) -> Vec<u8>

Quantizes an f32 vector to u8.

Values are clamped to the learned [min, max] range.

Source

pub fn quantize_batch(&self, vectors: &[&[f32]]) -> Vec<Vec<u8>>

Quantizes multiple vectors in batch.

Source

pub fn dequantize(&self, quantized: &[u8]) -> Vec<f32>

Dequantizes a u8 vector back to f32 (approximate).

Source

pub fn distance_squared_u8(&self, a: &[u8], b: &[u8]) -> f32

Computes squared Euclidean distance between quantized vectors.

This is an approximation that works well for ranking nearest neighbors. The returned distance is scaled back to the original space.

Source

pub fn distance_u8(&self, a: &[u8], b: &[u8]) -> f32

Computes Euclidean distance between quantized vectors.

Source

pub fn cosine_distance_u8(&self, a: &[u8], b: &[u8]) -> f32

Computes approximate cosine distance using quantized vectors.

This is less accurate than exact computation but much faster.

Source

pub fn asymmetric_distance_squared( &self, query: &[f32], quantized: &[u8], ) -> f32

Computes distance between a f32 query and a quantized vector.

This is useful for search where we keep the query in full precision.

Source

pub fn asymmetric_distance(&self, query: &[f32], quantized: &[u8]) -> f32

Computes asymmetric Euclidean distance.

Trait Implementations§

Source§

impl Clone for ScalarQuantizer

Source§

fn clone(&self) -> ScalarQuantizer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ScalarQuantizer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ScalarQuantizer

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ScalarQuantizer

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,