Skip to main content

FibQuantProfileV1

fib_quant::profile

Struct FibQuantProfileV1

pub struct FibQuantProfileV1 {Show 19 fields
    pub schema_version: String,
    pub ambient_dim: u32,
    pub block_dim: u32,
    pub codebook_size: u32,
    pub paper_rate_bits_per_coord: f64,
    pub wire_index_bits: u8,
    pub wire_bits_per_coord: f64,
    pub norm_format: NormFormat,
    pub rotation_seed: u64,
    pub rotation_algorithm_version: String,
    pub codebook_seed: u64,
    pub codebook_version: String,
    pub source_mode: SourceMode,
    pub radius_method: RadiusMethod,
    pub direction_method: DirectionMethod,
    pub lloyd_restarts: u32,
    pub lloyd_iterations: u32,
    pub training_samples: u32,
    pub empty_cell_policy: EmptyCellPolicy,
}

Expand description

Stable profile for paper-faithful FibQuant codebooks and payloads.

Fields§

§schema_version: String

Stable schema marker.

§ambient_dim: u32

Ambient vector dimension d.

§block_dim: u32

Block dimension k.

§codebook_size: u32

Codebook size N.

§paper_rate_bits_per_coord: f64

Paper dense rate log2(N) / k.

§wire_index_bits: u8

Practical fixed-rate index width ceil(log2(N)).

§wire_bits_per_coord: f64

Practical wire rate wire_index_bits / k.

§norm_format: NormFormat

Norm header format.

§rotation_seed: u64

Seed for ambient rotation.

§rotation_algorithm_version: String

Rotation generation algorithm identity.

§codebook_seed: u64

Seed for codebook construction and Lloyd training.

§codebook_version: String

Codebook algorithm/version string.

§source_mode: SourceMode

Training source mode.

§radius_method: RadiusMethod

Radius method.

§direction_method: DirectionMethod

Direction method.

§lloyd_restarts: u32

Number of Lloyd restarts.

§lloyd_iterations: u32

Number of Lloyd iterations per restart.

§training_samples: u32

Number of training samples.

§empty_cell_policy: EmptyCellPolicy

Empty-cell repair policy.

Implementations§

impl FibQuantProfileV1

pub fn paper_default( ambient_dim: usize, block_dim: usize, codebook_size: usize, seed: u64, ) -> Result<Self>

Build a validated paper profile with method choices derived from k.

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

Validate the complete profile.

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

Stable digest over all explicit profile fields.

pub fn block_count(&self) -> u32

Number of k-blocks per vector.

Trait Implementations§

impl Clone for FibQuantProfileV1

fn clone(&self) -> FibQuantProfileV1

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 FibQuantProfileV1

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for FibQuantProfileV1

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 FibQuantProfileV1

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

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 FibQuantProfileV1

Auto Trait Implementations§

impl Freeze for FibQuantProfileV1

impl RefUnwindSafe for FibQuantProfileV1

impl Send for FibQuantProfileV1

impl Sync for FibQuantProfileV1

impl Unpin for FibQuantProfileV1

impl UnsafeUnpin for FibQuantProfileV1

impl UnwindSafe for FibQuantProfileV1

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,