Skip to main content

CodecConfig

Struct CodecConfig 

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

Immutable configuration snapshot that fully determines codec behavior.

Two configs with identical primary fields are interchangeable. The cached config_hash is computed eagerly in CodecConfig::new and ignored by PartialEq / Hash so semantically equal configs compare equal regardless of which instance owns the Arc<str>.

Implementations§

Source§

impl CodecConfig

Source

pub fn new( bit_width: u8, seed: u64, dimension: u32, residual_enabled: bool, ) -> Result<Self, CodecError>

Validate the field invariants and return a new CodecConfig.

§Errors
Source

pub const fn bit_width(&self) -> u8

The bit width of the quantized indices.

Source

pub const fn seed(&self) -> u64

The seed used for deterministic rotation and codebook generation.

Source

pub const fn dimension(&self) -> u32

The expected input vector dimensionality.

Source

pub const fn residual_enabled(&self) -> bool

Whether stage-2 residual correction is enabled.

Source

pub const fn num_codebook_entries(&self) -> u32

2^bit_width — the number of quantization levels in the codebook.

Source

pub const fn config_hash(&self) -> &ConfigHash

Cached SHA-256 hex digest of the canonical string representation.

Returned as an Arc<str> borrow; clone with .clone() for owned use.

Trait Implementations§

Source§

impl Clone for CodecConfig

Source§

fn clone(&self) -> CodecConfig

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 CodecConfig

Source§

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

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

impl Hash for CodecConfig

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CodecConfig

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Eq for CodecConfig

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

Source§

type Output = T

Should always be Self
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