Struct FactorSpec 

pub struct FactorSpec {
    pub target: FactorTarget,
    pub levels: LevelSpec,
}

A factor as a spec writes it.

Fields

target: FactorTarget

Parameter or action tick the factor varies.

levels: LevelSpec

Levels the factor takes, as written.

Implementations

impl FactorSpec

pub fn param(id: impl Into<String>, levels: LevelSpec) -> Self

Returns a factor over parameter id.

pub fn action(name: impl Into<String>, levels: LevelSpec) -> Self

Returns a factor over the tick of the action named name.

pub fn resolve( &self, params: &[ParamDescriptor], actions: &[ActionSpec], design: &DesignKind, ) -> Result<Factor, FactorError>

Resolves the target against params and actions, and checks every level against the target.

In a random or Latin hypercube design, a range with no step stands for every value from min to max. Everywhere else the factor lists its levels.

Errors

Returns FactorError for a parameter or action the sweep does not have, levels the target cannot take, or a level the target rejects.

pub fn resolve_sampled( &self, params: &[ParamDescriptor], actions: &[ActionSpec], ) -> Result<Factor, FactorError>

Resolves the factor as Self::resolve does for a random or Latin hypercube design.

Errors

Returns FactorError for a parameter or action the sweep does not have, levels the target cannot take, or a level the target rejects.

Trait Implementations

impl Clone for FactorSpec

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 FactorSpec

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

Formats the value using the given formatter.

impl PartialEq for FactorSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FactorSpec