Struct Decoder

pub struct Decoder<A: DecoderArithmetic> { /* private fields */ }

LDPC belief propagation flooding decoder.

Implementations

impl<A: DecoderArithmetic> Decoder<A>

pub fn new(h: SparseMatrix, arithmetic: A) -> Self

Creates a new flooding LDPC decoder.

The parameter h indicates the parity check matrix.

pub fn decode( &mut self, llrs: &[f64], max_iterations: usize, ) -> Result<DecoderOutput, DecoderOutput>

Decodes a codeword.

The parameters are the LLRs for the received codeword and the maximum number of iterations to perform. If decoding is successful, the function returns an Ok containing the (hard decision) on the decoded codeword and the number of iterations used in decoding. If decoding is not successful, the function returns an Err containing the hard decision on the final decoder LLRs (which still has some bit errors) and the number of iterations used in decoding (which is equal to max_iterations).

Trait Implementations

impl<A: Clone + DecoderArithmetic> Clone for Decoder<A>

where A::Llr: Clone, A::CheckMessage: Clone, A::VarMessage: Clone,

fn clone(&self) -> Decoder<A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug + DecoderArithmetic> Debug for Decoder<A>

where A::Llr: Debug, A::CheckMessage: Debug, A::VarMessage: Debug,

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

Formats the value using the given formatter.

impl<A: DecoderArithmetic> LdpcDecoder for Decoder<A>

fn decode( &mut self, llrs: &[f64], max_iterations: usize, ) -> Result<DecoderOutput, DecoderOutput>

Decodes a codeword.

impl<A: PartialEq + DecoderArithmetic> PartialEq for Decoder<A>

where A::Llr: PartialEq, A::CheckMessage: PartialEq, A::VarMessage: PartialEq,

fn eq(&self, other: &Decoder<A>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A: DecoderArithmetic> StructuralPartialEq for Decoder<A>