Struct ldpc_toolbox::peg::Config

pub struct Config {
    pub nrows: usize,
    pub ncols: usize,
    pub wc: usize,
}

Configuration for the Progressive Edge Growth construction

This configuration is used to set the parameters of the LDPC code to construct.

Fields

nrows: usize

Number of rows of the parity check matrix.

ncols: usize

Number of columns of the parity check matrix.

wc: usize

Column weight of the parity check matrix.

Implementations

impl Config

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

Runs the Progressive Edge Growth algorith using a random seed seed.

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