Egglib 2.1.11
C++ library reference manual
Public Member Functions | Protected Attributes | List of all members
PopulationFusion Class Reference

Fusion of two populations. More...

#include <ChangeTypes.hpp>

Inheritance diagram for PopulationFusion:
Change

Public Member Functions

 PopulationFusion ()
 Default constructor. More...
 
 PopulationFusion (double date, unsigned int mother, unsigned int daughter)
 Standard constructor. More...
 
void apply (ParamSet *paramSet, Controller *controller) const
 Applies the event. More...
 
void daughter (unsigned int)
 Sets the daughter population.
 
unsigned int daughter () const
 Gets the daughter population.
 
void mother (unsigned int)
 Sets the mother population.
 
unsigned int mother () const
 Gets the mother population.
 
- Public Member Functions inherited from Change
 Change ()
 Default constructor. More...
 
 Change (double date)
 Standard constructor. More...
 
double date () const
 Gets the event date value.
 
void date (double value)
 Sets the event date value.
 

Protected Attributes

unsigned int _mother
 
unsigned int _daughter
 
- Protected Attributes inherited from Change
double _date
 

Detailed Description

Fusion of two populations.

Constructor & Destructor Documentation

Default constructor.

The default date is 0., the default mother is 0, the default daughter is 0.

PopulationFusion ( double  date,
unsigned int  mother,
unsigned int  daughter 
)

Standard constructor.

Parameters
datethe date of the event.
motherfirst population to merge.
daughtersecond population to merge.

A time date, all the lineages from the daughter population are moved to the mother population and all mutation rates to the daughter population are cancelled. This functions emulates a population split (forward in time).

Member Function Documentation

void apply ( ParamSet paramSet,
Controller controller 
) const
virtual

Applies the event.

Parameters
paramSetthe ParamSet instance to which the Change instance is attached.
controllerthe Controller instance of the simulation.

Implements Change.


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

Hosted by 
Get EggLib at SourceForge.net. Fast, secure and Free Open Source software downloads