ECF 1.5
Public Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
Clonalg Class Reference

Clonal Selection Algorithm (see e.g. http://en.wikipedia.org/wiki/Clonal_Selection_Algorithm). More...

#include <AlgClonalg.h>

Inheritance diagram for Clonalg:
Algorithm

Public Member Functions

void registerParameters (StateP state)
 Register algorithm's parameters (if any). More...
 
bool initialize (StateP state)
 Initialize the algorithm, read parameters from the system, do a sanity check. More...
 
bool advanceGeneration (StateP state, DemeP deme)
 Perform a single generation on a single deme. More...
 
bool markAntibodies (DemeP deme)
 mark antibodies so the alg can know which clone belongs to which parent Antibody More...
 
bool cloningPhase (StateP state, DemeP deme, std::vector< IndividualP > &clones)
 
bool hypermutationPhase (StateP state, DemeP deme, std::vector< IndividualP > &clones)
 
bool selectionPhase (StateP state, DemeP deme, std::vector< IndividualP > &clones)
 
bool birthPhase (StateP state, DemeP deme, std::vector< IndividualP > &clones)
 
bool replacePopulation (StateP state, DemeP deme, std::vector< IndividualP > &clones)
 replace population with the contents of clones vector More...
 
- Public Member Functions inherited from Algorithm
std::string getName ()
 Get algorithm name. Each algorithm is uniquely identified with its name. More...
 
virtual bool isParallel ()
 Is algorithm parallel (false by default for all algorithms not inheriting ParallelAlgorithm class). More...
 
bool isImplicitParallel ()
 Is algorithm run in implicit parallel mode (in development, see tutorial). More...
 
virtual bool advanceGeneration (StateP, DemeP)=0
 Perform a single generation on a single deme. More...
 
virtual bool initialize (StateP)
 Initialize the algorithm, read parameters from the system, do a sanity check. More...
 
virtual void registerParameters (StateP)
 Register algorithm's parameters (if any). More...
 
virtual bool initializePopulation (StateP)
 Evaluate initial population (called by State::run before evolution starts). More...
 
virtual void read ()
 
virtual bool advanceGeneration (StateP state)
 Perform one generation of the algorithm on the whole population. More...
 
void evaluate (IndividualP ind)
 Helper function: evaluate an individual. More...
 
uint mutate (const std::vector< IndividualP > &pool)
 Helper function: send a vector of individuals to mutation. More...
 
uint mutate (const IndividualP victim)
 Helper function: send a single individual to mutation. More...
 
void replaceWith (IndividualP oldInd, IndividualP newInd)
 Helper function: replace an individual in current deme. More...
 
void replaceWith (uint oldIndId, IndividualP newInd)
 Helper function: replace an individual at given position in current deme. More...
 
void registerParallelParameters (StateP state)
 used only in parallel ECF More...
 
bool initializeParallel (StateP state)
 used only in parallel ECF More...
 
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. More...
 
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. More...
 
bool implicitParallelOperate (StateP state)
 Parallel ECF: Worker processes in implicit parallel algorithm. More...
 
void evaluate (IndividualP ind)
 Parallel ECF: evaluate an individual. More...
 
void implicitEvaluate (IndividualP ind)
 Parallel ECF: implicitly evaluate an individual (store for later evaluation in implicit parallel version). More...
 
uint mutate (const IndividualP victim)
 Parallel ECF: immediately mutate an individual. More...
 
uint mutate (const std::vector< IndividualP > &pool)
 Parallel ECF: mutate a vector of individuals. More...
 
uint implicitMutate (IndividualP ind)
 Parallel ECF: implicitly mutate an individual (store for later mutation in implicit parallel version). More...
 
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. More...
 
bool mate (IndividualP p1, IndividualP p2, IndividualP child)
 Helper function: crossover two individuals. More...
 
IndividualP copy (IndividualP source)
 Helper function: make a copy of an individual. More...
 
bool removeFrom (IndividualP victim, std::vector< IndividualP > &pool)
 Helper function: remove victim from pool of individual pointers. More...
 
bool isMember (IndividualP single, std::vector< IndividualP > &pool)
 Helper function: check if individual is in the pool. More...
 

Static Protected Member Functions

static bool sortPopulationByFitness (IndividualP ab1, IndividualP ab2)
 sort vector of antibodies in regards to their fitness More...
 
static bool sortPopulationByParentAndFitness (IndividualP ab1, IndividualP ab2)
 sort vector of antibodies first by their antibody parents and then by their fitness More...
 

Protected Attributes

double ubound
 
double lbound
 
uint dimension
 
bool areGenotypesAdded_
 
uint n
 number of antibodies cloned every generation More...
 
double beta
 parameter which determines the number of clones for every antibody More...
 
double c
 mutation parameter More...
 
double d
 fraction of population regenerated every generation More...
 
std::string cloningVersion
 specifies whether to use static or proportional cloning More...
 
std::string selectionScheme
 specifies which selection scheme to use CLONALG1 or CLONALG2 More...
 
- Protected Attributes inherited from Algorithm
DemeP activeDeme_
 
std::string name_
 algorithm name More...
 
bool bImplicitParallel_
 implicit parallel flag More...
 
std::vector< SelectionOperatorP > selectionOp
 sel. operators used by algorithm More...
 
std::vector< IndividualP > requests_
 
std::vector< IndividualP > stored_
 individual vectors for implicit evaluation More...
 
std::vector< uint > requestIds_
 individual indexes for implicit evaluation More...
 
std::vector< IndividualP > demeCopy_
 
std::vector< IndividualP > myJob_
 worker's individual vector More...
 
CommunicatorP comm_
 
uint jobSize_
 
uint totalEvaluations_
 
uint wastedEvaluations_
 
bool bImplicitEvaluation_
 implicit evaluation flag More...
 
bool bImplicitMutation_
 implicit mutation flag More...
 
bool bSynchronized_
 is implicit paralelization synchronous More...
 
SelectionOperatorP selBestOp
 
std::vector< IndividualP > requestsMut_
 
std::vector< IndividualP > receivedMut_
 individual vectors for implicit mutation More...
 
std::vector< uint > requestMutIds_
 individual indexes for implicit mutation More...
 
IndividualP currentBest_
 
std::vector< IndividualP > storedInds_
 
std::vector< std::vector< IndividualP > > sentInds_
 individuals sent for evaluation More...
 
std::vector< bool > isConsistent_
 is individual (genotype-fitness pair) consistent More...
 

Additional Inherited Members

- Public Attributes inherited from Algorithm
CrossoverP crossover_
 sptr to container of crossover operators (set by the system) More...
 
MutationP mutation_
 sptr to container of mutation operators (set by the system) More...
 
EvaluateOpP evalOp_
 sptr to evaluation operator (set by the system) More...
 
StateP state_
 
- Protected Member Functions inherited from Algorithm
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. More...
 
voidP getParameterValue (StateP state, std::string name)
 Helper function: get parameter value from the system. More...
 
void storeIndividual (IndividualP)
 stores the individual (if it is consistent), resets consistency flag More...
 
void storeGenotypes (std::vector< IndividualP > &)
 adds genotypes of individuals to 'sent' repository More...
 
void setConsistency (IndividualP)
 denotes current individual as consistent More...
 
void restoreIndividuals (std::vector< uint >)
 restores individuals whose fitness is received More...
 
void restorePopulation ()
 restores inconsistent individuals to last consistent state More...
 

Detailed Description

Clonal Selection Algorithm (see e.g. http://en.wikipedia.org/wiki/Clonal_Selection_Algorithm).

This CLONALG implements:

CLONALG algorithm accepts only a single FloatingPoint genotype. Additionally, if chosen, selectionScheme CLONALG1 adds a FloatingPoint genotype (parentAntibody) to mark which clone came from which antibodies.

Definition at line 24 of file AlgClonalg.h.

Constructor & Destructor Documentation

◆ Clonalg()

Clonalg::Clonalg ( )

Definition at line 7 of file AlgClonalg.cpp.

Member Function Documentation

◆ advanceGeneration()

bool Clonalg::advanceGeneration ( StateP  ,
DemeP   
)
virtual

Perform a single generation on a single deme.

Must be implemented by a specific algorithm class

Implements Algorithm.

Definition at line 125 of file AlgClonalg.cpp.

◆ birthPhase()

bool Clonalg::birthPhase ( StateP  state,
DemeP  deme,
std::vector< IndividualP > &  clones 
)

Definition at line 275 of file AlgClonalg.cpp.

◆ cloningPhase()

bool Clonalg::cloningPhase ( StateP  state,
DemeP  deme,
std::vector< IndividualP > &  clones 
)

Definition at line 152 of file AlgClonalg.cpp.

◆ hypermutationPhase()

bool Clonalg::hypermutationPhase ( StateP  state,
DemeP  deme,
std::vector< IndividualP > &  clones 
)

Definition at line 188 of file AlgClonalg.cpp.

◆ initialize()

bool Clonalg::initialize ( StateP  )
virtual

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

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

Reimplemented from Algorithm.

Definition at line 33 of file AlgClonalg.cpp.

◆ markAntibodies()

bool Clonalg::markAntibodies ( DemeP  deme)

mark antibodies so the alg can know which clone belongs to which parent Antibody

Definition at line 141 of file AlgClonalg.cpp.

◆ registerParameters()

void Clonalg::registerParameters ( StateP  )
virtual

Register algorithm's parameters (if any).

Called by the system before algorithm initialization (Algorithm::initialize)

Reimplemented from Algorithm.

Definition at line 16 of file AlgClonalg.cpp.

◆ replacePopulation()

bool Clonalg::replacePopulation ( StateP  state,
DemeP  deme,
std::vector< IndividualP > &  clones 
)

replace population with the contents of clones vector

Definition at line 296 of file AlgClonalg.cpp.

◆ selectionPhase()

bool Clonalg::selectionPhase ( StateP  state,
DemeP  deme,
std::vector< IndividualP > &  clones 
)

Definition at line 244 of file AlgClonalg.cpp.

◆ sortPopulationByFitness()

static bool Clonalg::sortPopulationByFitness ( IndividualP  ab1,
IndividualP  ab2 
)
inlinestaticprotected

sort vector of antibodies in regards to their fitness

Definition at line 41 of file AlgClonalg.h.

◆ sortPopulationByParentAndFitness()

static bool Clonalg::sortPopulationByParentAndFitness ( IndividualP  ab1,
IndividualP  ab2 
)
inlinestaticprotected

sort vector of antibodies first by their antibody parents and then by their fitness

Definition at line 44 of file AlgClonalg.h.

Member Data Documentation

◆ areGenotypesAdded_

bool Clonalg::areGenotypesAdded_
protected

Definition at line 31 of file AlgClonalg.h.

◆ beta

double Clonalg::beta
protected

parameter which determines the number of clones for every antibody

Definition at line 34 of file AlgClonalg.h.

◆ c

double Clonalg::c
protected

mutation parameter

Definition at line 35 of file AlgClonalg.h.

◆ cloningVersion

std::string Clonalg::cloningVersion
protected

specifies whether to use static or proportional cloning

Definition at line 37 of file AlgClonalg.h.

◆ d

double Clonalg::d
protected

fraction of population regenerated every generation

Definition at line 36 of file AlgClonalg.h.

◆ dimension

uint Clonalg::dimension
protected

Definition at line 30 of file AlgClonalg.h.

◆ lbound

double Clonalg::lbound
protected

Definition at line 29 of file AlgClonalg.h.

◆ n

uint Clonalg::n
protected

number of antibodies cloned every generation

Definition at line 33 of file AlgClonalg.h.

◆ selectionScheme

std::string Clonalg::selectionScheme
protected

specifies which selection scheme to use CLONALG1 or CLONALG2

Definition at line 38 of file AlgClonalg.h.

◆ ubound

double Clonalg::ubound
protected

Definition at line 28 of file AlgClonalg.h.


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