Struct Cached 

pub struct Cached<T: Solution> { /* private fields */ }

A wrapper around a solution that automatically caches the fitness value

Evaluating the fitness of solutions is nearly always the most computationally intensive part of an evolutionary algorithm. This wrapper type makes it so that that computation will only ever happen once for every distinct individual. It implements Solution itself, so you can use the exact same interface you would if it weren’t there.

Implementations

impl<T> Cached<T>

where T: Solution,

pub fn new(individual: T) -> Self

Create a new wrapper around an existing solution.

pub fn into_inner(self) -> (T, Option<T::Fitness>)

Consumes the Cached, returning a tuple of the solution it contained and an Option of the fitness value that could have been cached.

pub fn clear_cache(&mut self) -> Option<T::Fitness>

Delete any cached fitness value. Returns the fitness value that was cached, if it existed.

Be careful with this method; you should not generally need to use it. Using it incorrectly can cause evaluations to be repeated unnecessarily, leading to heavy slowdowns.

Trait Implementations

impl<T> AsRef<T> for Cached<T>

where T: Solution,

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Clone for Cached<T>

where T: Solution,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Cached<T>

where T: Solution + Debug, T::Fitness: Debug,

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

Formats the value using the given formatter.

impl<T> PartialEq<T> for Cached<T>

where T: Solution + PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialEq for Cached<T>

where T: Solution + PartialEq,

fn eq(&self, other: &Cached<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialOrd<T> for Cached<T>

where T: Solution + PartialOrd,

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> PartialOrd for Cached<T>

where T: Solution + PartialOrd,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Solution for Cached<T>

where T: Solution,

type Fitness = <T as Solution>::Fitness

The type that represents this solution’s fitness. For most applications, you’ll want to use f64 or MultiObjective for this, but you can use any type you want.

fn generate() -> Self

Randomly generate a new solution.

fn evaluate(&self) -> Self::Fitness

Evaluate the fitness of the solution.

fn crossover(a: &mut Self, b: &mut Self)

Crossover operator.

fn mutate(&mut self)

Mutation operator.

impl<T: Solution> Sync for Cached<T>