Struct BenchmarkParameters 

pub struct BenchmarkParameters {

    pub d: VertexNum,
    pub p: f64,
    pub pe: f64,
    pub noisy_measurements: VertexNum,
    pub max_half_weight: Weight,
    pub code_type: ExampleCodeType,
    pub code_config: String,
    pub enable_visualizer: bool,
    pub visualizer_filename: String,
    pub print_syndrome_pattern: bool,
    pub verifier: Verifier,
    pub total_rounds: usize,
    pub primal_dual_type: PrimalDualType,
    pub primal_dual_config: String,
    pub partition_strategy: PartitionStrategy,
    pub partition_config: String,
    pub pb_message: String,
    pub use_deterministic_seed: bool,
    pub benchmark_profiler_output: Option<String>,
    pub starting_iteration: usize,
}

Fields

d: VertexNum

code distance

p: f64

physical error rate: the probability of each edge to

pe: f64

rounds of noisy measurement, valid only when multiple rounds

noisy_measurements: VertexNum

rounds of noisy measurement, valid only when multiple rounds

max_half_weight: Weight

maximum half weight of edges

code_type: ExampleCodeType

example code type

code_config: String

the configuration of the code builder

enable_visualizer: bool

logging to the default visualizer file at visualize/data/visualizer.json

visualizer_filename: String

visualizer file at visualize/data/<visualizer_filename.json>

print_syndrome_pattern: bool

print syndrome patterns

verifier: Verifier

the method to verify the correctness of the decoding result

total_rounds: usize

the number of iterations to run

primal_dual_type: PrimalDualType

select the combination of primal and dual module

primal_dual_config: String

the configuration of primal and dual module

partition_strategy: PartitionStrategy

partition strategy

partition_config: String

the configuration of the partition strategy

pb_message: String

message on the progress bar

use_deterministic_seed: bool

use deterministic seed for debugging purpose

benchmark_profiler_output: Option<String>

the benchmark profile output file path

starting_iteration: usize

skip some iterations, useful when debugging

Trait Implementations

impl Args for BenchmarkParameters

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 Clone for BenchmarkParameters

fn clone(&self) -> BenchmarkParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for BenchmarkParameters

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 Debug for BenchmarkParameters

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

Formats the value using the given formatter.

impl From<BenchmarkParameters> for RunnableBenchmarkParameters

fn from(parameters: BenchmarkParameters) -> Self

Converts to this type from the input type.

impl FromArgMatches for BenchmarkParameters

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 Parser for BenchmarkParameters

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.