Struct snowcap_bencher::BencherArguments

pub struct BencherArguments {
    pub bench_type: BencherType,
    pub iterations: usize,
    pub max_time: u64,
    pub ignore_nan: bool,
    pub random: bool,
    pub tree: bool,
    pub main: bool,
    pub mif: bool,
    pub mil: bool,
    pub global_optimum: bool,
    pub threads: Option<usize>,
    pub output_csv: Option<String>,
    pub output_json: Option<String>,
}

Arguments required for the bencher

Fields

bench_type: BencherType

Type of benchmark

iterations: usize

Number of iterations to repeat

max_time: u64

Maximum allowed time per run, in seconds. If the time exceeds the limit, then the cost will be set to nan.

ignore_nan: bool

If this flag is set, then nan values will be ignored, and not added to the resulting csv file

random: bool

Perform benching the random baseline

tree: bool

Perform benching the tree strategy

main: bool

Perform benching the main strategy

mif: bool

Perform benching the most-important-first baseline strategy

mil: bool

Perform benching the most-important-first baseline strategy

global_optimum: bool

search for the global optimum

threads: Option<usize>

Number of threads to use. Defaults to the number of threads available on the system.

output_csv: Option<String>

Output file to store the results. Two different files will be created: "NAME_strategy.csv", "NAME_tree.csv" and "NAME_random.csv"! Don't provide the file ending ".csv"!

output_json: Option<String>

Output file to store the results in json format. Give the entire path, including the json ending.

Trait Implementations

impl Clap for BencherArguments

pub fn parse() -> Self

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

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

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

pub fn parse_from<I, T>(itr: I) -> Self where
    T: Into<OsString> + Clone,
    I: IntoIterator<Item = T>, 

Parse from iterator, exit on error

pub fn try_parse_from<I, T>(itr: I) -> Result<Self, Error> where
    T: Into<OsString> + Clone,
    I: IntoIterator<Item = T>, 

Parse from iterator, return Err on error.

pub fn update_from<I, T>(&mut self, itr: I) where
    T: Into<OsString> + Clone,
    I: IntoIterator<Item = T>, 

Update from iterator, exit on error

pub fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error> where
    T: Into<OsString> + Clone,
    I: IntoIterator<Item = T>, 

Update from iterator, return Err on error.

impl Clone for BencherArguments

fn clone(&self) -> BencherArguments

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BencherArguments

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

Formats the value using the given formatter.

impl FromArgMatches for BencherArguments

fn from_arg_matches(matches: &ArgMatches) -> Self

It's common to have an "application context" struct (sometimes called config) that represents all the normalized values after being processed by the CLI.

fn update_from_arg_matches(&mut self, matches: &ArgMatches)

@TODO@ @release @docs

impl IntoApp for BencherArguments

fn into_app<'b>() -> App<'b>

@TODO @release @docs

fn into_app_for_update<'b>() -> App<'b>

@TODO @release @docs

fn augment_clap<'b>(app: App<'b>) -> App<'b>

@TODO @release @docs

fn augment_clap_for_update<'b>(app: App<'b>) -> App<'b>

@TODO @release @docs