Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes

Algorithm Class Reference
[AlgorithmsSequential algorithmsParallel algorithms]

Algorithm base class. More...

#include <Algorithm.h>

Inheritance diagram for Algorithm:
AlgAEliGpea2 AlgNSGA2 ArtificialBeeColony BitStringHillClimbing Clonalg CuckooSearch DifferentialEvolution Elimination EvolutionStrategy GeneticAnnealing GenHookeJeeves MyAlg OptIA ParallelAlgorithm ParticleSwarmOptimization RandomSearch RouletteWheel SteadyStateTournament XCS

List of all members.

Public Member Functions

std::string getName ()
 Get algorithm name. Each algorithm is uniquely identified with its name.
virtual bool isParallel ()
 Is algorithm parallel (false by default for all algorithms not inheriting ParallelAlgorithm class).
bool isImplicitParallel ()
 Is algorithm run in implicit parallel mode (in development, see tutorial).
virtual bool advanceGeneration (StateP, DemeP)=0
 Perform a single generation on a single deme.
virtual bool initialize (StateP)
 Initialize the algorithm, read parameters from the system, do a sanity check.
virtual void registerParameters (StateP)
 Register algorithm's parameters (if any).
virtual bool initializePopulation (StateP)
 Evaluate initial population (called by State::run before evolution starts).
virtual void read ()
virtual bool advanceGeneration (StateP state)
 Perform one generation of the algorithm on the whole population.
void evaluate (IndividualP ind)
 Helper function: evaluate an individual.
uint mutate (const std::vector< IndividualP > &pool)
 Helper function: send a vector of individuals to mutation.
uint mutate (const IndividualP victim)
 Helper function: send a single individual to mutation.
void replaceWith (IndividualP oldInd, IndividualP newInd)
 Helper function: replace an individual in current deme.
void replaceWith (uint oldIndId, IndividualP newInd)
 Helper function: replace an individual at given position in current deme.
void registerParallelParameters (StateP state)
 used only in parallel ECF
bool initializeParallel (StateP state)
 used only in parallel ECF
virtual bool advanceGeneration (StateP state)
 Parallel ECF: Perform one generation of the algorithm.
virtual void bcastTermination (StateP state)
 Parallel ECF: broadcast termination to worker processes.
void registerParallelParameters (StateP state)
 Parallel ECF: Register parameters for implicit parallel algorithm version.
bool initializeParallel (StateP state)
 Parallel ECF: Initialize implicit parallel algorithm.
void initializeImplicit (StateP state)
 Parallel ECF: Initialize implicit parallel mode.
bool implicitParallelOperate (StateP state)
 Parallel ECF: Worker processes in implicit parallel algorithm.
void evaluate (IndividualP ind)
 Parallel ECF: evaluate an individual.
void implicitEvaluate (IndividualP ind)
 Parallel ECF: implicitly evaluate an individual (store for later evaluation in implicit parallel version).
uint mutate (const IndividualP victim)
 Parallel ECF: immediately mutate an individual.
uint mutate (const std::vector< IndividualP > &pool)
 Parallel ECF: mutate a vector of individuals.
uint implicitMutate (IndividualP ind)
 Parallel ECF: implicitly mutate an individual (store for later mutation in implicit parallel version).
void replaceWith (IndividualP oldInd, IndividualP newInd)
 Parallel ECF: replace an individual in a deme.
void replaceWith (uint oldIndId, IndividualP newInd)
 Parallel ECF: replace an individual at given position in a deme.
bool mate (IndividualP p1, IndividualP p2, IndividualP child)
 Helper function: crossover two individuals.
IndividualP copy (IndividualP source)
 Helper function: make a copy of an individual.
bool removeFrom (IndividualP victim, std::vector< IndividualP > &pool)
 Helper function: remove victim from pool of individual pointers.
bool isMember (IndividualP single, std::vector< IndividualP > &pool)
 Helper function: check if individual is in the pool.

Public Attributes

CrossoverP crossover_
 sptr to container of crossover operators (set by the system)
MutationP mutation_
 sptr to container of mutation operators (set by the system)
EvaluateOpP evalOp_
 sptr to evaluation operator (set by the system)
StateP state_

Protected Member Functions

bool registerParameter (StateP state, std::string name, voidP value, enum ECF::type T, std::string description="")
 Helper function: register a single parameter with the system.
voidP getParameterValue (StateP state, std::string name)
 Helper function: get parameter value from the system.
void storeIndividual (IndividualP)
 stores the individual (if it is consistent), resets consistency flag
void storeGenotypes (std::vector< IndividualP > &)
 adds genotypes of individuals to 'sent' repository
void setConsistency (IndividualP)
 denotes current individual as consistent
void restoreIndividuals (std::vector< uint >)
 restores individuals whose fitness is received
void restorePopulation ()
 restores inconsistent individuals to last consistent state

Protected Attributes

DemeP activeDeme_
std::string name_
 algorithm name
bool bImplicitParallel_
 implicit parallel flag
std::vector< SelectionOperatorP > selectionOp
 sel. operators used by algorithm
std::vector< IndividualP > requests_
std::vector< IndividualP > stored_
 individual vectors for implicit evaluation
std::vector< uint > requestIds_
 individual indexes for implicit evaluation
std::vector< IndividualP > demeCopy_
std::vector< IndividualP > myJob_
 worker's individual vector
CommunicatorP comm_
uint jobSize_
uint totalEvaluations_
uint wastedEvaluations_
bool bImplicitEvaluation_
 implicit evaluation flag
bool bImplicitMutation_
 implicit mutation flag
bool bSynchronized_
 is implicit paralelization synchronous
SelectionOperatorP selBestOp
std::vector< IndividualP > requestsMut_
std::vector< IndividualP > receivedMut_
 individual vectors for implicit mutation
std::vector< uint > requestMutIds_
 individual indexes for implicit mutation
IndividualP currentBest_
std::vector< IndividualP > storedInds_
std::vector< std::vector
< IndividualP > > 
sentInds_
 individuals sent for evaluation
std::vector< bool > isConsistent_
 is individual (genotype-fitness pair) consistent

Detailed Description

Algorithm base class.

All algorithms must inherit this one. An algorithm combines selection operators (SelectionOperator), crossover (Algorithm::mate), mutation (Algorithm::mutate) and additional logic to build an evolutionary procedure.

Definition at line 19 of file Algorithm.h.


Member Function Documentation

virtual bool Algorithm::advanceGeneration ( StateP  ,
DemeP   
) [pure virtual]
bool Algorithm::advanceGeneration ( StateP  state  )  [inline, virtual]

Perform one generation of the algorithm on the whole population.

Default if not reimplemented: algorithm advances one generation on each deme

Definition at line 139 of file Algorithm.h.

voidP Algorithm::getParameterValue ( StateP  state,
std::string  name 
) [inline, protected]

Helper function: get parameter value from the system.

Parameters:
state pointer to State object
name parameter name
Returns:
pointer to parameter value (needs casting)

Definition at line 46 of file Algorithm.h.

virtual bool Algorithm::initialize ( StateP   )  [inline, virtual]

Initialize the algorithm, read parameters from the system, do a sanity check.

Called by the system before the algorithm starts (Algorithm::advanceGeneration)

Reimplemented in AlgAEliGpea, AlgAEliGpea2, ArtificialBeeColony, Clonalg, CuckooSearch, DifferentialEvolution, Elimination, EvolutionStrategy, GeneticAnnealing, GenHookeJeeves, AlgNSGA2, OptIA, ParticleSwarmOptimization, RandomSearch, RouletteWheel, AlgSGenGpea, SteadyStateTournament, MyAlg, XCS, and BitStringHillClimbing.

Definition at line 115 of file Algorithm.h.

bool Algorithm::registerParameter ( StateP  state,
std::string  name,
voidP  value,
enum ECF::type  T,
std::string  description = "" 
) [inline, protected]

Helper function: register a single parameter with the system.

Parameters:
state pointer to State object
name unique parameter name
value pointer to parameter value object (caller provides)
T parameter type (see Registry.h)
Returns:
true if parameter successfuly registered, false otherwise

Definition at line 35 of file Algorithm.h.

virtual void Algorithm::registerParameters ( StateP   )  [inline, virtual]
void Algorithm::replaceWith ( uint  oldIndId,
IndividualP  newInd 
) [inline]

Helper function: replace an individual at given position in current deme.

Parameters:
oldIndId index of individual to be replaced
newInd new individual

Definition at line 195 of file Algorithm.h.

void Algorithm::replaceWith ( IndividualP  oldInd,
IndividualP  newInd 
) [inline]

Helper function: replace an individual in current deme.

Parameters:
oldInd individual to be replaced
newInd new individual

Definition at line 187 of file Algorithm.h.


The documentation for this class was generated from the following files: