Struct Sq8Code 

pub struct Sq8Code { /* private fields */ }

A scalar-quantized (SQ8) code: one u8 per dimension of the trained vector space.

Produced by Quantizer::quantize on a trained ScalarQuantizer. The byte at position i is the linear u8 encoding of the original f32 component under that dimension’s affine calibration; it is not useful on its own. Decode it with Quantizer::dequantize or compare it against a query through Quantizer::distance.

Examples

use iqdb_quantize::{Quantizer, ScalarQuantizer};

let mut sq = ScalarQuantizer::new();
sq.train(&[&[0.0_f32, 1.0][..], &[1.0_f32, 0.0][..]]).expect("ok");
let code = sq.quantize(&[0.5_f32, 0.5]).expect("ok");
assert_eq!(code.len(), 2);

Implementations

impl Sq8Code

pub fn len(&self) -> usize

Returns the dimension of the encoded vector (one byte per dimension).

Examples

use iqdb_quantize::{Quantizer, ScalarQuantizer};

let mut sq = ScalarQuantizer::new();
sq.train(&[&[0.0_f32, 1.0, 2.0][..]]).expect("ok");
let code = sq.quantize(&[0.5_f32, 0.5, 0.5]).expect("ok");
assert_eq!(code.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the code holds no bytes.

A Sq8Code produced by Quantizer::quantize on a trained ScalarQuantizer is never empty (empty inputs are rejected at the boundary); this method exists for API symmetry with Sq8Code::len.

Examples

use iqdb_quantize::{Quantizer, ScalarQuantizer};

let mut sq = ScalarQuantizer::new();
sq.train(&[&[0.0_f32, 1.0][..]]).expect("ok");
let code = sq.quantize(&[0.5_f32, 0.5]).expect("ok");
assert!(!code.is_empty());

pub fn as_bytes(&self) -> &[u8]

Borrow the raw u8 code bytes.

Examples

use iqdb_quantize::{Quantizer, ScalarQuantizer};

let mut sq = ScalarQuantizer::new();
sq.train(&[&[0.0_f32, 1.0][..]]).expect("ok");
let code = sq.quantize(&[0.5_f32, 0.5]).expect("ok");
assert_eq!(code.as_bytes().len(), 2);

Trait Implementations

impl Clone for Sq8Code

fn clone(&self) -> Sq8Code

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sq8Code

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

Formats the value using the given formatter.

impl Eq for Sq8Code

impl PartialEq for Sq8Code

fn eq(&self, other: &Sq8Code) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Sq8Code