TTDispersalSH Class Reference

The StatHandler for the evolving dispersal traits. More...

#include <ttdispersal.h>

Inheritance diagram for TTDispersalSH:

Collaboration diagram for TTDispersalSH:

Public Member Functions
	TTDispersalSH (TProtoDispersal *TT)
virtual	~TTDispersalSH ()
virtual void	init ()
virtual bool	setStatRecorders (std::string &token)
void	addDispPerPatch (sex_t SEX, age_t AGE)
double	getmeanOFD ()
double	getmeanOMD ()
double	getmeanFD ()
double	getmeanMD ()
double	getMeanDispRate ()
double	getOffsprgMeanDispRate ()
double	getMeanDispRate (sex_t sex)
double	getOffsprgMeanDispRate (sex_t sex)
double	getMeanFemDispRate ()
double	getMeanMalDispRate ()
double	getMeanDispRateInPatch (sex_t SEX, age_idx age, unsigned int traitidx, unsigned int i)
double	getPatchDisp_OF (unsigned int patch)
double	getPatchDisp_OM (unsigned int patch)
double	getPatchDisp_AF (unsigned int patch)
double	getPatchDisp_AM (unsigned int patch)
Public Member Functions inherited from StatHandler< TTDispersalSH >
	StatHandler ()
virtual	~StatHandler ()
virtual void	clear ()
	Empties the _recorders list, they are destroyed in StatHandlerBase::reset(). More...
virtual StatRecorder< TTDispersalSH > *	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	update ()
	This function is left empty as the StatServices calls StatRecorder::setVal directly. More...
Public Member Functions inherited from Handler
virtual	~Handler ()

Private Attributes
TProtoDispersal *	_trait
double	_meanFemDisp
double	_meanMalDisp
double	_meanOffFemDisp
double	_meanOffMalDisp
int	_fdispIdx
int	_mdispIdx

Additional Inherited Members
Protected Types inherited from StatHandler< TTDispersalSH >
typedef std::list< StatRecorder< TTDispersalSH > * >::iterator	REC_IT
Protected Attributes inherited from StatHandler< TTDispersalSH >
std::list< StatRecorder< TTDispersalSH > * >	_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

The StatHandler for the evolving dispersal traits.

Constructor & Destructor Documentation

TTDispersalSH()

TTDispersalSH::TTDispersalSH ( TProtoDispersal *  TT )

inline

  : _trait(TT),_meanFemDisp(0), _meanMalDisp(0), _meanOffFemDisp(0), _meanOffMalDisp(0), _fdispIdx(-1), _mdispIdx(-1) { }

~TTDispersalSH()

virtual TTDispersalSH::~TTDispersalSH ( )

inlinevirtual

{ }

Member Function Documentation

addDispPerPatch()

void TTDispersalSH::addDispPerPatch	(	sex_t	SEX,
		age_t	AGE
	)

{
  string sextag = (SEX == FEM ? "fem." : "mal.");
  string agetag = (AGE == OFFSPRG ? "off." : "adlt.");
 
  string statname;
 
  double (TTDispersalSH::* getter) (unsigned int);
 
  if(AGE == ADULTS) {
 
    if(SEX == FEM) getter = &TTDispersalSH::getPatchDisp_AF;
    else           getter = &TTDispersalSH::getPatchDisp_AM;
 
  } else {
 
    if(SEX == FEM) getter = &TTDispersalSH::getPatchDisp_OF;
    else           getter = &TTDispersalSH::getPatchDisp_OM;
 
  }
 
  for(unsigned int p = 0; p < _pop->getPatchNbr(); ++p)  {
 
    statname = agetag + sextag + "disp.p" + tstring::int2str(p+1);
 
    add("", statname, AGE, p, 0, 0, getter, 0, 0);
  }
  
}

References StatHandlerBase::_pop, StatHandler< TTDispersalSH >::add(), ADULTS, FEM, getPatchDisp_AF(), getPatchDisp_AM(), getPatchDisp_OF(), getPatchDisp_OM(), Metapop::getPatchNbr(), tstring::int2str(), and OFFSPRG.

Referenced by setStatRecorders().

getMeanDispRate() [1/2]

double TTDispersalSH::getMeanDispRate

(

)

{
  double meanDisp = 0;
  unsigned int fem = 0, mal = 0, tot = 0,i,j;
  Patch* crnt_patch;
  
  _meanFemDisp = 0;
  _meanMalDisp = 0;
  
  for( i = 0; i < _pop->getPatchNbr(); ++i) {
        crnt_patch = _pop->getPatch(i);
    for( j = 0; j < crnt_patch->size(FEM, ADLTx); ++j) {
      _meanFemDisp += *(double*)crnt_patch->get(FEM, ADLTx, j)->getTraitValue(_fdispIdx);
      fem++;
    }
    for( j = 0; j < crnt_patch->size(MAL, ADLTx);++j) {
      _meanMalDisp += *(double*)crnt_patch->get(MAL, ADLTx, j)->getTraitValue(_mdispIdx);
      mal++;
    }
  }
  meanDisp = _meanFemDisp + _meanMalDisp;
  tot = fem + mal;
  _meanFemDisp = (fem != 0 ? _meanFemDisp/fem : 0.0);
  _meanMalDisp = (mal != 0 ? _meanMalDisp/mal : 0.0);
  
  return (tot != 0 ? meanDisp/tot : nanf("NULL"));
}

References _fdispIdx, _mdispIdx, _meanFemDisp, _meanMalDisp, StatHandlerBase::_pop, ADLTx, FEM, Patch::get(), Metapop::getPatch(), Metapop::getPatchNbr(), Individual::getTraitValue(), MAL, and Patch::size().

Referenced by setStatRecorders().

getMeanDispRate() [2/2]

double TTDispersalSH::getMeanDispRate

(

sex_t

sex

)

{
  double meanDispRate = 0;
  unsigned int i,j,indnbr = 0, traitidx = (sex == FEM ? _fdispIdx : _mdispIdx);
  Patch* crnt_patch;
 
  for( i=0;i<_pop->getPatchNbr();++i) {
    crnt_patch = _pop->getPatch(i);
    for( j=0;j<crnt_patch->size(sex, ADLTx);++j) {
      meanDispRate += *(double*)crnt_patch->get(sex, ADLTx, j)->getTraitValue( traitidx );
      indnbr++;
    }
  }
  
  return (indnbr != 0 ? meanDispRate/indnbr : nanf("NULL"));
}

References _fdispIdx, _mdispIdx, StatHandlerBase::_pop, ADLTx, FEM, Patch::get(), Metapop::getPatch(), Metapop::getPatchNbr(), Individual::getTraitValue(), and Patch::size().

getMeanDispRateInPatch()

double TTDispersalSH::getMeanDispRateInPatch	(	sex_t	SEX,
		age_idx	age,
		unsigned int	traitidx,
		unsigned int	i
	)

{
  double meanDisp = 0;
  unsigned int tot = 0;
 
  Patch* crnt_patch = _pop->getPatchPtr(i);
 
  for(unsigned int j = 0; j < crnt_patch->size(SEX, age); ++j) {
    meanDisp += *(double*)crnt_patch->get(SEX, age, j)->getTraitValue(traitidx);
    tot++;
  }
 
  return (tot != 0 ? meanDisp/tot : nanf("NULL"));
}

References StatHandlerBase::_pop, Patch::get(), Metapop::getPatchPtr(), Individual::getTraitValue(), and Patch::size().

Referenced by getPatchDisp_AF(), getPatchDisp_AM(), getPatchDisp_OF(), and getPatchDisp_OM().

getmeanFD()

double TTDispersalSH::getmeanFD ( )

inline

{return _meanFemDisp;}

References _meanFemDisp.

Referenced by setStatRecorders().

getMeanFemDispRate()

double TTDispersalSH::getMeanFemDispRate

(

)

{
  double meanDispRate = 0;
  unsigned int indnbr = 0;
  Patch* crnt_patch;
  
  for(unsigned int i = 0; i < _pop->getPatchNbr(); ++i) {
    
        crnt_patch = _pop->getPatch(i);
    
    for(unsigned int j = 0, size = crnt_patch->size(FEM, ADLTx); j < size; ++j) 
          meanDispRate += *(double*)crnt_patch->get(FEM, ADLTx, j)->getTraitValue(_fdispIdx);
  }
  indnbr = _pop->size(FEM, ADULTS);
  return (indnbr != 0 ? meanDispRate/indnbr : nanf("NULL"));
}

References _fdispIdx, StatHandlerBase::_pop, ADLTx, ADULTS, FEM, Patch::get(), Metapop::getPatch(), Metapop::getPatchNbr(), Individual::getTraitValue(), Metapop::size(), and Patch::size().

getMeanMalDispRate()

double TTDispersalSH::getMeanMalDispRate

(

)

{
  double meanDispRate = 0;
  unsigned int indnbr = 0;
  Patch* crnt_patch;
  
  for(unsigned int i = 0; i < _pop->getPatchNbr(); ++i) {
        
    crnt_patch = _pop->getPatch(i);
        
    for(unsigned int j = 0, size = crnt_patch->size(MAL, ADLTx); j < size; ++j) 
          meanDispRate += *(double*)crnt_patch->get(MAL, ADLTx, j)->getTraitValue(_mdispIdx);
  }
  indnbr = _pop->size(MAL, ADULTS);
  return (indnbr != 0 ? meanDispRate/indnbr : nanf("NULL"));
}

References _mdispIdx, StatHandlerBase::_pop, ADLTx, ADULTS, Patch::get(), Metapop::getPatch(), Metapop::getPatchNbr(), Individual::getTraitValue(), MAL, Metapop::size(), and Patch::size().

getmeanMD()

double TTDispersalSH::getmeanMD ( )

inline

{return _meanMalDisp;}

References _meanMalDisp.

Referenced by setStatRecorders().

getmeanOFD()

double TTDispersalSH::getmeanOFD ( )

inline

{return _meanOffFemDisp;}

References _meanOffFemDisp.

Referenced by setStatRecorders().

getmeanOMD()

double TTDispersalSH::getmeanOMD ( )

inline

{return _meanOffMalDisp;}

References _meanOffMalDisp.

Referenced by setStatRecorders().

getOffsprgMeanDispRate() [1/2]

double TTDispersalSH::getOffsprgMeanDispRate

(

)

{
  double meanDisp = 0;
  unsigned int fem = 0, mal = 0, tot = 0;
  Patch* crnt_patch;
  
  _meanOffFemDisp = 0;
  _meanOffMalDisp = 0;
  
  for(unsigned int i = 0; i < _pop->getPatchNbr(); ++i) {
    
        crnt_patch = _pop->getPatch(i);
    
    for(unsigned int j = 0, size = crnt_patch->size(FEM, OFFSx); j < size; ++j)
      _meanOffFemDisp += *(double*)crnt_patch->get( FEM, OFFSx, j )->getTraitValue( _fdispIdx );
    
    for(unsigned int j = 0, size = crnt_patch->size(MAL, OFFSx); j < size; ++j)
      _meanOffMalDisp += *(double*)crnt_patch->get( MAL, OFFSx, j )->getTraitValue( _mdispIdx );
 
  }
 
  meanDisp = _meanOffFemDisp + _meanOffMalDisp;
  _meanOffFemDisp = ( (fem = _pop->size(FEM, OFFSPRG)) != 0 ? _meanOffFemDisp/fem : 0.0);
  _meanOffMalDisp = ( (mal = _pop->size(MAL, OFFSPRG)) != 0 ? _meanOffMalDisp/mal : 0.0);
  
  return ( (tot = _pop->size(OFFSPRG)) != 0 ? meanDisp/tot : nanf("NULL"));
}

References _fdispIdx, _mdispIdx, _meanOffFemDisp, _meanOffMalDisp, StatHandlerBase::_pop, FEM, Patch::get(), Metapop::getPatch(), Metapop::getPatchNbr(), Individual::getTraitValue(), MAL, OFFSPRG, OFFSx, Metapop::size(), and Patch::size().

Referenced by setStatRecorders().

getOffsprgMeanDispRate() [2/2]

double TTDispersalSH::getOffsprgMeanDispRate

(

sex_t

sex

)

{
  double meanDispRate = 0;
  unsigned int indnbr = 0;
  int TType = (sex == FEM ? _fdispIdx : _mdispIdx);
  Patch* crnt_patch;
  
  if(sex) {
    
    for(unsigned int i = 0; i < _pop->getPatchNbr(); ++i){
      
      crnt_patch = _pop->getPatch(i);
      
      for(unsigned int j = 0, size = crnt_patch->size(FEM, OFFSx); j < size; ++j)
        meanDispRate += *(double*)crnt_patch->get( FEM, OFFSx, j )->getTraitValue(TType);
    }    
    indnbr = _pop->size(FEM, OFFSPRG);
    
  } else {
    
    for(unsigned int i = 0; i < _pop->getPatchNbr(); ++i){
      
      crnt_patch = _pop->getPatch(i);
      
      for(unsigned int j = 0, size = crnt_patch->size(MAL, OFFSx); j < size; ++j)
        meanDispRate += *(double*)crnt_patch->get( MAL, OFFSx, j )->getTraitValue(TType);
    }    
    indnbr = _pop->size(MAL, OFFSPRG);
  }
  
  return (indnbr != 0 ? meanDispRate/indnbr : nanf("NULL"));
}

References _fdispIdx, _mdispIdx, StatHandlerBase::_pop, FEM, Patch::get(), Metapop::getPatch(), Metapop::getPatchNbr(), Individual::getTraitValue(), MAL, OFFSPRG, OFFSx, Metapop::size(), and Patch::size().

getPatchDisp_AF()

double TTDispersalSH::getPatchDisp_AF ( unsigned int  patch )

inline

  {
    return getMeanDispRateInPatch(FEM, ADLTx, _fdispIdx, patch);
  }

References _fdispIdx, ADLTx, FEM, and getMeanDispRateInPatch().

Referenced by addDispPerPatch().

getPatchDisp_AM()

double TTDispersalSH::getPatchDisp_AM ( unsigned int  patch )

inline

  {
    return getMeanDispRateInPatch(MAL, ADLTx, _mdispIdx, patch);
  }

References _mdispIdx, ADLTx, getMeanDispRateInPatch(), and MAL.

Referenced by addDispPerPatch().

getPatchDisp_OF()

double TTDispersalSH::getPatchDisp_OF ( unsigned int  patch )

inline

  {
    return getMeanDispRateInPatch(FEM, OFFSx, _fdispIdx, patch);
  }

References _fdispIdx, FEM, getMeanDispRateInPatch(), and OFFSx.

Referenced by addDispPerPatch().

getPatchDisp_OM()

double TTDispersalSH::getPatchDisp_OM ( unsigned int  patch )

inline

  {
    return getMeanDispRateInPatch(MAL, OFFSx, _mdispIdx, patch);
  }

References _mdispIdx, getMeanDispRateInPatch(), MAL, and OFFSx.

Referenced by addDispPerPatch().

init()

virtual void TTDispersalSH::init ( )

inlinevirtual

Reimplemented from StatHandlerBase.

  { 
    StatHandlerBase::init(); 
    _fdispIdx = _pop->getTraitIndex(FDISP); 
    _mdispIdx = _pop->getTraitIndex(MDISP);
  }

References _fdispIdx, _mdispIdx, StatHandlerBase::_pop, FDISP, IndFactory::getTraitIndex(), StatHandlerBase::init(), and MDISP.

setStatRecorders()

bool TTDispersalSH::setStatRecorders ( std::string &  token )

virtual

Implements StatHandlerBase.

{
#ifdef _DEBUG_
  message("-TTDispersalSH::setStatRecorders ");
#endif
  if(token == "disp") {
 
    add("Dispersal rate (offspring)        ","off.disp",OFFSPRG,0,0,&TTDispersalSH::getOffsprgMeanDispRate,0,0,0);
    add("Dispersal rate (offspring females)","off.fdisp",OFFSPRG,0,0,&TTDispersalSH::getmeanOFD,0,0,0);
    add("Dispersal rate (offspring males)  ","off.mdisp",OFFSPRG,0,0,&TTDispersalSH::getmeanOMD,0,0,0);
 
    add("Dispersal rate (adults)       ","adlt.disp",ADULTS,0,0,&TTDispersalSH::getMeanDispRate,0,0,0);
    add("Dispersal rate (adult females)","adlt.fdisp",ADULTS,0,0,&TTDispersalSH::getmeanFD,0,0,0);
    add("Dispersal rate (adult males)  ","adlt.mdisp",ADULTS,0,0,&TTDispersalSH::getmeanMD,0,0,0);
 
  } else if(token == "adlt.disp") {
 
    add("Dispersal rate (adults)       ","adlt.disp",ADULTS,0,0,&TTDispersalSH::getMeanDispRate,0,0,0);
    add("Dispersal rate (adult females)","adlt.fdisp",ADULTS,0,0,&TTDispersalSH::getmeanFD,0,0,0);
    add("Dispersal rate (adult males)  ","adlt.mdisp",ADULTS,0,0,&TTDispersalSH::getmeanMD,0,0,0);
 
  } else if(token== "off.disp") {
 
    add("Dispersal rate (offspring)        ","off.disp",OFFSPRG,0,0,&TTDispersalSH::getOffsprgMeanDispRate,0,0,0);
    add("Dispersal rate (offspring females)","off.fdisp",OFFSPRG,0,0,&TTDispersalSH::getmeanOFD,0,0,0);
    add("Dispersal rate (offspring males)  ","off.mdisp",OFFSPRG,0,0,&TTDispersalSH::getmeanOMD,0,0,0);
 
  } else if(token == "off.disp.patch") {
 
    addDispPerPatch(FEM, OFFSPRG);
    addDispPerPatch(MAL, OFFSPRG);
 
  } else if(token == "adlt.disp.patch") {
 
    addDispPerPatch(FEM, ADULTS);
    addDispPerPatch(MAL, ADULTS);
 
  } else if(token == "off.fem.disp.patch") {
 
    addDispPerPatch(FEM, OFFSPRG);
 
  } else if(token == "adlt.fem.disp.patch") {
 
    addDispPerPatch(FEM, ADULTS);
 
  } else if(token == "off.mal.disp.patch") {
 
    addDispPerPatch(MAL, OFFSPRG);
 
  } else if(token == "adlt.mal.disp.patch") {
 
    addDispPerPatch(MAL, ADULTS);
 
  } else
    return false;
 
  return true;
}

References StatHandler< TTDispersalSH >::add(), addDispPerPatch(), ADULTS, FEM, getMeanDispRate(), getmeanFD(), getmeanMD(), getmeanOFD(), getmeanOMD(), getOffsprgMeanDispRate(), MAL, message(), and OFFSPRG.

Member Data Documentation

_fdispIdx

int TTDispersalSH::_fdispIdx

private

Referenced by getMeanDispRate(), getMeanFemDispRate(), getOffsprgMeanDispRate(), getPatchDisp_AF(), getPatchDisp_OF(), and init().

_mdispIdx

int TTDispersalSH::_mdispIdx

private

Referenced by getMeanDispRate(), getMeanMalDispRate(), getOffsprgMeanDispRate(), getPatchDisp_AM(), getPatchDisp_OM(), and init().

_meanFemDisp

double TTDispersalSH::_meanFemDisp

private

Referenced by getMeanDispRate(), and getmeanFD().

_meanMalDisp

double TTDispersalSH::_meanMalDisp

private

Referenced by getMeanDispRate(), and getmeanMD().

_meanOffFemDisp

double TTDispersalSH::_meanOffFemDisp

private

Referenced by getmeanOFD(), and getOffsprgMeanDispRate().

_meanOffMalDisp

double TTDispersalSH::_meanOffMalDisp

private

Referenced by getmeanOMD(), and getOffsprgMeanDispRate().

_trait

TProtoDispersal* TTDispersalSH::_trait

private

---

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

• ttdispersal.h
• stats_disp.cc
• ttdispersal.cc