Struct Ccdm 

pub struct Ccdm { /* private fields */ }

A constant-composition distribution matcher (see the module).

Implementations

impl Ccdm

pub fn new(composition: Vec<usize>) -> Result<Ccdm>

The matcher of a composition: composition[a] occurrences of symbol a.

Errors

comnum_core::Error::Config for an empty composition or one that carries no bit.

pub fn from_distribution(p: &[f64], n: usize) -> Result<Ccdm>

The matcher of blocks of n symbols whose composition is the nearest to the distribution p (largest remainders: ⌊n p_a⌋, then one more for the largest remainders until the sum is n).

Errors

comnum_core::Error::Config for probabilities that are not non-negative with a positive sum, and as Ccdm::new.

pub fn composition(&self) -> &[usize]

The composition.

pub fn n(&self) -> usize

Symbols per block $n$.

pub fn k(&self) -> usize

Bits per block $k$.

pub fn rate(&self) -> f64

The rate $k/n$ (bits per symbol).

pub fn distribution(&self) -> Vec<f64>

The distribution of the symbols, $n_{a}/n$.

pub fn match_bits(&self, bits: &[u8]) -> Result<Vec<usize>>

The sequence of $n$ symbols of bits ($k$ bits, the rank, most significant first).

Errors

comnum_core::Error::Shape if bits does not have $k$ bits.

pub fn dematch(&self, symbols: &[usize]) -> Result<Vec<u8>>

The $k$ bits of a sequence of $n$ symbols (its rank, most significant first); a symbol the composition has used up is replaced by the nearest available one.

Errors

comnum_core::Error::Shape if symbols does not have $n$ symbols.

Trait Implementations

impl Clone for Ccdm

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ccdm

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

Formats the value using the given formatter.

impl Eq for Ccdm

impl PartialEq for Ccdm

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Ccdm