Enum CheckRule 

#[non_exhaustive]
pub enum CheckRule {
    SumProduct,
    NormalizedMinSum(f64),
    OffsetMinSum(f64),
}

The check-node rule of the decoder.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

SumProduct

Sum-product (belief propagation, exact).

NormalizedMinSum(f64)

Min-sum scaled by $\alpha$ (1 for plain min-sum, 0.75 to 0.8 typically).

OffsetMinSum(f64)

Min-sum with the offset $\beta$ subtracted from the magnitudes.

Implementations

impl CheckRule

pub fn from_name(rule: &str, alpha: f64) -> Result<CheckRule>

The rule of a name: sum_product, min_sum (plain), normalized_min_sum (scaled by alpha) or offset_min_sum (offset alpha), case-insensitive.

Errors

Error::Config for another name.

pub fn name(self) -> &'static str

The name of the rule, as CheckRule::from_name reads it (min_sum is the normalised min-sum of scale 1).

Examples

use comnum_fec::ldpc::{CheckRule, DEFAULT_RULE};
assert_eq!(DEFAULT_RULE.name(), "sum_product");
assert_eq!(CheckRule::from_name("min_sum", 0.5)?.name(), "normalized_min_sum");

Trait Implementations

impl Clone for CheckRule

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CheckRule

impl Debug for CheckRule

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

Formats the value using the given formatter.

impl PartialEq for CheckRule

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CheckRule