Struct PatternSpaceSettings 

pub struct PatternSpaceSettings {
    pub x_axis: PatternAxis,
    pub y_axis: PatternAxis,
    pub initial_samples: u64,
    pub mutation_scale: f64,
    pub aggregate: Aggregate,
}

Settings of a Pattern Space Exploration.

Fields

x_axis: PatternAxis

Axis over the first watched column.

y_axis: PatternAxis

Axis over the second watched column.

initial_samples: u64

Number of candidates drawn at random before any candidate is bred from the archive.

mutation_scale: f64

Largest step of a mutated gene, as a fraction of its range.

aggregate: Aggregate

Rule that folds the replicates of a candidate into one value per axis.

Implementations

impl PatternSpaceSettings

pub fn new(x_axis: PatternAxis, y_axis: PatternAxis) -> Self

Returns settings over x_axis and y_axis, with 64 initial samples, a mutation scale of 0.1 and the median.

pub fn check(&self) -> Result<(), SearchSpecError>

Checks both axes, the initial samples and the mutation scale.

Errors

Returns SearchSpecError::Setting for an axis with no cells, one bound without the other, a bound that is not finite or a maximum not above the minimum, no initial samples with an automatic range, or a mutation scale that is not a positive number.

pub fn has_ranges(&self) -> bool

Returns whether both axes have both bounds.

pub fn range_sample_count(&self, max_evaluations: u64) -> u64

Returns the number of initial samples an automatic range is taken from, under a budget of max_evaluations.

pub fn batch_count(&self, max_evaluations: u64, batch_size: usize) -> u64

Returns the number of batches that an exploration of max_evaluations evaluations runs, each of at most batch_size candidates.

The initial samples fill their own batches, and so does the first candidate when there are no initial samples.

pub fn with_automatic_ranges(&self, outputs: &[(f64, f64)]) -> Self

Returns the settings with each automatic axis given the range that automatic_range computes from outputs.

outputs holds the x and y output of each initial sample that has both outputs. An axis with bounds keeps them.

pub fn outputs(&self, evaluation: &Evaluation) -> Option<(f64, f64)>

Returns the outputs of evaluation on the x and y axes, or None when an axis has no finite value.

Each axis folds the finite values of its column with Self::aggregate, leaving failed replicates out.

pub fn locate(&self, x: f64, y: f64) -> PatternPlacement

Returns the placement of outputs x and y, with no cell while an axis has no range.

pub fn place(&self, evaluation: &Evaluation) -> Option<PatternPlacement>

Returns the placement of the replicates of evaluation, or None when an axis has no finite value.

The outputs are those Self::outputs returns, and the placement has no cell while an axis has no range.

Trait Implementations

impl Clone for PatternSpaceSettings

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 PatternSpaceSettings

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

Formats the value using the given formatter.

impl PartialEq for PatternSpaceSettings

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PatternSpaceSettings