Struct Success

pub struct Success<G> { /* private fields */ }

Define the successful outcome of a genetic algorithm search.

Implementations

impl<G> Success<G>

pub fn new( reason: Reason, epoch: usize, elapsed: Duration, best_cost: f64, mean_cost: f64, worst_cost: f64, best_genome: G, ) -> Self

pub fn reason(&self) -> Reason

The reason the search terminated.

pub fn epoch(&self) -> usize

The number of epochs (iterations) the search took before terminating.

pub fn elapsed(&self) -> Duration

The duration of the search.

pub fn best_cost(&self) -> f64

The cost of the best genome found by the search algorithm. This is the cost associated with Success::best_genome.

pub fn mean_cost(&self) -> f64

The arithmetic mean cost of final generation of the algorithm.

pub fn worst_cost(&self) -> f64

The worst cost found in the final generation of the algorithm.

pub fn best_genome(&self) -> &G

The best (lowest cost) genome found by the search algorithm. This is the genome associated with Success::best_cost.

Trait Implementations

impl<G: Clone> Clone for Success<G>

fn clone(&self) -> Success<G>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<G: Debug> Debug for Success<G>

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

Formats the value using the given formatter.

impl<G: PartialEq> PartialEq for Success<G>

fn eq(&self, other: &Success<G>) -> 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<G> StructuralPartialEq for Success<G>