Package org.evoludo.simulator.modules

Class RSP

Object

Module

Discrete

RSP

All Implemented Interfaces:

Runnable, IBS.HasIBS, IBS.HasIBS.DPairs, MilestoneListener, Model.HasDE, Model.HasDE.DPairs, Model.HasDE.EM, Model.HasDE.ODE, Model.HasDE.PDE, Model.HasDE.PDEADV, Model.HasDE.PDERD, Model.HasDE.RK5, Model.HasDE.SDE, Features, Features.Pairs, Features.Payoffs, HasHistogram, HasHistogram.Degree, HasHistogram.Fitness, HasHistogram.StatisticsStationary, HasMean, HasMean.Fitness, HasMean.Traits, HasPop2D, HasPop2D.Fitness, HasPop2D.Traits, HasPop3D, HasPop3D.Fitness, HasPop3D.Traits, HasS3, CLOProvider

public class RSP
extends Discrete
implements Features.Payoffs, IBS.HasIBS.DPairs, Model.HasDE.DPairs, Model.HasDE.RK5, Model.HasDE.EM, Model.HasDE.SDE, Model.HasDE.PDERD, Model.HasDE.PDEADV, HasPop2D.Traits, HasPop3D.Traits, HasMean.Traits, HasS3, HasPop2D.Fitness, HasPop3D.Fitness, HasMean.Fitness, HasHistogram.Fitness, HasHistogram.Degree, HasHistogram.StatisticsStationary

Cyclical dynamics of the rock-scissors-paper game. A game that children, lizards and even bacteria enjoy playing!

Author:

Christoph Hauert

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RSP.IBSPop	The extension for IBS simulations specific to 3×3 games.

Nested classes/interfaces inherited from interface Features

Features.Groups, Features.Multispecies, Features.Pairs, Features.Payoffs, 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.Traits

Nested classes/interfaces inherited from interface HasPop2D

HasPop2D.Fitness, HasPop2D.Traits

Nested classes/interfaces inherited from interface HasPop3D

HasPop3D.Fitness, HasPop3D.Traits

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

Nested classes/interfaces inherited from interface Model.HasDE

Model.HasDE.DGroups, Model.HasDE.DPairs, Model.HasDE.DualDynamics, Model.HasDE.EM, Model.HasDE.ODE, Model.HasDE.PDE, Model.HasDE.PDEADV, Model.HasDE.PDERD, Model.HasDE.RK5, Model.HasDE.SDE

Field Summary

Fields

Modifier and Type	Field	Description
final CLOption	cloPayoff	Command line option to set the payoff matrix.
static final int	PAPER	The trait (and index) value of the trait 'paper'.
(package private) double[][]	payoff	The 3×3 payoff matrix for interactions between the three types.
static final int	ROCK	The trait (and index) value of the trait 'rock'.
static final int	SCISSORS	The trait (and index) value of the trait 'scissors'.

Fields inherited from class Discrete

cloMonoStop, monoStop, mutation, species

Fields inherited from class Module

active, cloDeathRate, cloGeometry, cloNGroup, cloNPopulation, cloPhase2DAxes, cloTraitColors, cloTraitDisable, cloTraitNames, competition, deathRate, defaultColor, engine, ibs, ID, interaction, logger, map2fitness, markers, model, nActive, name, nGroup, nPopulation, nTraits, opponent, playerUpdate, 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

Constructor	Description
RSP(EvoLudo engine)	Create a new instance of the module for rock-scissors-paper games.

Method Summary

Modifier and Type	Method	Description
void	adjustCLO(CLOParser parser)	Providers of command line options may want to remove certain options that other providers provided by overriding this method.
void	avgScores(double[] density, double[] avgscores)	Calculate the average payoff for the frequency of traits specified in the array state for pairwise interactions.
void	collectCLO(CLOParser parser)	All providers of command line options must implement this method to collect their options.
RSP.IBSPop	createIBSPop()	Opportunity to supply custom individual based simulations.
String	getAuthors()	Returns a string with information about the authors of the module.
int	getDependent()	For replicator dynamics the frequencies of all traits must sum up to one.
double	getMaxPayoff()	Calculates and returns the maximum payoff/score of an individual.
double	getMinPayoff()	Calculates and returns the minimum payoff/score of an individual.
double	getMonoPayoff(int type)	Calculate and return the payoff/score of individuals in monomorphic populations with trait type.
double[][]	getPayoffs()	Get the payoff matrix.
String	getTitle()	Returns title of active module, e.g.
void	load()	Load new module and perform basic initializations.
void	mixedScores(int[] traitCount, double[] traitScore)	Calculate the average payoff/score in a finite population with the number of each trait provided in count for pairwise interactions.
double	pairScores(int me, int[] traitCount, double[] traitScore)	Calculate and return total (accumulated) payoff/score for pairwise interactions of the focal individual with trait me against opponents with different traits.
void	setPayoffs(double[][] payMatrix)	Set the payoff matrix to payMatrix.
void	unload()	Unload module and free all resources.

Methods inherited from class Discrete

add, getMaxMonoPayoff, getMinMonoPayoff, getMonoStop, getMutation, setMonoStop

Methods inherited from class Module

check, createGeometry, createModel, getActiveTraits, getCompetitionGeometry, getDeathRate, getGeometry, getIBSPopulation, getID, getInteractionGeometry, getKey, getMap2Fitness, getMarkers, getMeanColors, getModelTypes, getNActive, getName, getNGroup, getNPopulation, getNRoles, getNSpecies, getNTraits, getOpponent, getPlayerUpdate, getSpecies, getSpecies, getTraitColor, getTraitColors, getTraitName, getTraitNames, getTrajectoryColor, getVacant, init, processColorMap, reset, run, setActiveTraits, setDeathRate, setGeometries, setIBSPopulation, setModel, setName, setNGroup, setNPopulation, setNTraits, setOpponent, setTraitColors, setTraitNames, setTrajectoryColor

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Features

isMultispecies, isStatic

Methods inherited from interface Features.Pairs

isPairwise

Methods inherited from interface Features.Payoffs

getMap2Fitness, getMaxMonoPayoff, getMinMonoPayoff, isNeutral

Methods inherited from interface HasHistogram

getCustomLevels, getNTraits, getTraitColors

Methods inherited from interface HasS3

getS3Map, setS3Map

Methods inherited from interface IBS.HasIBS

createIBS

Methods inherited from interface MilestoneListener

modelDidInit, modelDidReset, modelLoaded, modelRelaxed, modelRunning, modelSettings, modelStopped, modelUnloaded, moduleLoaded, moduleRestored, moduleUnloaded

Field Details

ROCK

public static final int ROCK

The trait (and index) value of the trait 'rock'.

See Also:

• Constant Field Values

SCISSORS

public static final int SCISSORS

The trait (and index) value of the trait 'scissors'.

See Also:

• Constant Field Values

PAPER

public static final int PAPER

The trait (and index) value of the trait 'paper'.

See Also:

• Constant Field Values

payoff

double[][] payoff

The 3×3 payoff matrix for interactions between the three types.

cloPayoff

public final CLOption cloPayoff

Command line option to set the payoff matrix.

Constructor Details

RSP

public RSP(EvoLudo engine)

Create a new instance of the module for rock-scissors-paper 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.

Overrides:

load in class Discrete

See Also:

• EvoLudo.loadModule(String)
• MilestoneListener.moduleLoaded()

unload

public void unload()

Description copied from class: Module

Unload module and free all resources.

Overrides:

unload in class Discrete

See Also:

• EvoLudo.unloadModule()
• MilestoneListener.moduleUnloaded()

getAuthors

public String getAuthors()

Description copied from class: Module

Returns a string with information about the authors of the module.

Overrides:

getAuthors in class Module

Returns:

the names of the authors

getTitle

public String getTitle()

Description copied from interface: Features

Returns title of active module, e.g. 2x2 games in TBT returns "2x2 Games".

Specified by:

getTitle in interface Features

Returns:

the title of active module

getDependent

public int getDependent()

Description copied from interface: Model.HasDE

For replicator dynamics the frequencies of all traits must sum up to one. Hence, for nTraits traits there are only nTraits-1 degrees of freedom. The index returned by getDependent() marks the one rate of change that is derived from all the others.

Notes:

• Dependent traits are used by models where the frequencies of all types must sum up to one.
• Density modules do not have dependent traits and getDependent() should return -1.
• Currently differential equations implementations are only provided for Discrete modules.

Specified by:

getDependent in interface Model.HasDE

Returns:

the index of the dependent trait (or -1 if there is none)

getMinPayoff

public double getMinPayoff()

Description copied from interface: Features.Payoffs

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:

getMinPayoff in interface Features.Payoffs

Returns:

the minimum payoff/score

See Also:

• Model.getMinScore(int)

getMaxPayoff

public double getMaxPayoff()

Description copied from interface: Features.Payoffs

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:

getMaxPayoff in interface Features.Payoffs

Returns:

the maximum payoff/score

See Also:

• Model.getMaxScore(int)

getMonoPayoff

public double getMonoPayoff(int type)

Description copied from class: Discrete

Calculate and return the payoff/score of individuals in monomorphic populations with trait type.

Note: Optional implementation. Returns Double#NaN if not defined or not implemented.

Overrides:

getMonoPayoff in class Discrete

Parameters:

type - the index of the trait

Returns:

payoff/score in monomorphic population with trait type

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 me against opponents with different traits. The respective numbers of each of the nTraits opponent traits are provided in the array tCount. The payoffs/scores for each of the nTraits opponent traits must be stored and returned in the array tScore.

Important: must be overridden and implemented in subclasses that define game interactions between pairs of individuals (nGroup=2, pairwise=true), otherwise see IBS.HasIBS.DGroups.groupScores(int[], double[]).

Specified by:

pairScores in interface IBS.HasIBS.DPairs

Parameters:

me - the trait index of the focal individual

traitCount - number of opponents with each trait

traitScore - array for returning the scores of each opponent trait

Returns:

score of focal individual me accumulated over all interactions

avgScores

public void avgScores(double[] density,
 double[] avgscores)

Description copied from interface: Model.HasDE.DPairs

Calculate the average payoff for the frequency of traits specified in the array state for pairwise interactions. The average payoffs for each of the nTraits traits must be stored and returned in the array scores.

Specified by:

avgScores in interface Model.HasDE.DPairs

Parameters:

density - the frequency/density of each trait

avgscores - the array for storing the average payoffs/scores of each trait

mixedScores

public void mixedScores(int[] traitCount,
 double[] traitScore)

Description copied from interface: IBS.HasIBS.DPairs

Calculate the average payoff/score in a finite population with the number of each trait provided in count for pairwise interactions. The payoffs/scores for each of the nTraits traits must be stored and returned in the array traitScores.

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 with IBS.HasIBS.DPairs.pairScores(int, int[], double[]) or IBS.HasIBS.DGroups.groupScores(int[], double[]), respectively.

Note: If explicit calculations of the well-mixed scores are not available, interactions with everyone in well-mixed populations should checked for and excluded with a warning in IBS.check() (see CXPopulation for an example).

Specified by:

mixedScores in interface IBS.HasIBS.DPairs

Parameters:

traitCount - number of individuals for each trait

traitScore - array for returning the payoffs/scores of each trait

setPayoffs

public void setPayoffs(double[][] payMatrix)

Set the payoff matrix to payMatrix.

Parameters:

payMatrix - the new payoff matrix

getPayoffs

public double[][] getPayoffs()

Get the payoff matrix.

Returns:

the payoff matrix

collectCLO

public void collectCLO(CLOParser parser)

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, the parser issues a warning and ignores the option. Thus, in general, implementing subclasses should first register their options and call super.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 interface CLOProvider

Overrides:

collectCLO in class Discrete

Parameters:

parser - the reference to parser that manages command line options

See Also:

• CLOParser.addCLO(CLOption)

adjustCLO

public void adjustCLO(CLOParser parser)

Description copied from interface: CLOProvider

Providers of command line options may want to remove certain options that other providers provided by overriding this method. After all command line options are collected, all providers get a chance to adjust the collection. In particular, options should be removed that do not make sense in present context. Overriding methods usually call CLOParser.removeCLO(String[]) or variants thereof.

Specified by:

adjustCLO in interface CLOProvider

Parameters:

parser - the reference to parser that manages command line options

See Also:

• CLOParser.removeCLO(CLOption)

createIBSPop

public RSP.IBSPop createIBSPop()

Description copied from class: Module

Opportunity to supply custom individual based simulations.

Overrides:

createIBSPop in class Module

Returns:

the custom IBSPopulation or null to use default.