Struct Grid 

pub struct Grid<'a, E: IntegerElement, Bd: Bound, const N: usize> { /* private fields */ }

Any lookup codec, of any code width.

The 16-entry i4 grid is Grid<16>; a 65536-entry one is Grid<65536>. The library carries no hardcoded table size, and no size is privileged.

The code space of an N-entry grid is Z/N, so an arbitrary u16 indexes it modulo N. That is not a clamp and not an error path: it is what “index into a table of N entries” means, and it is why this decode is total on all 2^16 codes (C6).

Implementations

impl<'a, E: IntegerElement, Bd: Bound, const N: usize> Grid<'a, E, Bd, N>

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

Borrow a decode table. The table is Alphabet<E, Bd>, so its image is in the alphabet by construction and there is nothing to validate.

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

The table.

Trait Implementations

impl<'a, E: Clone + IntegerElement, Bd: Clone + Bound, const N: usize> Clone for Grid<'a, E, Bd, N>

fn clone(&self) -> Grid<'a, E, Bd, N>

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> Codec<E, Bd> for Grid<'_, E, Bd, N>

const MAX_BLOCK: usize = 1

The most alphabet elements one code can produce.

const TIER: TierId = TierId::Grid

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

type Code = u16

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.

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_into(&self, code: Self::Code, out: &mut [Alphabet<E, Bd>]) -> usize

Decode one code, returning how many elements were written.

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> Copy for Grid<'a, E, Bd, N>

impl<'a, E: Debug + IntegerElement, Bd: Debug + Bound, const N: usize> Debug for Grid<'a, E, Bd, N>

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

Formats the value using the given formatter.

impl<E: IntegerElement, Bd: Bound, const N: usize> Enumerable<E, Bd> for Grid<'_, E, Bd, N>

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: &[u16]) -> 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.