Struct DataMeta 

#[repr(C)]
pub struct DataMeta {
    pub inner_product_correction: f16,
    pub metric_specific: f16,
    pub bit_sum: u16,
}

Metadata for correcting quantization for computing distances among quant vectors.

Fields

inner_product_correction: f16

This is the whole term

|X| * a / <x', x>

and represents the entires correction factor for computing inner products on the representation

bx + b

where bx is unsigned binary encoding of the vector and b (obtained from Self::offset_term) is the compression offset.

metric_specific: f16

A metric-specific correction term. Refer to the module level documentation to understand the implication of the terms outlined here.

| Squared L2 | |X|^2 | | Inner Product | <X', C> |

bit_sum: u16

Two times the sum of the ones in the binary representation of the transformed unit vector.

This is the term sum(bx) in the module level documentation.

Implementations

impl DataMeta

pub fn new( inner_product_correction: f32, metric_specific: f32, bit_sum: u32, ) -> Result<Self, DataMetaError>

Construct a new metadata from components.

This will internally convert the f32 values to f16.

pub fn to_full<A>(self, arch: A) -> DataMetaF32

where A: Architecture,

Convert the values in self to their full precision representation for computation.

Trait Implementations

impl Clone for DataMeta

fn clone(&self) -> DataMeta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataMeta

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

Formats the value using the given formatter.

impl Default for DataMeta

fn default() -> DataMeta

Returns the “default value” for a type.

impl PartialEq for DataMeta

fn eq(&self, other: &DataMeta) -> 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 Zeroable for DataMeta

fn zeroed() -> Self

Calls zeroed.

impl Copy for DataMeta

impl Pod for DataMeta

impl StructuralPartialEq for DataMeta