Struct genevo::algorithm::EvaluatedPopulation

pub struct EvaluatedPopulation<G, F> where
    G: Genotype,
    F: Fitness,  { /* private fields */ }

The EvaluatedPopulation holds the results of the evaluation stage of the genetic algorithm. It is used to pass these values to the operator::SelectionOp to enable this operator to do its job.

Currently it contains the fitness value of each individual in a population, their normalized fitness values and highest and average fitness of the population.

As the information in this struct is only used to pass the output of the evaluation stage to the selection operator and this happens once for every population the types of the fields are designed to avoid cloning of whole data structures. To be able to change the fields internally later when new optimization are found the fields are kept private.

Implementations

impl<G, F> EvaluatedPopulation<G, F> where
    G: Genotype,
    F: Fitness, 

pub fn new(
    individuals: Rc<Vec<G>>,
    fitness_values: Vec<F>,
    highest_fitness: F,
    lowest_fitness: F,
    average_fitness: F
) -> Self

Construct a new instance of the EvaluatedPopulation struct.

pub fn individuals(&self) -> Rc<Vec<G>>

Returns the individuals of the population that has been evaluated.

pub fn fitness_values(&self) -> &[F]

Returns the fitness values of all individuals of the evaluated population.

The returned slice contains the fitness values of the individuals in the same order as the slice returned by function individuals contains the individuals itself, i.e. for individual with index i in individuals()[i] the fitness value is stored in fitness_values()[i].

pub fn highest_fitness(&self) -> &F

Returns the highest genetic::Fitness value found in the evaluated population.

pub fn lowest_fitness(&self) -> &F

Returns the lowest genetic::Fitness value found in the evaluated population.

pub fn average_fitness(&self) -> &F

Returns the average of all genetic::Fitness values of the evaluated population.

pub fn individual(&self, index: usize) -> Option<&G>

Returns the individual at the given index.

pub fn fitness_of_individual(&self, individual: &G) -> Option<&F>

Returns the genetic::Fitness value of the given individual.

Note: This function might be more expensive due to the data structure chosen for this struct. So use it sparingly.

pub fn individual_with_fitness(&self, fitness: &F) -> Option<&G>

Returns the genetic::Genotype of the individual with a given genetic::Fitness value.

Note: This function might be more expensive due to the data structure chosen for this struct. So use it sparingly.

pub fn evaluated_individual_with_fitness(
    &self,
    fitness: &F
) -> Option<Evaluated<G, F>>

Returns the Evaluated individual with a given genetic::Fitness value.

Note: This function might be more expensive due to the data structure chosen for this struct. So use it sparingly.

Trait Implementations

impl<G: Clone, F: Clone> Clone for EvaluatedPopulation<G, F> where
    G: Genotype,
    F: Fitness, 

fn clone(&self) -> EvaluatedPopulation<G, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<G: Debug, F: Debug> Debug for EvaluatedPopulation<G, F> where
    G: Genotype,
    F: Fitness, 

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

Formats the value using the given formatter.

impl<G: PartialEq, F: PartialEq> PartialEq<EvaluatedPopulation<G, F>> for EvaluatedPopulation<G, F> where
    G: Genotype,
    F: Fitness, 

fn eq(&self, other: &EvaluatedPopulation<G, F>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &EvaluatedPopulation<G, F>) -> bool

This method tests for !=.

impl<G: Eq, F: Eq> Eq for EvaluatedPopulation<G, F> where
    G: Genotype,
    F: Fitness, 

impl<G, F> StructuralEq for EvaluatedPopulation<G, F> where
    G: Genotype,
    F: Fitness, 

impl<G, F> StructuralPartialEq for EvaluatedPopulation<G, F> where
    G: Genotype,
    F: Fitness,