Struct Args 

pub struct Args<Dec: DecoderFactory + ValueEnum = DecoderImplementation> {

    pub alist: PathBuf,
    pub output_file: Option<PathBuf>,
    pub output_file_ldpc: Option<PathBuf>,
    pub decoder: Dec,
    pub modulation: Modulation,
    pub puncturing: Option<String>,
    pub interleaving: Option<isize>,
    pub min_ebn0: f64,
    pub max_ebn0: f64,
    pub step_ebn0: f64,
    pub max_iter: usize,
    pub frame_errors: u64,
    pub min_time: Option<Duration>,
    pub max_time: Option<Duration>,
    pub bch_max_errors: u64,
    pub num_threads: usize,
}

BER test CLI arguments.

Fields

alist: PathBuf

alist file for the code

output_file: Option<PathBuf>

Output file for simulation results

output_file_ldpc: Option<PathBuf>

Output file for LDPC-only results (only useful when using BCH)

decoder: Dec

Decoder implementation

modulation: Modulation

Modulation

puncturing: Option<String>

Puncturing pattern (format “1,1,1,0”)

interleaving: Option<isize>

Interleaving columns (negative for backwards read)

min_ebn0: f64

Minimum Eb/N0 (dB)

max_ebn0: f64

Maximum Eb/N0 (dB)

step_ebn0: f64

Eb/N0 step (dB)

max_iter: usize

Maximum number of iterations

frame_errors: u64

Number of frame errors to collect

min_time: Option<Duration>

Minimum run time per Eb/N0 (if unset, the simulation finishes as soon as the frame errors are reached)

max_time: Option<Duration>

Maximum run time per Eb/N0 (if unset, the simulation only finishes when the frame errors are reached)

bch_max_errors: u64

Maximum number of bit errors that the BCH decoder can correct (0 means no BCH decoder)

num_threads: usize

Number of worker threads (defaults to the number of CPUs)

Trait Implementations

impl<Dec: DecoderFactory + ValueEnum> Args for Args<Dec>

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl<Dec: DecoderFactory + ValueEnum> CommandFactory for Args<Dec>

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl<Dec: Debug + DecoderFactory + ValueEnum> Debug for Args<Dec>

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

Formats the value using the given formatter.

impl<Dec: DecoderFactory + ValueEnum> FromArgMatches for Args<Dec>

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl<Dec: DecoderFactory + ValueEnum> Parser for Args<Dec>

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl<Dec: DecoderFactory + ValueEnum> Run for Args<Dec>

fn run(&self) -> Result<(), Box<dyn Error>>

Run the CLI subcommand