Skip to main content

ScalarQuantizer

Struct ScalarQuantizer 

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

Scalar quantization (SQ8): f32 → u8

Maps each dimension independently to [0, 255] range based on min/max values from training data. Provides 4x memory reduction with minimal quality loss.

§Example

use foxstash_core::vector::quantize::{ScalarQuantizer, Quantizer};

// Fit quantizer on training data
let training_vectors = vec![
    vec![0.1, 0.5, 0.9],
    vec![0.2, 0.4, 0.8],
    vec![0.3, 0.6, 0.7],
];
let quantizer = ScalarQuantizer::fit(&training_vectors);

// Quantize new vectors
let query = vec![0.15, 0.45, 0.85];
let quantized = quantizer.quantize(&query);

// Compute distance efficiently
let db_vec = quantizer.quantize(&training_vectors[0]);
let distance = quantizer.distance_quantized(&quantized, &db_vec);

Implementations§

Source§

impl ScalarQuantizer

Source

pub fn fit(training_vectors: &[Vec<f32>]) -> Self

Fit quantizer parameters from training vectors

Computes min/max for each dimension across all training vectors.

§Panics

Panics if training vectors have inconsistent dimensions.

Source

pub fn with_bounds(dim: usize, min: f32, max: f32) -> Self

Create quantizer with known min/max bounds

Use this when you know the expected value range (e.g., normalized embeddings).

Source

pub fn for_normalized(dim: usize) -> Self

Create quantizer for normalized vectors ([-1, 1] range)

Source

pub fn dim(&self) -> usize

Get the dimensionality

Source

pub fn params(&self) -> &[ScalarQuantizationParams]

Get quantization parameters for analysis

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 Quantizer for ScalarQuantizer

Source§

type Quantized = ScalarQuantizedVector

Quantized representation type
Source§

fn quantize(&self, vector: &[f32]) -> Self::Quantized

Quantize a vector
Source§

fn dequantize(&self, quantized: &Self::Quantized) -> Vec<f32>

Dequantize back to f32 (lossy)
Source§

fn distance_quantized(&self, a: &Self::Quantized, b: &Self::Quantized) -> f32

Compute distance between quantized vectors (fast path)
Source§

fn distance_asymmetric(&self, query: &[f32], quantized: &Self::Quantized) -> f32

Compute distance between f32 query and quantized vector (asymmetric)
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

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