Struct ldpc_toolbox::mackay_neal::Config

pub struct Config {
    pub nrows: usize,
    pub ncols: usize,
    pub wr: usize,
    pub wc: usize,
    pub backtrack_cols: usize,
    pub backtrack_trials: usize,
    pub min_girth: Option<usize>,
    pub girth_trials: usize,
    pub fill_policy: FillPolicy,
}

Configuration for the MacKay-Neal construction.

This configuration is used to set the parameters of the LDPC code to construct as well as some options that affect the exectution of the algorithm.

Fields

nrows: usize

Number of rows of the parity check matrix.

ncols: usize

Number of columns of the parity check matrix.

wr: usize

Maximum row weight of the parity check matrix.

wc: usize

Column weight of the parity check matrix.

backtrack_cols: usize

Number of columns to backtrack when there are not enough available columns with weight smaller than the maximum row weight.

backtrack_trials: usize

Number of times to attempt backtracking before aborting.

min_girth: Option<usize>

Minimum girth of the Tanner graph; None indicates that no constraints are imposed on the girth.

girth_trials: usize

Number of times to re-try generating a column to satisfy the minimum girth constraint before aborting.

fill_policy: FillPolicy

Policy used to select the rows to fill.

Implementations

impl Config

pub fn run(&self, seed: u64) -> Result<SparseMatrix>

Runs the MacKay-Neal algorith using a random seed seed.

pub fn search( &self, start_seed: u64, max_tries: u64 ) -> Option<(u64, SparseMatrix)>

Searches for a seed for a successful MacKay-Neal construction by trying several seeds.

The search is performed in parallel using a parallel iterator from the rayon crate. This function returns the successful seed and the corresponding parity check matrix, if one is found, or None otherwise.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl PartialEq<Config> for Config

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Config

impl StructuralEq for Config

impl StructuralPartialEq for Config