Struct metaheuristics_nature::Ctx

#[non_exhaustive]
pub struct Ctx<F: ObjFunc> {
    pub best: <F::Ys as Fitness>::Best<F::Ys>,
    pub pool: Vec<Vec<f64>>,
    pub pool_y: Vec<F::Ys>,
    pub func: F,
    pub gen: u64,
}

A basic context type of the algorithms.

This type provides a shared dataset if you want to implement a new method. The fields maybe expanded in the future, so it marked as non-exhaustive.

View the Progress

You can view the progress from the SolverBuilder::task() and SolverBuilder::callback().

• ctx.gen - Get generation number.
• ctx.pop_num() - Get population number.
• ctx.best.get_eval() - Get the current best evaluation value.
• ctx.best.get_xs() - Get the current best variables.

Implement an Algorithm

Do everything you want to do with the context. Please see Algorithm for the implementation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

best: <F::Ys as Fitness>::Best<F::Ys>

Best container

pool: Vec<Vec<f64>>

Current variables of all individuals

pool_y: Vec<F::Ys>

Current fitness values of all individuals

func: F

Objective function object

gen: u64

Generation (iteration) number

Implementations

impl<F: ObjFunc> Ctx<F>

pub fn pop_num(&self) -> usize

Get population number.

pub fn set_from(&mut self, i: usize, xs: Vec<f64>, ys: F::Ys)

Assign the index from source.

pub fn find_best(&mut self)

Find the best, and set it globally.

Trait Implementations

impl<F: ObjFunc> Deref for Ctx<F>

type Target = F

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.