Struct Runner 

pub struct Runner { /* private fields */ }

The campaign runner (builder; see the module documentation).

Implementations

impl Runner

pub fn new() -> Runner

Seed 0, batches of 32 trials, all cores, 100 trials per condition, 95 % intervals.

pub fn config(self, json: impl Into<String>) -> Runner

The configuration that produced the run, a JSON document recorded in the run information (and the JSON report) next to the version, the commit and the seed.

pub fn seed(self, seed: u64) -> Runner

The base seed of every stream.

pub fn batch(self, n: u64) -> Runner

Trials per batch (at least 1): the stopping rule is checked after every batch.

pub fn threads(self, n: usize) -> Runner

Worker threads (0: one per core).

pub fn stop(self, rule: Stop) -> Runner

The stopping rule of every condition.

pub fn confidence(self, c: f64) -> Runner

Confidence level of the intervals reported by the loggers (default 0.95), in $(0, 1)$ (Runner::run refuses another value).

pub fn fast_dev_run(self, on: bool) -> Runner

Run one batch per condition and ignore the stopping rule (a quick check).

pub fn callback(self, c: impl Callback + 'static) -> Runner

Add a callback.

pub fn logger(self, l: impl Logger + 'static) -> Runner

Add a logger.

pub fn run_info(&self, scenario: &str, n_conditions: usize) -> RunInfo

What the callbacks and the loggers know about a run of this runner on the scenario scenario over n_conditions conditions, started now (all the cores counted for threads: 0): the header of every report, that of a run, of a search and of a verification.

pub fn run<S: Scenario>( self, scenario: &S, grid: &Grid, ) -> Result<Vec<ConditionResult>>

Run the scenario on every condition of the grid.

Errors

Error::Config for a grid that gives a key twice (Grid::check); for a confidence level outside $(0, 1)$ (of the runner or of a precision target, see check_confidence); for a stopping rule that can never stop, or whose target is a metric that the first batch of a condition does not record (or min_errors on a mean, see Stop::check_metrics); the first error of a setup or of a trial, of the same kind, with the condition and the trial in the message; the errors of the loggers.

Trait Implementations

impl Default for Runner

fn default() -> Self

Returns the “default value” for a type.