Class EcoPGG
- All Implemented Interfaces:
Runnable
,IBS.HasIBS
,IBS.HasIBS.DGroups
,IBS.HasIBS.DPairs
,MilestoneListener
,ODE.HasDE
,ODE.HasODE
,PDE.HasPDE
,SDE.HasSDE
,Features
,Features.Groups
,Features.Pairs
,HasHistogram
,HasHistogram.Degree
,HasHistogram.Fitness
,HasHistogram.StatisticsStationary
,HasMean
,HasMean.Fitness
,HasMean.Strategy
,HasPhase2D
,HasPop2D
,HasPop2D.Fitness
,HasPop2D.Strategy
,HasPop3D
,HasPop3D.Fitness
,HasPop3D.Strategy
,HasS3
,CLOProvider
- Author:
- Christoph Hauert
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclass
The map for translating the data of the ecological public goods game models into 2D phase plane representation.Nested classes/interfaces inherited from interface Features
Features.Groups, Features.Pairs, Features.Static
Nested classes/interfaces inherited from interface HasHistogram
HasHistogram.Degree, HasHistogram.Fitness, HasHistogram.StatisticsProbability, HasHistogram.StatisticsStationary, HasHistogram.StatisticsTime, HasHistogram.Strategy
Nested classes/interfaces inherited from interface HasMean
HasMean.Fitness, HasMean.Strategy
Nested classes/interfaces inherited from interface HasPhase2D
HasPhase2D.Data2Phase
Nested classes/interfaces inherited from interface HasPop2D
HasPop2D.Fitness, HasPop2D.Strategy
Nested classes/interfaces inherited from interface HasPop3D
HasPop3D.Fitness, HasPop3D.Strategy
Nested classes/interfaces inherited from interface IBS.HasIBS
IBS.HasIBS.CGroups, IBS.HasIBS.CPairs, IBS.HasIBS.DGroups, IBS.HasIBS.DPairs, IBS.HasIBS.MCGroups, IBS.HasIBS.MCPairs
-
Field Summary
FieldsModifier and TypeFieldDescriptionfinal CLOption
Command line option to set the cost of cooperation, i.e.final CLOption
Command line option to set the multiplication factor for public good interactions.final CLOption
Command line option to set the payoff to cooperators that failed to find any interaction partners.final CLOption
Command line option to set the payoff to defectors that failed to find any interaction partners.static final int
The trait (and index) value of cooperators.(package private) double
The cost of cooperation or the individual contribution to the public good.static final int
The trait (and index) value of defectors.(package private) double
The multiplication factor of the public good.(package private) EcoPGG.EcoPGGMap
The map for translating the model data into 2D phase plane representation.(package private) double
The payoff to lone cooperators.(package private) double
The payoff to lone defectors.protected RNGDistribution
The shared random number generator to ensure reproducibility of results.Fields inherited from class Discrete
cloMonoStop, monoStop, mutation, species
Fields inherited from class Module
active, cloDeathRate, cloGeometry, cloNGroup, cloNPopulation, cloPhase2DAxis, cloSpeciesUpdateRate, cloTraitColors, cloTraitDisable, cloTraitNames, competition, deathRate, defaultColor, engine, ibs, ID, interaction, logger, map2fitness, markers, model, nActive, name, nGroup, nPopulation, nTraits, opponent, playerUpdate, speciesUpdateRate, structure, traitColor, traitName, trajectoryColor, VACANT
Fields inherited from interface HasS3
CORNER_LEFT, CORNER_RIGHT, CORNER_TOP, EDGE_BOTTOM, EDGE_LEFT, EDGE_RIGHT
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
avgScores
(double[] dens, int n, double[] avgscores) Calculate the average payoff/score for the frequency of traits/strategies specified in the arraydensity
for interactions in groups of sizen
.void
collectCLO
(CLOParser parser) All providers of command line options must implement this method to collect their options.Provides opportunity for model to supply custom PDE implementation.Returns a string with information about the authors of the module.double
Get the cost of cooperation.double
Get the multiplication factor of the linear public goods game.getKey()
Returns identifier of the active module.double
Calculates and returns the maximum payoff/score of an individual.double
Calculates and returns the minimum payoff/score of an individual.double
getMonoGameScore
(int type) Calculate and return the payoff/score of individuals in monomorphic populations with trait/strategytype
.double
Get the payoff to lone cooperators.double
Get the payoff to lone defectors.Get the map that transforms the data of the module to a 2D phase plane (projection).getTitle()
Returns title of active module, e.g.void
groupScores
(int[] traitCount, double[] traitScore) Calculate the payoff/score for interactions in groups consisting of traits/strategies with respective numbers given in the arraytCount
.void
load()
Load new module and perform basic initializations.void
mixedScores
(int[] traitCount, int n, double[] traitScore) Calculate the average payoff/score in a finite population with the number of each trait/strategy provided incount
for interaction groups of sizen
.double
pairScores
(int me, int[] traitCount, double[] traitScore) Calculate and return total (accumulated) payoff/score for pairwise interactions of the focal individual with trait/strategyme
against opponents with different traits/strategies.void
setCostCoop
(double aValue) Set the cost of cooperation.void
setInterest
(double aValue) Set the multiplication factor of the linear public goods game.void
setPayLoneCoop
(double aValue) Set the payoff to lone cooperators.void
setPayLoneDefect
(double aValue) Set the payoff to lone defectors.Methods inherited from class Discrete
add, getMaxMonoGameScore, getMinMonoGameScore, getMonoStop, getMutation, setMonoStop, unload
Methods inherited from class Module
check, createGeometry, createIBSPop, getActiveTraits, getCompetitionGeometry, getDeathRate, getDependent, getGeometry, getIBSPopulation, getID, getInteractionGeometry, getMapToFitness, getMarkers, getMeanColors, getModelTypes, getNActive, getName, getNGroup, getNPopulation, getNRoles, getNSpecies, getNTraits, getOpponent, getPlayerUpdate, getSpecies, getSpecies, getSpeciesUpdateRate, getTraitColor, getTraitColors, getTraitName, getTraitNames, getTrajectoryColor, getVacant, init, isNeutral, processColorMap, reset, run, setActiveTraits, setDeathRate, setGeometries, setIBSPopulation, setModel, setName, setNGroup, setNPopulation, setNTraits, setOpponent, setSpeciesUpdateRate, setTraitColors, setTraitNames, setTrajectoryColor
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface CLOProvider
adjustCLO
Methods inherited from interface Features.Groups
getNGroup, isPairwise
Methods inherited from interface HasHistogram
getCustomLevels, getNTraits, getTraitColors
Methods inherited from interface HasPhase2D
setPhase2DMap
Methods inherited from interface IBS.HasIBS
createIBS
Methods inherited from interface IBS.HasIBS.DGroups
mixedScores
Methods inherited from interface MilestoneListener
modelDidInit, modelDidReset, modelLoaded, modelRelaxed, modelRunning, modelSettings, modelStopped, modelUnloaded, moduleLoaded, moduleRestored, moduleUnloaded
Methods inherited from interface ODE.HasDE
avgScores, getDependent
Methods inherited from interface ODE.HasODE
createODE
Methods inherited from interface SDE.HasSDE
createSDE
-
Field Details
-
DEFECT
public static final int DEFECTThe trait (and index) value of defectors.- See Also:
-
COOPERATE
public static final int COOPERATEThe trait (and index) value of cooperators.- See Also:
-
rng
The shared random number generator to ensure reproducibility of results.- See Also:
-
interest
double interestThe multiplication factor of the public good. -
cost
double costThe cost of cooperation or the individual contribution to the public good. -
payLoneCoop
double payLoneCoopThe payoff to lone cooperators. -
payLoneDefect
double payLoneDefectThe payoff to lone defectors. -
map
EcoPGG.EcoPGGMap mapThe map for translating the model data into 2D phase plane representation. -
cloInterest
Command line option to set the multiplication factor for public good interactions. -
cloCost
Command line option to set the cost of cooperation, i.e. contributions to the public good. -
cloLoneCooperator
Command line option to set the payoff to cooperators that failed to find any interaction partners. -
cloLoneDefector
Command line option to set the payoff to defectors that failed to find any interaction partners.
-
-
Constructor Details
-
EcoPGG
Create a new instance of the module for ecological public goods games.- Parameters:
engine
- the manager of modules and pacemaker for running the model
-
-
Method Details
-
load
public void load()Description copied from class:Module
Load new module and perform basic initializations. -
getKey
Description copied from class:Module
Returns identifier of the active module. For example, 2x2 games inTBT
return "2x2". This corresponds to the argument for the--module
option to load a particular module. The default is to use the class name. -
getAuthors
Description copied from class:Module
Returns a string with information about the authors of the module.- Overrides:
getAuthors
in classModule
- Returns:
- the names of the authors
-
getTitle
Description copied from class:Module
Returns title of active module, e.g. 2x2 games inTBT
returns "2x2 Games". -
getMinGameScore
public double getMinGameScore()Description copied from class:Module
Calculates and returns the minimum payoff/score of an individual. This value is important for converting payoffs/scores into probabilities, for scaling graphical output and some optimizations.- Specified by:
getMinGameScore
in classModule
- Returns:
- the minimum payoff/score
- See Also:
-
getMaxGameScore
public double getMaxGameScore()Description copied from class:Module
Calculates and returns the maximum payoff/score of an individual. This value is important for converting payoffs/scores into probabilities, for scaling graphical output and some optimizations.- Specified by:
getMaxGameScore
in classModule
- Returns:
- the maximum payoff/score
- See Also:
-
getMonoGameScore
public double getMonoGameScore(int type) Description copied from class:Discrete
Calculate and return the payoff/score of individuals in monomorphic populations with trait/strategytype
.Note: Optional implementation. Returns
Double#NaN
if not defined or not implemented.- Overrides:
getMonoGameScore
in classDiscrete
- Parameters:
type
- trait/strategy- Returns:
- payoff/score in monomorphic population with trait/strategy
type
-
createPDE
Description copied from interface:PDE.HasPDE
Provides opportunity for model to supply custom PDE implementation.Important: if the custom PDE implementation involves random numbers, the shared random number generator should be used for reproducibility.
- Specified by:
createPDE
in interfacePDE.HasPDE
- Returns:
- custom PDE model or
null
to use use default - See Also:
-
mixedScores
public void mixedScores(int[] traitCount, int n, double[] traitScore) Calculate the average payoff/score in a finite population with the number of each trait/strategy provided incount
for interaction groups of sizen
. The payoffs/scores for each of thenTraits
traits/strategies must be stored and returned in the arraytraitScores
.Notes:
For payoff calculations:- each strategy sees one less of its own type in its environment
- the size of the environment is
nPopulation-1
- the fact that the payoff of each strategy does not depend on its own type simplifies things
IBS.check()
(seeIBSMCPopulation
for an example).Important:
Must be overridden and implemented in subclasses that define game interactions in well-mixed populations where individuals interact with everyone else. Computationally it is not feasible to cover this scenario withIBS.HasIBS.DPairs.pairScores(int, int[], double[])
orIBS.HasIBS.DGroups.groupScores(int[], double[])
, respectively.Proper sampling in finite populations (c.f. CDL): \begin{align*} f_L =& \sigma\\ f_D =& \frac{\binom z{N-1}}{\binom{M-1}{N-1}}\sigma+r\frac x{M-z-1}\\ & \left(1-\frac 1{N(M-z)} \left( M-(z-N+1)\frac{\binom z{N-1}}{\binom{M-1}{N-1}}\right)\right) c\\ f_C =& f_d-F(z)c\\ F(z) =& 1-\frac rN\frac{M-N}{M-z-1}+\frac{\binom z{N-1}}{\binom{M-1}{N-1}}\\ & \left(\frac rN \frac{z+1}{M-z-1}+r\frac{M-z-2}{M-z-1}-1\right) \end{align*}
- Specified by:
mixedScores
in interfaceIBS.HasIBS.DGroups
- Parameters:
traitCount
- number of individuals for each trait/strategyn
- interaction group sizetraitScore
- array for returning the payoffs/scores of each trait/strategy
-
avgScores
public void avgScores(double[] dens, int n, double[] avgscores) Description copied from interface:ODE.HasDE
Calculate the average payoff/score for the frequency of traits/strategies specified in the arraydensity
for interactions in groups of sizen
. The average payoffs/scores for each of thenTraits
traits/strategies must be stored and returned in the arrayavgscores
.Note: needs to be thread safe for parallel processing of PDE's.
IMPORTANT: one of
should be implemented in modules that advertise the model typesODE, SDE
orPDE
.Alternatively, the method
ODE.getDerivatives(double, double[], double[], double[])
may be overridden in a subclass ofODE
, which may prevent calls toavgScores(...)
altogether. -
pairScores
public double pairScores(int me, int[] traitCount, double[] traitScore) Description copied from interface:IBS.HasIBS.DPairs
Calculate and return total (accumulated) payoff/score for pairwise interactions of the focal individual with trait/strategyme
against opponents with different traits/strategies. The respective numbers of each of thenTraits
opponent traits/strategies are provided in the arraytCount
. The payoffs/scores for each of thenTraits
opponent traits/strategies must be stored and returned in the arraytScore
.Important: must be overridden and implemented in subclasses that define game interactions between pairs of individuals (
nGroup=2
,pairwise=true
), otherwise seeIBS.HasIBS.DGroups.groupScores(int[], double[])
.- Specified by:
pairScores
in interfaceIBS.HasIBS.DPairs
- Parameters:
me
- the trait index of the focal individualtraitCount
- number of opponents with each trait/strategytraitScore
- array for returning the scores of each opponent trait/strategy- Returns:
- score of focal individual
me
accumulated over all interactions
-
groupScores
public void groupScores(int[] traitCount, double[] traitScore) Description copied from interface:IBS.HasIBS.DGroups
Calculate the payoff/score for interactions in groups consisting of traits/strategies with respective numbers given in the arraytCount
. The interaction group size is given by the sum overtCount[i]
fori=0,1,...,nTraits
. The payoffs/scores for each of thenTraits
traits/strategies must be stored and returned in the arraytScore
.Important: must be overridden and implemented in subclasses that define game interactions among groups of individuals (for groups with sizes
nGroup>2
, otherwise seeIBS.HasIBS.DPairs.pairScores(int, int[], double[])
).- Specified by:
groupScores
in interfaceIBS.HasIBS.DGroups
- Parameters:
traitCount
- group composition given by the number of individuals with each trait/strategytraitScore
- array for returning the payoffs/scores of each trait/strategy
-
setCostCoop
public void setCostCoop(double aValue) Set the cost of cooperation.- Parameters:
aValue
- the cost of cooperation
-
getCostCoop
public double getCostCoop()Get the cost of cooperation.- Returns:
- the cost of cooperation
-
setInterest
public void setInterest(double aValue) Set the multiplication factor of the linear public goods game.- Parameters:
aValue
- the new multiplication factor
-
getInterest
public double getInterest()Get the multiplication factor of the linear public goods game.- Returns:
- the multiplication factor
-
setPayLoneCoop
public void setPayLoneCoop(double aValue) Set the payoff to lone cooperators. Defaults to loner payoff.- Parameters:
aValue
- the payoff to lone cooperators.
-
getPayLoneCoop
public double getPayLoneCoop()Get the payoff to lone cooperators.- Returns:
- the payoff to lone cooperators.
-
setPayLoneDefect
public void setPayLoneDefect(double aValue) Set the payoff to lone defectors. Defaults to loner payoff.- Parameters:
aValue
- the payoff to lone defectors.
-
getPayLoneDefect
public double getPayLoneDefect()Get the payoff to lone defectors.- Returns:
- the payoff to lone defectors.
-
getPhase2DMap
Description copied from interface:HasPhase2D
Get the map that transforms the data of the module to a 2D phase plane (projection).- Specified by:
getPhase2DMap
in interfaceHasPhase2D
- Returns:
- the map
-
collectCLO
Description copied from interface:CLOProvider
All providers of command line options must implement this method to collect their options.Each command line option is (uniquely) identified by it's name (see
CLOption.getName()
), which corresponds to the long version of the option. If an attempt is made to add an option with a name that already exists, theparser
issues a warning and ignores the option. Thus, in general, implementing subclasses should first register their options and callsuper.collectCLO(CLOParser)
at the end such that subclasses are able to override command line options specified in a parental class.Override this method in subclasses to add further command line options. Subclasses must make sure that they include a call to super.
- Specified by:
collectCLO
in interfaceCLOProvider
- Overrides:
collectCLO
in classDiscrete
- Parameters:
parser
- the reference to parser that manages command line options- See Also:
-