Struct Decoder

pub struct Decoder<M, R>
where
    M: Model,
    R: BitRead,
{ /* private fields */ }

An arithmetic decoder

An arithmetic decoder converts a stream of bytes into a stream of some output symbol, using a predictive Model.

Implementations

impl<M, R> Decoder<M, R>

where M: Model, R: BitRead,

pub fn new(model: M, input: R) -> Self

Construct a new Decoder

The ‘precision’ of the encoder is maximised, based on the number of bits needed to represent the Model::denominator. ‘precision’ bits is equal to u32::BITS - Model::denominator bits.

Panics

The calculation of the number of bits used for ‘precision’ is subject to the following constraints:

• The total available bits is u32::BITS
• The precision must use at least 2 more bits than that needed to represent Model::denominator

If these constraints cannot be satisfied this method will panic in debug builds

pub fn with_precision(model: M, input: R, precision: u32) -> Self

Construct a new Decoder with a custom precision

Panics

The calculation of the number of bits used for ‘precision’ is subject to the following constraints:

• The total available bits is BitStore::BITS
• The precision must use at least 2 more bits than that needed to represent Model::denominator

If these constraints cannot be satisfied this method will panic in debug builds

pub const fn with_state(state: State<M::B, R>, model: M) -> Self

todo

pub fn decode_all(&mut self) -> DecodeIter<'_, M, R>

Return an iterator over the decoded symbols.

The iterator will continue returning symbols until EOF is reached

pub fn decode(&mut self) -> Result<Option<M::Symbol>>

Read the next symbol from the stream of bits

This method will return Ok(None) when EOF is reached.

Errors

This method can fail if the underlying BitRead cannot be read from.

pub fn chain<X>(self, model: X) -> Decoder<X, R>

where X: Model<B = M::B>,

Reuse the internal state of the Decoder with a new model.

Allows for chaining multiple sequences of symbols from a single stream of bits

pub fn into_inner(self) -> (M, State<M::B, R>)

todo

Trait Implementations

impl<M, R> Debug for Decoder<M, R>

where M: Model + Debug, R: BitRead + Debug, M::B: Debug,

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

Formats the value using the given formatter.