Skip to main content

TurboQuantCodebook

selene_core::vector

Struct TurboQuantCodebook 

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

Deterministic scalar codebook for one TurboQuant vector dimension.

Implementations§

Source§

impl TurboQuantCodebook

Source

pub fn new( kind: TurboQuantCodebookKind, bit_width: TurboQuantBitWidth, dimension: usize, ) -> TurboQuantCodecResult<Self>

Build a deterministic codebook for kind, bit_width, and dimension.

§Errors

Returns an error when dimension is zero or exceeds MAX_VECTOR_DIMENSION.

Source

pub fn clipped_uniform( bit_width: TurboQuantBitWidth, dimension: usize, ) -> TurboQuantCodecResult<Self>

Build a clipped-uniform codebook.

§Errors

Returns an error when dimension is zero or exceeds MAX_VECTOR_DIMENSION.

Source

pub fn normal_lloyd_max( bit_width: TurboQuantBitWidth, dimension: usize, ) -> TurboQuantCodecResult<Self>

Build a normal Lloyd-Max codebook.

§Errors

Returns an error when dimension is zero or exceeds MAX_VECTOR_DIMENSION.

Source

pub const fn kind(&self) -> TurboQuantCodebookKind

Return the codebook family.

Source

pub const fn bit_width(&self) -> TurboQuantBitWidth

Return the bit width used by this codebook.

Source

pub const fn dimension(&self) -> usize

Return the vector dimension this codebook was calibrated for.

Source

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

Return the codebook centroids in ascending code order.

Source

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

Return midpoint boundaries between adjacent centroids.

Source

pub fn centroid(&self, code: u8) -> TurboQuantCodecResult<f32>

Return the centroid for code.

§Errors

Returns TurboQuantCodecError::InvalidCode when code exceeds this codebook’s bit width.

Source

pub fn encode_scalar(&self, value: f32) -> TurboQuantCodecResult<u8>

Quantize a finite scalar into a code by scanning codebook boundaries.

Values equal to a boundary choose the lower code, matching the lower-code tie break used by exact nearest-centroid scans.

§Errors

Returns TurboQuantCodecError::NonFiniteValue for NaN or infinity.

Source

pub fn estimated_bytes(&self) -> usize

Return an approximate heap allocation footprint for this codebook.

Trait Implementations§

Source§

impl Clone for TurboQuantCodebook

Source§

fn clone(&self) -> TurboQuantCodebook

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TurboQuantCodebook

Source§

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

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

impl PartialEq for TurboQuantCodebook

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for TurboQuantCodebook

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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.