Struct constriction::stream::model::UniformModel

pub struct UniformModel<Probability: BitArray, const PRECISION: usize> { /* private fields */ }

Implementations

impl<Probability: BitArray, const PRECISION: usize> UniformModel<Probability, PRECISION>

pub fn new(range: usize) -> Self

where usize: AsPrimitive<Probability>, Probability: AsPrimitive<usize>,

Trait Implementations

impl<Probability: Clone + BitArray, const PRECISION: usize> Clone for UniformModel<Probability, PRECISION>

where Probability::NonZero: Clone,

fn clone(&self) -> UniformModel<Probability, PRECISION>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Probability: Debug + BitArray, const PRECISION: usize> Debug for UniformModel<Probability, PRECISION>

where Probability::NonZero: Debug,

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

Formats the value using the given formatter.

impl<Probability, const PRECISION: usize> DecoderModel<PRECISION> for UniformModel<Probability, PRECISION>

where Probability: AsPrimitive<usize> + BitArray,

fn quantile_function( &self, quantile: Self::Probability, ) -> (Self::Symbol, Self::Probability, <Self::Probability as BitArray>::NonZero)

Looks up the symbol for a given quantile.

impl<Probability: BitArray, const PRECISION: usize> EncoderModel<PRECISION> for UniformModel<Probability, PRECISION>

where usize: AsPrimitive<Probability>,

fn left_cumulative_and_probability( &self, symbol: impl Borrow<Self::Symbol>, ) -> Option<(Self::Probability, <Self::Probability as BitArray>::NonZero)>

Looks up a symbol in the entropy model.

fn floating_point_probability<F>(&self, symbol: Self::Symbol) -> F

where F: FloatCore, Self::Probability: Into<F>,

Returns the probability of the given symbol in floating point representation.

impl<Probability: BitArray, const PRECISION: usize> EntropyModel<PRECISION> for UniformModel<Probability, PRECISION>

type Symbol = usize

The type of data over which the entropy model is defined.

type Probability = Probability

The type used to represent probabilities, cumulatives, and quantiles.

impl<'m, Probability, const PRECISION: usize> IterableEntropyModel<'m, PRECISION> for UniformModel<Probability, PRECISION>

where Probability: AsPrimitive<usize> + BitArray, usize: AsPrimitive<Probability>,

fn symbol_table( &'m self, ) -> impl Iterator<Item = (Self::Symbol, Self::Probability, <Self::Probability as BitArray>::NonZero)>

Iterates over all symbols in the unique order that is consistent with the cumulative distribution.

fn floating_point_symbol_table<F>( &'m self, ) -> impl Iterator<Item = (Self::Symbol, F, F)>

where F: FloatCore + From<Self::Probability> + 'm, Self::Probability: Into<F>,

Similar to symbol_table, but yields both cumulatives and probabilities in floating point representation.

fn entropy_base2<F>(&'m self) -> F

where F: Float + Sum, Self::Probability: Into<F>,

Returns the entropy in units of bits (i.e., base 2).

fn cross_entropy_base2<F>(&'m self, p: impl IntoIterator<Item = F>) -> F

where F: Float + Sum, Self::Probability: Into<F>,

Returns the cross entropy between argument p and this model in units of bits (i.e., base 2).

fn reverse_cross_entropy_base2<F>(&'m self, p: impl IntoIterator<Item = F>) -> F

where F: Float + Sum, Self::Probability: Into<F>,

Returns the cross entropy between this model and argument p in units of bits (i.e., base 2).

fn kl_divergence_base2<F>(&'m self, p: impl IntoIterator<Item = F>) -> F

where F: Float + Sum, Self::Probability: Into<F>,

Returns Kullback-Leibler divergence D_KL(p || self)

fn reverse_kl_divergence_base2<F>(&'m self, p: impl IntoIterator<Item = F>) -> F

where F: Float + Sum, Self::Probability: Into<F>,

Returns reverse Kullback-Leibler divergence, i.e., D_KL(self || p)

impl<Probability: Copy + BitArray, const PRECISION: usize> Copy for UniformModel<Probability, PRECISION>

where Probability::NonZero: Copy,