Skip to main content

FibCodebookV1

fib_quant::codebook

Struct FibCodebookV1

pub struct FibCodebookV1 {
    pub schema_version: String,
    pub profile: FibQuantProfileV1,
    pub profile_digest: String,
    pub codebook_digest: String,
    pub rotation_digest: String,
    pub codewords: Vec<f32>,
    pub init_mse: f64,
    pub training_mse: f64,
    pub refinement_report: LloydReportV1,
}

Expand description

Persisted FibQuant codebook in row-major codeword order.

Fields§

§schema_version: String

Stable schema marker.

§profile: FibQuantProfileV1

Profile used to create this codebook.

§profile_digest: String

Digest of profile.

§codebook_digest: String

Digest of profile, report, and row-major codewords.

§rotation_digest: String

Digest of deterministic ambient rotation identity and matrix.

§codewords: Vec<f32>

Row-major N x k f32 codeword storage.

§init_mse: f64

Initial codebook training MSE before Lloyd-Max.

§training_mse: f64

Best training MSE after Lloyd-Max.

§refinement_report: LloydReportV1

Lloyd-Max refinement receipt.

Implementations§

impl FibCodebookV1

pub fn build(profile: FibQuantProfileV1) -> Result<Self>

Build a full refined codebook for a profile.

pub fn validate(&self) -> Result<()>

Validate shape and digest fields.

pub fn codeword(&self, index: usize) -> Result<Vec<f64>>

Return codeword index as f64 values.

pub fn compute_digest(&self) -> Result<String>

Deterministic codebook digest.

Trait Implementations§

impl Clone for FibCodebookV1

fn clone(&self) -> FibCodebookV1

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

impl Debug for FibCodebookV1

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for FibCodebookV1

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for FibCodebookV1

fn eq(&self, other: &FibCodebookV1) -> 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.

impl Serialize for FibCodebookV1

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for FibCodebookV1

Auto Trait Implementations§

impl Freeze for FibCodebookV1

impl RefUnwindSafe for FibCodebookV1

impl Send for FibCodebookV1

impl Sync for FibCodebookV1

impl Unpin for FibCodebookV1

impl UnsafeUnpin for FibCodebookV1

impl UnwindSafe for FibCodebookV1

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,