Function necsim::checkSpeciation

Function Documentation

bool necsim::checkSpeciation(const long double &random_number, const long double &speciation_rate, const unsigned long &no_generations)

Checks whether speciation has occured for the provided parameters. Provided here for ease of use when bug-fixing.

Return
bool the speciation state of the lineage
Parameters
  • random_number: the random number associated with a lineage
  • speciation_rate: the global speciation rate
  • number_of_generations: the number of generations the lineage has existed