Struct Plan 

pub struct Plan { /* private fields */ }

A sweep spec checked against a model, with every config listed.

Runs are numbered config by config, so run run_id is replicate run_id % replicates of config run_id / replicates.

Implementations

impl Plan

pub fn model(&self) -> &str

Id of the model the plan runs.

pub fn configs(&self) -> &[Config]

Every config, indexed by config id.

pub fn config(&self, config_id: u64) -> Option<&Config>

Returns config config_id, or None past the last config.

pub fn blocks(&self) -> &[PlannedBlock]

Every block, in spec order.

pub fn run_settings(&self) -> &RunSettings

Length and end of each run, and the number of runs per config.

pub fn measure_settings(&self) -> &MeasureSettings

Ticks each run samples, and the values it keeps from them.

pub fn seed_settings(&self) -> SeedSettings

Root seed and the scheme that derives each run’s seed from it.

pub fn actions(&self) -> &[ActionSpec]

Actions every run fires, in spec order, the order of Config::action_ticks.

pub fn warnings(&self) -> &[PlanWarning]

Warnings about parts of the plan that run, though likely not as intended.

pub fn replicates(&self) -> u64

Number of runs per config.

pub fn run_count(&self) -> u64

Number of runs, every config times its replicates.

pub fn run(&self, run_id: u64) -> Option<PlannedRun>

Returns run run_id, or None past the last run.

pub fn runs(&self) -> impl Iterator<Item = PlannedRun> + '_

Returns every run in order.

pub fn runs_in_shard( &self, shard: Shard, ) -> impl Iterator<Item = PlannedRun> + '_

Returns the runs of shard in order.

pub fn schedule(&self, config: &Config) -> Schedule

Returns the actions of config in the order they fire, by tick and then in spec order.

Panics

Panics when config does not hold one tick per action of the plan.

pub fn replay(&self, run_id: u64) -> Option<Replay>

Returns the Replay of run run_id, or None past the last run.

pub fn run_key(&self, run: &PlannedRun) -> u64

Returns the key that identifies the results of run, from run_key.

Panics

Panics when the config of run is not in this plan.

pub fn schema_hash(&self) -> u64

Hash of the model’s declarations, from schema_hash.

pub fn results_fingerprint(&self) -> u64

Hash of every setting that shapes the results of one run, from results_fingerprint.

pub fn plan_hash(&self) -> u64

Hash of every setting that fixes the configs and their seeds, from plan_hash.

Note that the replicate count and the timeout are left out.

Trait Implementations

impl Clone for Plan

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Plan

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

Formats the value using the given formatter.

impl PartialEq for Plan

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Plan