Struct ReedSolomon 

pub struct ReedSolomon { /* private fields */ }

A (shortened) Reed–Solomon code over $\mathrm{GF}(2^{m})$ (see the module).

Implementations

impl ReedSolomon

pub fn new(m: u32, t: usize) -> Result<ReedSolomon>

The $t$-error-correcting code of length $2^{m} - 1$ over the field of the conventional primitive polynomial (primitive_polynomial), roots $\alpha, \dots, \alpha^{2t}$ ($b = 1$).

Errors

comnum_core::Error::Config for $m$ outside 2 to 16 or $2t \ge 2^{m} - 1$.

pub fn shortened(m: u32, t: usize, n: usize) -> Result<ReedSolomon>

The code of ReedSolomon::new shortened to n symbols.

Errors

comnum_core::Error::Config for $m$ outside 2 to 16 or a length that leaves no information symbol or exceeds $2^{m} - 1$.

pub fn with_field( m: u32, poly: u32, first_root: usize, root_step: usize, t: usize, n: usize, ) -> Result<ReedSolomon>

The code of n symbols correcting t errors over the field of the primitive polynomial poly (bit $i$ the coefficient of $x^{i}$), with the generator roots $\beta^{b}, \dots, \beta^{b+2t-1}$, $\beta = \alpha^{c}$: first_root is $b$ and root_step is $c$.

Errors

comnum_core::Error::Config for $m$ outside 2 to 16, a polynomial that is not primitive, a root step that is not coprime with $2^{m} - 1$, $t = 0$, or a length that leaves no information symbol or exceeds $2^{m} - 1$.

pub fn n_symbols(&self) -> usize

Codeword length $n$ in symbols (BlockCode::n counts the $nm$ bits).

pub fn k_symbols(&self) -> usize

Message length $k = n - 2t$ in symbols (BlockCode::k counts the $km$ bits).

pub fn t(&self) -> usize

Errors corrected $t$.

pub fn m(&self) -> u32

Bits per symbol $m$.

pub fn first_root(&self) -> usize

The first consecutive root $b$.

pub fn root_step(&self) -> usize

The root step $c$ ($\beta = \alpha^{c}$).

pub fn field(&self) -> &Field

The field.

pub fn generator(&self) -> &[u16]

The generator polynomial $g(x)$, lowest degree first (monic, degree $2t$).

pub fn encode_symbols(&self, msg: &[u16]) -> Result<Vec<u16>>

The codeword of $k$ message symbols: the message, then the $2t$ parity symbols (highest degree first).

Errors

comnum_core::Error::Shape for another number of symbols, comnum_core::Error::Config for a symbol that does not fit in $m$ bits.

pub fn decode_symbols(&self, r: &[u16]) -> Result<(Vec<u16>, Option<usize>)>

Decode $n$ received symbols: the message and the number of corrected symbols (None if the word has more errors than the code corrects and they were detected; the message symbols are then returned as received).

Errors

comnum_core::Error::Shape for another number of symbols, comnum_core::Error::Config for a symbol that does not fit in $m$ bits.

pub fn decode_erasures( &self, r: &[u16], erasures: &[usize], ) -> Result<(Vec<u16>, Option<usize>)>

Decode $n$ received symbols with the positions erasures (0 to $n - 1$, in transmission order) known to be unreliable: the message and the number of corrected symbols (erasures included), None for a decoding failure (more than $2t - s$ errors in the $n - s$ other positions, when detected; the message symbols are then returned as received).

Errors

comnum_core::Error::Shape for another number of symbols, comnum_core::Error::Config for a symbol that does not fit in $m$ bits, an erasure position outside the word, a repeated one, or more than $2t$ erasures.

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

The codeword of $km$ message bits as $nm$ bits ($m$ per symbol, most significant first): the message bits, then the parity.

Errors

comnum_core::Error::Shape for another number of bits.

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

Decode $nm$ hard bits: the $km$ message bits and the number of corrected symbols (None for a detected decoding failure, the message bits then returned as received).

Errors

comnum_core::Error::Shape for another number of bits.

Trait Implementations

impl BlockCode for ReedSolomon

fn decode_block(&self, llr: &[f64]) -> Result<Vec<u8>>

Hard decisions of the LLRs, then ReedSolomon::decode; a decoding failure returns the message bits as received.

fn k(&self) -> usize

Information bits per block.

fn n(&self) -> usize

Coded bits per block.

fn encode_block(&self, info: &[u8]) -> Result<Vec<u8>>

Encode one block of $k$ bits.

fn encode_block_into(&self, info: &[u8], out: &mut [u8]) -> Result<()>

Encode one block of $k$ bits into the $n$ values of out (ADR 0011: the default copies BlockCode::encode_block; a code overrides it when a profile shows the copy).

fn decode_block_into(&self, llr: &[f64], out: &mut [u8]) -> Result<()>

Decode one block of $n$ LLRs into the $k$ values of out (as BlockCode::encode_block_into).

fn code_rate(&self) -> f64

Code rate $k/n$.

fn encode_stream(&self, info: &[u8]) -> Result<Vec<u8>>

Encode whole blocks.

fn decode_stream(&self, llr: &[f64]) -> Result<Vec<u8>>

Decode whole blocks.

impl Clone for ReedSolomon

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 ReedSolomon

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

Formats the value using the given formatter.

impl Decode for ReedSolomon

fn decode_into(&mut self, llr: &Llr, out: &mut Bits) -> Result<()>

Decode llr into out.

fn decode(&mut self, llr: &Llr) -> Result<Bits, Error>

Decode llr (allocates, calls Decode::decode_into).

impl Encode for ReedSolomon

fn rate(&self) -> f64

Code rate k/n.

fn encode_into(&self, info: &Bits, out: &mut Bits) -> Result<()>

Encode info into out.

fn encode(&self, info: &Bits) -> Result<Bits, Error>

Encode info (allocates, calls Encode::encode_into).

impl Eq for ReedSolomon

impl PartialEq for ReedSolomon

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReedSolomon