Struct ConditionalParameter 

pub struct ConditionalParameter {
    pub parameter: CategoricalParameter,
    pub conditions: Vec<(String, ParameterValue)>,
    pub require_all_conditions: bool,
}

Conditional parameter definition

Fields

parameter: CategoricalParameter

Base parameter

conditions: Vec<(String, ParameterValue)>

Conditions under which this parameter is active

require_all_conditions: bool

Whether all conditions must be met (AND) or any (OR)

Implementations

impl ConditionalParameter

pub fn new( parameter: CategoricalParameter, conditions: Vec<(String, ParameterValue)>, ) -> Self

Create a new conditional parameter

pub fn require_all_conditions(self, require_all: bool) -> Self

Set whether all conditions must be met

pub fn is_active(&self, params: &ParameterSet) -> bool

Check if this parameter is active given the current parameter set

pub fn sample_if_active( &self, params: &ParameterSet, rng: &mut impl Rng, ) -> Option<ParameterValue>

Sample from this parameter if it’s active

Trait Implementations

impl Clone for ConditionalParameter

fn clone(&self) -> ConditionalParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConditionalParameter

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

Formats the value using the given formatter.