Struct Book 

pub struct Book<'a, E: IntegerElement, Bd: Bound, const N: usize, const BLK: usize, K: SymbolCode = u16> { /* private fields */ }

Any codebook: N entries of BLK alphabet elements each.

E8 is Book<256, 8>. Nothing privileges that shape; BLK and N are parameters, and no quality claim attaches to any table (N3).

Implementations

impl<'a, E: IntegerElement, Bd: Bound, const N: usize, const BLK: usize, K: SymbolCode> Book<'a, E, Bd, N, BLK, K>

pub const fn new(table: &'a [[Alphabet<E, Bd>; BLK]; N]) -> Self

Borrow a codebook. On an embedded target this is a pointer into flash.

pub const fn table(&self) -> &'a [[Alphabet<E, Bd>; BLK]; N]

The codebook.

Trait Implementations

impl<'a, E: Clone + IntegerElement, Bd: Clone + Bound, const N: usize, const BLK: usize, K: Clone + SymbolCode> Clone for Book<'a, E, Bd, N, BLK, K>

fn clone(&self) -> Book<'a, E, Bd, N, BLK, K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: IntegerElement, Bd: Bound, const N: usize, const BLK: usize, K: SymbolCode> Codec<E, Bd> for Book<'_, E, Bd, N, BLK, K>

const MAX_BLOCK: usize = BLK

The most alphabet elements one code can produce.

const TIER: TierId = TierId::Book

Which tier this is, for reports and for the kappa manifest.

type Code = K

The stored code type.

fn decode_element(&self, code: Self::Code, i: usize) -> Alphabet<E, Bd>

Decode element i of the block code names. Total for every i.

fn decode_into(&self, code: Self::Code, out: &mut [Alphabet<E, Bd>]) -> usize

Decode one code, returning how many elements were written.

const IS_FIXED_WIDTH: bool = true

Is decode_len always MAX_BLOCK?

fn decode_len(&self, _code: Self::Code) -> usize

How many elements code actually produces.

fn decode_seq(&self, codes: &[Self::Code], out: &mut [Alphabet<E, Bd>]) -> usize

Bulk path, returning how many elements were written in total.

impl<'a, E: Copy + IntegerElement, Bd: Copy + Bound, const N: usize, const BLK: usize, K: Copy + SymbolCode> Copy for Book<'a, E, Bd, N, BLK, K>

impl<'a, E: Debug + IntegerElement, Bd: Debug + Bound, const N: usize, const BLK: usize, K: Debug + SymbolCode> Debug for Book<'a, E, Bd, N, BLK, K>

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

Formats the value using the given formatter.

impl<E: IntegerElement, Bd: Bound, const N: usize, const BLK: usize, K: SymbolCode> Enumerable<E, Bd> for Book<'_, E, Bd, N, BLK, K>

const CODE_SPACE: usize

The number of distinct codes.

fn code_at(index: usize) -> Self::Code

The index-th code. Total for index < CODE_SPACE.

fn index_of(code: Self::Code) -> usize

Where code sits in the enumeration.

fn as_index_stream(codes: &[K]) -> Option<IndexStream<'_>>

The stored code stream, read as the index stream it already is.

const SIGN_BIT_BOOK: bool = false

Whether the decoded book is the sign bit-decomposition: CODE_SPACE is a power of two and book[c][t] == 2 * bit(c, t) - 1 for every code c and every t below its log.