Struct Mode 

pub struct Mode { /* private fields */ }

Stateful constrained MODE optimizer.

Objective columns precede constraint columns in every row passed to tell; constraints are feasible when they are non-positive.

Implementations

impl Mode

pub fn try_new( fitfun: Fitness, nobj: usize, ncon: usize, ints: Option<Vec<bool>>, p: &ModeParams, ) -> Result<Self, &'static str>

Construct MODE after validating dimensions, bounds, population size, probabilities, and the optional integer mask.

Errors

Returns an error if the fitness dimension or bounds are inconsistent, if nobj is zero, if the population size is below four, if any probability parameter is outside its valid range, or if a supplied integer mask does not have one entry per decision variable.

pub fn new( fitfun: Fitness, nobj: usize, ncon: usize, ints: Option<Vec<bool>>, p: &ModeParams, ) -> Self

Construct MODE, panicking on invalid configuration. Applications that accept user input should prefer Mode::try_new.

Panics

Panics on any configuration Mode::try_new rejects.

pub fn dim(&self) -> usize

Number of decision variables.

pub fn nobj(&self) -> usize

Number of objective columns.

pub fn ncon(&self) -> usize

Number of constraint columns.

pub fn popsize(&self) -> usize

Number of individuals evaluated per batch.

pub fn stop(&self) -> i32

Current termination code.

pub fn ask(&mut self) -> Vec<Vec<f64>>

Ask for popsize offspring rows.

Panics

Panics if a previous batch is still pending, that is if ask is called twice without an intervening tell. Use Mode::try_ask to receive that as an error instead.

pub fn try_ask(&mut self) -> Result<Vec<Vec<f64>>, &'static str>

Fallible ask variant for interfaces that need to report call-order errors rather than panic.

Errors

Returns an error if the previously asked batch has not been told yet.

pub fn tell(&mut self, ys: &[Vec<f64>]) -> i32

Tell objective+constraint values for the offspring from ask.

Panics

Panics if no batch is pending, if ys does not have popsize rows, or if a row width differs from nobj + ncon. Use Mode::try_tell to receive these as errors instead.

pub fn try_tell(&mut self, ys: &[Vec<f64>]) -> Result<i32, &'static str>

Fallible tell variant validating call order and matrix shape.

Errors

Returns an error if no batch is pending, if ys does not have popsize rows, or if a row width differs from nobj + ncon.

pub fn tell_switch( &mut self, ys: &[Vec<f64>], nsga_update: bool, pareto_update: f64, ) -> i32

Tell values while switching the population-update mode.

Panics

Panics on everything Mode::tell panics on, and additionally if pareto_update is not finite. Use Mode::try_tell_switch for the fallible form.

pub fn try_tell_switch( &mut self, ys: &[Vec<f64>], nsga_update: bool, pareto_update: f64, ) -> Result<i32, &'static str>

Fallible tell_switch variant validating the update probability and pending batch.

Errors

Returns an error if pareto_update is not finite, or for any condition Mode::try_tell rejects.

pub fn set_population(&mut self, xs: &[Vec<f64>], ys: &[Vec<f64>]) -> i32

Replace the candidate population and tell its values.

Panics

Panics if the population size is below four, or if xs/ys shapes do not match the configured dimension and value width. Use Mode::try_set_population for the fallible form.

pub fn try_set_population( &mut self, xs: &[Vec<f64>], ys: &[Vec<f64>], ) -> Result<i32, &'static str>

Fallible set_population variant validating dimensions and population sizes.

Errors

Returns an error if the population size is below four, if xs and ys have different lengths, if a decision row width differs from the configured dimension, or if a value row width differs from nobj + ncon.

pub fn population(&self) -> Vec<Vec<f64>>

Current population (rows = individuals).

pub fn result(&self) -> ModeResult

Return a snapshot of the current population and its values.