Skip to main content

EntropyConstrainedQuantizer

Struct EntropyConstrainedQuantizer 

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

Lagrangian Rate-Distortion optimal scalar quantizer.

Minimizes D + λ·R where D is MSE distortion and R is empirical entropy. Implements an entropy-regularized Lloyd-Max algorithm:

  1. Initialize bin edges from equal-mass (percentile) split of the signal.
  2. Iterate:
    • Centroid update: recon[i] = mean of samples assigned to bin i.
    • Entropy-regularized edge update: edge[i] = 0.5·(recon[i-1]+recon[i]) + (λ/(recon[i]-recon[i-1]))·(ln p[i-1] − ln p[i])
    • Clamp edges to be strictly monotonic.
    • Recompute empirical probabilities.
    • Evaluate cost = D + λ·R and stop when Δcost < tol.

Implementations§

Source§

impl EntropyConstrainedQuantizer

Source

pub fn new( bin_edges: Vec<f32>, reconstruction_values: Vec<f32>, lambda: f32, ) -> Self

Construct directly from pre-computed edges and reconstruction values.

Uniform prior probabilities are assumed until fit_lagrangian is called.

Source

pub fn fit_lagrangian( signal: &Array1<f32>, num_levels: usize, lambda: f32, max_iters: usize, tol: f32, ) -> TokenizerResult<Self>

Fit ECQ via entropy-regularized Lloyd-Max iteration.

Returns Err if num_levels < 2 or the signal is too short.

§Arguments
  • signal – Input signal samples.
  • num_levels – Number of quantization bins (≥ 2).
  • lambda – Lagrange multiplier; larger → more compression, less fidelity.
  • max_iters – Maximum Lloyd-Max iterations.
  • tol – Convergence threshold on |Δcost|.
Source

pub fn encode_compressed( &self, signal: &Array1<f32>, ) -> TokenizerResult<(Vec<u8>, u64)>

Compress signal using Huffman coding built from the fitted bin probabilities.

Returns (compressed_bytes, symbol_count). The symbol_count is needed for lossless decompression.

Source

pub fn decode_compressed( &self, bytes: &[u8], _symbol_count: u64, ) -> TokenizerResult<Array1<f32>>

Decompress bytes produced by encode_compressed back to a signal.

The symbol_count must match the value returned by encode_compressed.

Source

pub fn fit_with_target_rate( signal: &Array1<f32>, num_levels: usize, target_bpp: f64, max_outer_iters: usize, ) -> TokenizerResult<Self>

Fit ECQ using binary search over λ to hit a target entropy rate.

§Arguments
  • signal – Training signal.
  • num_levels – Number of quantization bins.
  • target_bpp – Desired bits per symbol.
  • max_outer_iters – Number of λ bisection steps.
Source

pub fn compute_entropy_rate(&self, signal: &Array1<f32>) -> f64

Compute empirical Shannon entropy (bits/symbol) of the signal under this quantizer’s bin partition.

Source

pub fn empirical_distortion(&self, signal: &Array1<f32>) -> f64

Compute mean-squared distortion of the signal under this quantizer.

Source

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

Return a reference to the interior bin edges.

Source

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

Return a reference to the reconstruction values.

Source

pub fn lambda(&self) -> f32

Return the Lagrange multiplier used during fitting.

Source

pub fn target_bits_per_symbol(&self) -> Option<f64>

Return the optional target bits-per-symbol set by fit_with_target_rate.

Trait Implementations§

Source§

impl Quantizer for EntropyConstrainedQuantizer

Source§

fn quantize(&self, value: f32) -> i32

Quantize a continuous value to discrete level
Source§

fn dequantize(&self, level: i32) -> f32

Dequantize a discrete level back to continuous value
Source§

fn num_levels(&self) -> usize

Get number of quantization levels
Source§

impl SignalTokenizer for EntropyConstrainedQuantizer

Source§

fn encode(&self, signal: &Array1<f32>) -> TokenizerResult<Array1<f32>>

Encode a continuous signal into tokens/embeddings
Source§

fn decode(&self, tokens: &Array1<f32>) -> TokenizerResult<Array1<f32>>

Decode tokens/embeddings back to continuous signal
Source§

fn embed_dim(&self) -> usize

Get the embedding dimension
Source§

fn vocab_size(&self) -> usize

Get the vocabulary size (for discrete tokenizers, 0 for continuous)

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> BatchTokenizer for T
where T: SignalTokenizer,

Source§

fn encode_batch(&self, signals: &Array2<f32>) -> TokenizerResult<Array2<f32>>

Encode multiple signals in batch Read more
Source§

fn decode_batch(&self, tokens: &Array2<f32>) -> TokenizerResult<Array2<f32>>

Decode multiple token sequences in batch Read more
Source§

fn encode_batch_padded_to( &self, signals: &[Array1<f32>], target_len: usize, ) -> TokenizerResult<Array2<f32>>

Encode batch with padding to handle variable length signals 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,