Class SpeciesAbundancesHandler¶
- Defined in File SpeciesAbundancesHandler.h
Inheritance Relationships¶
Derived Types¶
public necsim::AnalyticalSpeciesAbundancesHandler
(Class AnalyticalSpeciesAbundancesHandler)public necsim::SimulatedSpeciesAbundancesHandler
(Class SimulatedSpeciesAbundancesHandler)
Class Documentation¶
-
class
SpeciesAbundancesHandler
¶ Base class for defining species abundances.
Subclassed by necsim::AnalyticalSpeciesAbundancesHandler, necsim::SimulatedSpeciesAbundancesHandler
Public Functions
-
SpeciesAbundancesHandler
()¶ Default constructor.
-
virtual
~SpeciesAbundancesHandler
()¶ Default destructor.
Creates the SpeciesAbundancesHandler object.
- Parameters
random
: the random number generatormetacommunity_size
: the number of individuals in the metacommunityspeciation_rate
: the speciation rate of the metacommunitylocal_community_size
: the number of individuals in the local community
-
virtual unsigned long
getRandomSpeciesID
() = 0¶ Gets a randomly generated species identity.
- Return
- the species identity
Sets the abundance list.
- Parameters
abundance_list_in
: list of abundances for each species
Sets the abundance list.
- Parameters
abundance_list_in
: list of abundances for each species
Protected Attributes
-
shared_ptr<RNGController>
random
-
unsigned long
max_species_id
-
unsigned long
metacommunity_size
-
unsigned long
local_community_size
-
long double
speciation_rate
-