ECF 1.5
Public Member Functions | Protected Attributes | List of all members

Population class - inherits a vector of Deme objects. More...

#include <Population.h>

Inheritance diagram for Population:

Public Member Functions

bool initialize (StateP state)
 Initialize population (serial ECF). More...
 
void registerParameters (StateP state)
 register population specific parameters
More...
 
void write (XMLNode &)
 Write population to XMLNode (serial ECF). More...
 
void read (XMLNode &)
 Read population from XMLNode (serial ECF). Population must be initialize()-d beforehand! More...
 
void updateDemeStats ()
 Update, gather and write statistics of all demes; update and gather HallOfFame of all demes. More...
 
uint getNoDemes ()
 return total number of demes More...
 
uint getLocalDemeId ()
 return local deme index (local process in parallel ECF) More...
 
DemeP getLocalDeme ()
 get first deme (local deme in parallel ECF) More...
 
HallOfFameP getHof ()
 get population HallofFame More...
 
StatCalcP getStats ()
 get population stats More...
 

Protected Attributes

uint nDemes_
 total number of demes in the population More...
 
uint myDemeIndex_
 global index of local deme (at local process) - PECF only More...
 
uint nIndividuals_
 number of individuals (in each deme!) More...
 
StateP state_
 
HallOfFameP hof_
 population HallOfFame More...
 
StatCalcP stats_
 population statistics More...
 

Detailed Description

Population class - inherits a vector of Deme objects.

Population may consist of one or more demes. The demes evolve independently of each other.

Parallel ECF: Population object of each process contains only one Deme (called the local Deme)!

Definition at line 14 of file Population.h.

Constructor & Destructor Documentation

◆ Population()

Population::Population ( )

Definition at line 5 of file Population.cpp.

Member Function Documentation

◆ getHof()

HallOfFameP Population::getHof ( )
inline

get population HallofFame

Definition at line 37 of file Population.h.

◆ getLocalDeme()

DemeP Population::getLocalDeme ( )
inline

get first deme (local deme in parallel ECF)

Definition at line 35 of file Population.h.

◆ getLocalDemeId()

uint Population::getLocalDemeId ( )
inline

return local deme index (local process in parallel ECF)

Definition at line 33 of file Population.h.

◆ getNoDemes()

uint Population::getNoDemes ( )
inline

return total number of demes

Definition at line 31 of file Population.h.

◆ getStats()

StatCalcP Population::getStats ( )
inline

get population stats

Definition at line 39 of file Population.h.

◆ initialize()

bool Population::initialize ( StateP  state)

Initialize population (serial ECF).

Initialize population (parallel ECF).

Definition at line 35 of file Population.cpp.

◆ read()

void Population::read ( XMLNode &  xPopulation)

Read population from XMLNode (serial ECF). Population must be initialize()-d beforehand!

Read population from XMLNode (parallel ECF). Population must be initialize()-d beforehand!

Definition at line 65 of file Population.cpp.

◆ registerParameters()

void Population::registerParameters ( StateP  state)

register population specific parameters

Definition at line 16 of file Population.cpp.

◆ updateDemeStats()

void Population::updateDemeStats ( )

Update, gather and write statistics of all demes; update and gather HallOfFame of all demes.

Update, gather and write statistics of all demes; update and gather HallOfFame of all demes. (parallel ECF)

Definition at line 100 of file Population.cpp.

◆ write()

void Population::write ( XMLNode &  xPopulation)

Write population to XMLNode (serial ECF).

Write population to XMLNode (parallel ECF).

Definition at line 80 of file Population.cpp.

Member Data Documentation

◆ hof_

HallOfFameP Population::hof_
protected

population HallOfFame

Definition at line 21 of file Population.h.

◆ myDemeIndex_

uint Population::myDemeIndex_
protected

global index of local deme (at local process) - PECF only

Definition at line 18 of file Population.h.

◆ nDemes_

uint Population::nDemes_
protected

total number of demes in the population

Definition at line 17 of file Population.h.

◆ nIndividuals_

uint Population::nIndividuals_
protected

number of individuals (in each deme!)

Definition at line 19 of file Population.h.

◆ state_

StateP Population::state_
protected

Definition at line 20 of file Population.h.

◆ stats_

StatCalcP Population::stats_
protected

population statistics

Definition at line 22 of file Population.h.


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