Struct lance_index::vector::sq::ScalarQuantizer

pub struct ScalarQuantizer {
    pub num_bits: u16,
    pub dim: usize,
    pub metric_type: MetricType,
    pub bounds: Range<f64>,
}

Scalar Quantization, optimized for [Apache Arrow] buffer memory layout.

Fields

num_bits: u16

Number of bits for the centroids.

Only support 8, as one of u8 byte now.

dim: usize

Original dimension of the vectors.

metric_type: MetricType

Distance type.

bounds: Range<f64>

Implementations

impl ScalarQuantizer

pub fn new(num_bits: u16, dim: usize, metric_type: MetricType) -> Self

pub fn with_bounds( num_bits: u16, dim: usize, metric_type: MetricType, bounds: Range<f64> ) -> Self

pub fn num_bits(&self) -> u16

pub fn update_bounds<T: ArrowFloatType>( &mut self, vectors: &FixedSizeListArray ) -> Result<Range<f64>>

pub fn transform<T: ArrowFloatType>(&self, data: &dyn Array) -> Result<ArrayRef>

pub fn bounds(&self) -> Range<f64>

pub fn use_residual(&self) -> bool

Whether to use residual as input or not.

Trait Implementations

impl Clone for ScalarQuantizer

fn clone(&self) -> ScalarQuantizer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScalarQuantizer

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

Formats the value using the given formatter.

impl Quantization for ScalarQuantizer

type Metadata = ScalarQuantizationMetadata

type Storage = ScalarQuantizationStorage

fn code_dim(&self) -> usize

fn column(&self) -> &'static str

fn metadata_key(&self) -> &'static str

fn quantization_type(&self) -> QuantizationType

fn metadata(&self, _: Option<QuantizationMetadata>) -> Result<Value>