LCE_SelectionSH Class Reference

StatHandler class for the LCE_Selection class. More...

#include <LCEselection.h>

Inheritance diagram for LCE_SelectionSH:

Collaboration diagram for LCE_SelectionSH:

Public Member Functions
	LCE_SelectionSH (LCE_Selection_base *event)
virtual	~LCE_SelectionSH ()
virtual bool	setStatRecorders (string &token)
void	addMeanPerPatch (age_t AGE)
void	addVarPerPatch (age_t AGE)
void	setDataTable (age_t AGE)
void	setAdultTable ()
void	setOffsprgTable ()
double	getMeanFitness ()
double	getFitness (unsigned int i)
double	getSurvival (unsigned int i)
double	getPedProp (unsigned int i)
double	getMeanPatchFitness (unsigned int i, unsigned int int_agex)
double	getMeanPatchFitness (unsigned int i)
double	getVarPatchFitness (unsigned int i, unsigned int int_agex)
Public Member Functions inherited from EventStatHandler< LCE_Selection_base, LCE_SelectionSH >
	EventStatHandler (LCE_Selection_base *lce)
virtual	~EventStatHandler ()
Public Member Functions inherited from StatHandler< SH >
	StatHandler ()
virtual	~StatHandler ()
virtual void	clear ()
	Empties the _recorders list, they are destroyed in StatHandlerBase::reset(). More...
virtual StatRecorder< SH > *	add (std::string Title, std::string Name, age_t AGE, unsigned int ARG1, unsigned int ARG2, double(SH::*getStatNoArg)(void), double(SH::*getStatOneArg)(unsigned int), double(SH::*getStatTwoArg)(unsigned int, unsigned int), void(SH::*setStat)(void))
	Adds a StatRecorder to the list, it is also added to the StatHandlerBase::_stats list. More...
Public Member Functions inherited from StatHandlerBase
	StatHandlerBase ()
virtual	~StatHandlerBase ()
virtual void	reset ()
	Empties the _stats list and calls clear() (defined in the derived class). More...
Metapop *	get_pop_ptr ()
void	set_service (StatServices *srv)
StatServices *	get_service ()
unsigned int	getOccurrence ()
unsigned int	getNumOccurrences ()
unsigned int	getCurrentOccurrence ()
unsigned int	getNbRecorders ()
std::list< StatRecBase * > &	getStats ()
virtual void	add (StatRecBase *rec)
virtual void	init ()
virtual void	update ()
	This function is left empty as the StatServices calls StatRecorder::setVal directly. More...
Public Member Functions inherited from Handler
virtual	~Handler ()

Private Attributes
vector< vector< double > >	_phenoTable
unsigned int	_table_set_gen
unsigned int	_table_set_age
unsigned int	_table_set_repl

Additional Inherited Members
Protected Types inherited from StatHandler< SH >
typedef std::list< StatRecorder< SH > * >::iterator	REC_IT
Protected Attributes inherited from EventStatHandler< LCE_Selection_base, LCE_SelectionSH >
LCE_Selection_base *	_SHLinkedEvent
	Pointer to the linked LCE. More...
Protected Attributes inherited from StatHandler< SH >
std::list< StatRecorder< SH > * >	_recorders
	The list of stat recorders. More...
Protected Attributes inherited from StatHandlerBase
Metapop *	_pop
	Link to the current population, set through the link to the StatService. More...

Detailed Description

StatHandler class for the LCE_Selection class.

Records the fitness stats.

Constructor & Destructor Documentation

LCE_SelectionSH()

LCE_SelectionSH::LCE_SelectionSH ( LCE_Selection_base *  event )

inline

                                              :
  EventStatHandler< LCE_Selection_base, LCE_SelectionSH > (event),
  _table_set_gen(999999), _table_set_age(999999), _table_set_repl(999999)
  {}

~LCE_SelectionSH()

virtual LCE_SelectionSH::~LCE_SelectionSH ( )

inlinevirtual

{}

Member Function Documentation

addMeanPerPatch()

void LCE_SelectionSH::addMeanPerPatch

(

age_t

AGE

)

{
  unsigned int patchNbr = _pop->getPatchNbr();
  
  if (AGE == ALL) {
    addMeanPerPatch(ADULTS);
    addMeanPerPatch(OFFSPRG);
    return;
  }
  
  string suffix = (AGE == ADULTS ? "adlt.":"off."); //at this stage, AGE != ALL
  string name = suffix + "W.avg.p";
  string long_name = "Mean fitness in patch ";
  string patch;
 
  void (LCE_SelectionSH::* setter) (void) = (AGE == ADULTS ?
                                             &LCE_SelectionSH::setAdultTable : 
                                             &LCE_SelectionSH::setOffsprgTable);
 
  unsigned int int_agex = static_cast<age_idx> ((AGE == ADULTS ? ADLTx : OFFSx));
 
  //first patch, gets the data table setter:
  add(long_name + "1", name + "1", AGE, 0, int_agex, 
      0,0,&LCE_SelectionSH::getMeanPatchFitness, setter);
 
  for(unsigned int p = 1; p < patchNbr; p++) {
    patch = tstring::int2str(p+1);
    add(long_name + patch, name + patch, AGE, p, int_agex,
        0,0,&LCE_SelectionSH::getMeanPatchFitness,0);
  }
}

References StatHandlerBase::_pop, StatHandler< SH >::add(), ADLTx, ADULTS, ALL, getMeanPatchFitness(), Metapop::getPatchNbr(), tstring::int2str(), OFFSPRG, OFFSx, setAdultTable(), and setOffsprgTable().

Referenced by setStatRecorders().

addVarPerPatch()

void LCE_SelectionSH::addVarPerPatch

(

age_t

AGE

)

{
  unsigned int patchNbr = _pop->getPatchNbr();
  
  if (AGE == ALL) {
    addVarPerPatch(ADULTS);
    addVarPerPatch(OFFSPRG);
    return;
  }
  
  string suffix = (AGE == ADULTS ? "adlt.":"off."); //at this stage, AGE != ALL
  string name = suffix + "W.var.p";
  string long_name = "Var fitness in patch ";
  string patch;
 
  void (LCE_SelectionSH::* setter) (void) = (AGE == ADULTS ?
                                             &LCE_SelectionSH::setAdultTable : 
                                             &LCE_SelectionSH::setOffsprgTable);
  
  unsigned int int_agex = static_cast<age_idx> ((AGE == ADULTS ? ADLTx : OFFSx));
  
  //first patch, gets the data table setter:
  add(long_name + "1", name + "1", AGE, 0, int_agex, 
      0,0,&LCE_SelectionSH::getVarPatchFitness, setter);
  
  for(unsigned int p = 1; p < patchNbr; p++) {
    patch = tstring::int2str(p+1);
    add(long_name + patch, name + patch, AGE, p, int_agex,
        0,0,&LCE_SelectionSH::getVarPatchFitness,0);
  }
}

References StatHandlerBase::_pop, StatHandler< SH >::add(), ADLTx, ADULTS, ALL, Metapop::getPatchNbr(), getVarPatchFitness(), tstring::int2str(), OFFSPRG, OFFSx, setAdultTable(), and setOffsprgTable().

Referenced by setStatRecorders().

getFitness()

double LCE_SelectionSH::getFitness ( unsigned int  i )

inline

{return _SHLinkedEvent->_fitness[i];}

References LCE_Selection_base::_fitness, and EventStatHandler< LCE_Selection_base, LCE_SelectionSH >::_SHLinkedEvent.

Referenced by setStatRecorders().

getMeanFitness()

double LCE_SelectionSH::getMeanFitness ( )

inline

{return _SHLinkedEvent->_mean_fitness;}

References LCE_Selection_base::_mean_fitness, and EventStatHandler< LCE_Selection_base, LCE_SelectionSH >::_SHLinkedEvent.

Referenced by setStatRecorders().

getMeanPatchFitness() [1/2]

double LCE_SelectionSH::getMeanPatchFitness

(

unsigned int

i

)

{
  double mean = 0;
  unsigned int size = _phenoTable[i].size();
  
  for(unsigned int j = 0; j < size; j++)
    mean += _phenoTable[i][j];
  
  return mean/size;
}

References _phenoTable.

getMeanPatchFitness() [2/2]

double LCE_SelectionSH::getMeanPatchFitness	(	unsigned int	i,
		unsigned int	int_agex
	)

{
  age_idx age = static_cast<age_idx> (int_agex);
  unsigned int patch_size = _pop->getPatchPtr(i)->size(age);
 
  assert(patch_size == _phenoTable[i].size());
  
  if(patch_size == 0) return (nanf("NULL"));
  
  return getMeanPatchFitness(i);
}

References _phenoTable, StatHandlerBase::_pop, Metapop::getPatchPtr(), and Patch::size().

Referenced by addMeanPerPatch(), and getVarPatchFitness().

getPedProp()

double LCE_SelectionSH::getPedProp ( unsigned int  i )

inline

{return _SHLinkedEvent->_ind_cntr[i];}

References LCE_Selection_base::_ind_cntr, and EventStatHandler< LCE_Selection_base, LCE_SelectionSH >::_SHLinkedEvent.

Referenced by setStatRecorders().

getSurvival()

double LCE_SelectionSH::getSurvival ( unsigned int  i )

inline

{return _SHLinkedEvent->_survival[i];}

References EventStatHandler< LCE_Selection_base, LCE_SelectionSH >::_SHLinkedEvent, and LCE_Selection_base::_survival.

Referenced by setStatRecorders().

getVarPatchFitness()

double LCE_SelectionSH::getVarPatchFitness	(	unsigned int	i,
		unsigned int	int_agex
	)

{
  age_idx age = static_cast<age_idx> (int_agex);
  unsigned int patch_size = _pop->getPatchPtr(i)->size(age);
  
  assert(patch_size == _phenoTable[i].size());
  
  if(patch_size == 0) return nanf("NULL");
  
  double mean = getMeanPatchFitness(i);
  double var = 0;
  
  for(unsigned int j = 0; j < patch_size; j++) {
    
    var += pow(_phenoTable[i][j] - mean, 2.0);
  }
    
  return var/patch_size;
}

References _phenoTable, StatHandlerBase::_pop, getMeanPatchFitness(), Metapop::getPatchPtr(), and Patch::size().

Referenced by addVarPerPatch().

setAdultTable()

void LCE_SelectionSH::setAdultTable ( )

inline

{setDataTable(ADULTS);}

References ADULTS, and setDataTable().

Referenced by addMeanPerPatch(), and addVarPerPatch().

setDataTable()

void LCE_SelectionSH::setDataTable

(

age_t

AGE

)

{
  if(_table_set_age == AGE 
     && _table_set_gen == _pop->getCurrentGeneration()
     && _table_set_repl == _pop->getCurrentReplicate()
     ) return;
  
  unsigned int patchNbr = _pop->getPatchNbr();
 
  if(_phenoTable.size() != patchNbr) {
    if(_phenoTable.size() < patchNbr) {
      while (_phenoTable.size() < patchNbr)
        _phenoTable.push_back(vector<double>());
    } else {
      while (_phenoTable.size() > patchNbr) {
        _phenoTable.pop_back();
      }
    }
  }
 
  for(unsigned int i = 0; i < patchNbr; ++i) {
    _phenoTable[i].assign(_pop->size(AGE, i),0);
  }
    
  Patch* patch;
  
  age_idx age = (AGE == ADULTS ? ADLTx : OFFSx);
  
  for(unsigned int i = 0, n; i < patchNbr; i++) {
    
    
    patch = _pop->getPatch(i);
    
    
    if( !_SHLinkedEvent->_is_absolute ) {
      if(_SHLinkedEvent->_is_local)
        _SHLinkedEvent->setScalingFactorLocal(age, i);
      else
        _SHLinkedEvent->setScalingFactorGlobal(age, i);
    }
    
    n = 0;
    
    for(unsigned int j = 0, size = patch->size(FEM, age); 
        j < size && n < _phenoTable[i].size(); 
        j++)
    {
      _phenoTable[i][n++] = _SHLinkedEvent->getFitness( patch->get(FEM, age, j), i);
    }
    
    for(unsigned int j = 0, size = patch->size(MAL, age); 
        j < size && n < _phenoTable[i].size(); 
        j++)
    {
      _phenoTable[i][n++] = _SHLinkedEvent->getFitness( patch->get(MAL, age, j), i);
    }
     
    
    if (n != _phenoTable[i].size()) {
      fatal("problem while recording fitness trait values; size counter doesn't match table size.\n");
    }
  }
  
  _table_set_age  = AGE;
  _table_set_gen  = _pop->getCurrentGeneration();
  _table_set_repl = _pop->getCurrentReplicate();
  
}

References LCE_Selection_base::_is_absolute, LCE_Selection_base::_is_local, _phenoTable, StatHandlerBase::_pop, EventStatHandler< LCE_Selection_base, LCE_SelectionSH >::_SHLinkedEvent, _table_set_age, _table_set_gen, _table_set_repl, ADLTx, ADULTS, fatal(), FEM, Patch::get(), Metapop::getCurrentGeneration(), Metapop::getCurrentReplicate(), LCE_Selection_base::getFitness(), Metapop::getPatch(), Metapop::getPatchNbr(), MAL, OFFSx, LCE_Selection_base::setScalingFactorGlobal(), LCE_Selection_base::setScalingFactorLocal(), Metapop::size(), and Patch::size().

Referenced by setAdultTable(), and setOffsprgTable().

setOffsprgTable()

void LCE_SelectionSH::setOffsprgTable ( )

inline

{setDataTable(OFFSPRG);}

References OFFSPRG, and setDataTable().

Referenced by addMeanPerPatch(), and addVarPerPatch().

setStatRecorders()

bool LCE_SelectionSH::setStatRecorders ( string &  token )

virtual

Implements StatHandlerBase.

{
  string age_tag = token.substr(0,token.find_first_of("."));
  string sub_token;
  age_t AGE = ALL;
  
  if (age_tag.size() != 0 && age_tag.size() != string::npos) {
    
    if (age_tag == "adlt") AGE = ADULTS;
    
    else if (age_tag == "off") AGE = OFFSPRG;
    
    else age_tag = "";
    
  } else {
    age_tag = "";
  }
  
  if (age_tag.size() != 0) 
    sub_token = token.substr(token.find_first_of(".") + 1, string::npos);
  else
    sub_token = token;
  
  if(sub_token == "fitness") {
    add("Mean population fitness","fitness.mean",ALL,0,0,&LCE_SelectionSH::getMeanFitness,0,0,0);
    add("Mean population fitness","fitness.outb",ALL,0,0,0,&LCE_SelectionSH::getFitness,0,0);
    add("Mean population fitness","fitness.outw",ALL,1,0,0,&LCE_SelectionSH::getFitness,0,0);
    add("Mean population fitness","fitness.hsib",ALL,2,0,0,&LCE_SelectionSH::getFitness,0,0);
    add("Mean population fitness","fitness.fsib",ALL,3,0,0,&LCE_SelectionSH::getFitness,0,0);
    add("Mean population fitness","fitness.self",ALL,4,0,0,&LCE_SelectionSH::getFitness,0,0);
  } else if(sub_token == "survival") {
    add("Mean offspring survival","survival.outb",ALL,0,0,0,&LCE_SelectionSH::getSurvival,0,0);
    add("Mean offspring survival","survival.outw",ALL,1,0,0,&LCE_SelectionSH::getSurvival,0,0);
    add("Mean offspring survival","survival.hsib",ALL,2,0,0,&LCE_SelectionSH::getSurvival,0,0);
    add("Mean offspring survival","survival.fsib",ALL,3,0,0,&LCE_SelectionSH::getSurvival,0,0);
    add("Mean offspring survival","survival.self",ALL,4,0,0,&LCE_SelectionSH::getSurvival,0,0);
  } else if(sub_token == "fitness.prop") {
    add("Proportion of b/n demes outbreds","prop.outb",ALL,0,0,0,&LCE_SelectionSH::getPedProp,0,0);
    add("Proportion of w/n demes outbreds","prop.outw",ALL,1,0,0,&LCE_SelectionSH::getPedProp,0,0);
    add("Proportion of half-sib crossings","prop.hsib",ALL,2,0,0,&LCE_SelectionSH::getPedProp,0,0);
    add("Proportion of full-sib crossings","prop.fsib",ALL,3,0,0,&LCE_SelectionSH::getPedProp,0,0);
    add("Proportion of selfed progeny","prop.self",ALL,4,0,0,&LCE_SelectionSH::getPedProp,0,0);
    
  } else if(sub_token == "fitness.patch") {
    
    addMeanPerPatch(AGE);  
    
  } else if(sub_token == "fitness.var.patch") {
    
    addVarPerPatch(AGE);
    
  } else return false;
  
  return true;
}

References StatHandler< SH >::add(), addMeanPerPatch(), addVarPerPatch(), ADULTS, ALL, getFitness(), getMeanFitness(), getPedProp(), getSurvival(), and OFFSPRG.

Member Data Documentation

_phenoTable

vector< vector< double > > LCE_SelectionSH::_phenoTable

private

Referenced by getMeanPatchFitness(), getVarPatchFitness(), and setDataTable().

_table_set_age

unsigned int LCE_SelectionSH::_table_set_age

private

Referenced by setDataTable().

_table_set_gen

unsigned int LCE_SelectionSH::_table_set_gen

private

Referenced by setDataTable().

_table_set_repl

unsigned int LCE_SelectionSH::_table_set_repl

private

Referenced by setDataTable().

---

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

• LCEselection.h
• LCEselection.cc