Struct Bch 

pub struct Bch { /* private fields */ }

A shortened binary BCH code (see the module).

Implementations

impl Bch

pub fn new(m: u32, poly: u32, t: usize, n: usize) -> Result<Bch>

The code of $\mathrm{GF}(2^{m})$ with the primitive polynomial poly (bit $i$ the coefficient of $x^{i}$), correcting t errors, shortened to n bits.

Errors

comnum_core::Error::Config for a polynomial that is not primitive, or a length that leaves no message bit or exceeds $2^{m} - 1$.

pub fn n(&self) -> usize

Codeword length $n$.

pub fn k(&self) -> usize

Message length $k = n - \deg g$.

pub fn t(&self) -> usize

Errors corrected $t$.

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

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

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

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

Errors

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

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

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

Errors

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

Trait Implementations

impl BlockCode for Bch

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

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

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 Bch

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 Bch

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

Formats the value using the given formatter.

impl Decode for Bch

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 Bch

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 Bch

impl PartialEq for Bch

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Bch