Class IBSCPopulation

Object

IBSPopulation<Continuous, IBSMCPopulation>

IBSMCPopulation

IBSCPopulation

public class IBSCPopulation
extends IBSMCPopulation

The core class for individual based simulations with a single continuous trait. As compared to the more generic IBSMCPopulation this subclass takes advantage of simplifications that are possible for a single trait.

Author:

Christoph Hauert

See Also:

• IBSPopulation
• IBSMCPopulation

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final Model.HasIBS.CGroups	cgroupmodule	For group interaction modules module==groupmodule holds and null otherwise.
(package private) final Model.HasIBS.CPairs	cpairmodule	For pairwise interaction modules module==pairmodule holds and null otherwise.

Fields inherited from class IBSMCPopulation

groupmodule, init, myTraits, oldScores, oldTraits, pairmodule, smallTrait, tmpGroup, traitRangeMax, traitRangeMin, traits, traitsNext

Fields inherited from class IBSPopulation

adjustScores, competition, compGroup, consistencyCheckRequested, debugFocal, debugModel, debugModels, debugNModels, debugSame, distrMigrants, engine, fitness, groupScores, hasLookupTable, interaction, interactions, interGroup, isMultispecies, isNeutral, logger, map2fit, maxEffScoreIdx, maxFitness, maxScore, migrationType, minFitness, minScore, module, mutation, nIssues, nMixedInter, nPopulation, nTraits, opponent, optimizeHomo, pAddwire, playerScoreAveraged, playerScoring, playerUpdate, pMigration, populationUpdate, pRewire, rng, scores, smallScores, staticmodule, sumFitness, syncFraction, tags, typeFitness, typeScores, vacantIdx

Constructor Summary

Constructors

Constructor	Description
IBSCPopulation(EvoLudo engine, Continuous module)	Creates a population of individuals with a single continuous trait for IBS simulations.

Method Summary

Modifier and Type	Method	Description
void	adjustPairGameScoresAt(int me)	Adjusts scores of focal individual with index me and its neighbors after me changed trait.
void	commitTraitAt(int me)	The change of a trait of the player at index is stored in a temporary variable and must be committed before proceeding.
void	getTraitHistogramData(double[] bins)	Creates a histogram for trait and returns the result in the array bins.
boolean	haveSameTrait(int a, int b)	Check if individuals with index a and index b have the same traits.
boolean	isSameTrait(int a)	Check if individual with index a has switched traits.
void	playGroupGameAt(IBSGroup group)	Play a group interaction with the individuals in group.
(package private) void	playGroupOnceAt(int me, IBSGroup group)	Evaluate a single group interaction with the sampled opponents.
(package private) void	playGroupSequentiallyAt(int me, IBSGroup group, int nGroup)	Evaluate sequential group interactions when not enough opponents are available simultaneously.
void	playPairGameAt(IBSGroup group)	Play a pairwise interaction with the individuals in group.
void	prepareTraits()	Prior to a synchronous update step the current state must be duplicated in preparation for processing the next step.
void	setOpponentPop(IBSPopulation<?,?> opponent)	Set the interaction partner/opponent of this population.
void	swapTraits(int a, int b)	Swap traits of individuals with index a and index b.
void	yalpGroupGameAt(IBSGroup group)	Counterpart of IBSPopulation.playGroupGameAt(IBSGroup), IBSPopulation.playGameAt(int) and/or IBSPopulation.playGameSyncAt(int).

Methods inherited from class IBSMCPopulation

addState, adjustScoreAt, adjustScoreAt, check, checkConvergence, commitTraits, doAdjustScores, encodeTraits, get2DTraitHistogramData, getInit, getMaxTraits, getMaxTraits, getMeanFitness, getMeanTraits, getMinTraits, getMinTraits, getStatus, getTraitAt, getTraitAt, getTraitData, getTraitHistogramData, getTraitHistogramData, getTraitNameAt, getTraitRangeMax, getTraitRangeMin, getTraits, getTraitsAt, getTraitsAt, init, initGaussian, initMono, initMutant, initUniform, maybeMutateAt, maybeMutateMoran, mouseHitNode, mutateAt, playNoGameAt, preferredPlayerBest, reset, restoreTraits, setInit, setTraitAt, setTraitAt, setTraitsAt, updateFromModelAt

Methods inherited from class IBSPopulation

adjustGameScoresAt, becomesVacantAt, checkCompSampling, checkConsistentFitness, checkGeometry, checkGeometryRewire, checkInteractions, checkLookupTable, checkMigration, checkNoLookupTable, checkOptimizations, checkPayoffs, debugMarkChange, debugScores, debugUpdate, debugUpdatePopulationAt, doBirthDeathMigration, doDeathBirthMigration, doDiffusionMigration, doMigration, doSyncMigration, encodeFitness, encodeGeometry, encodeInteractions, getCompetitionGeometry, getCompGroup, getFitness, getFitnessAt, getFitnessData, getFitnessHistogramData, getFitnessNameAt, getFitnessNameAt, getInteractionGeometry, getInteractionsAt, getInterGroup, getMaxScore, getMigrationProb, getMigrationType, getMinScore, getModule, getNMean, getNMixedInteractions, getPlayerScoreAveraged, getPlayerScoring, getPopulationSize, getPopulationUpdate, getScoreAt, getScoreNameAt, getScores, getSpeciesUpdateRate, getSyncFraction, getTagAt, getTagData, getTagNameAt, getTags, getTotalFitness, isConsistent, isMonomorphic, isVacantAt, logAccountingIssue, logAccountingIssue, logFitnessIssue, logMapIssue, logScoringIssue, logScoringIssue, migrateMoran, mouseHitNode, mutate, nextBinomial, pickFitFocalIndividual, pickFitFocalIndividual, pickFitNeighborAt, pickFitNeighborAt, pickFocalIndividual, pickFocalIndividual, pickFocalSite, pickFocalSite, pickNeighborSiteAt, playGameAt, playGameSyncAt, processScore, random01, random0n, randomGaussian, removeScoreAt, removeScoreAt, resetEphemeral, resetMoran, resetScoreAt, resetScores, resetTraits, restoreFitness, restoreGeometry, restoreInteractions, setAddwire, setConsistencyCheck, setGeometryNames, setMaxEffScoreIdx, setMigrationProb, setMigrationType, setPlayerScoreAveraged, setPlayerScoring, setPopulationUpdate, setRewire, setScoreAt, setSyncFraction, setTagAt, step, swapScoresAt, updateEffScoreRange, updateFitnessAt, updateMinMaxScores, updatePlayerAsync, updatePlayerAsyncAt, updatePlayerAt, updatePlayerAt, updatePlayerBest, updatePlayerBestHalf, updatePlayerBestResponse, updatePlayerEcology, updatePlayerEcologyAt, updatePlayerMoranBirthDeath, updatePlayerMoranBirthDeathAt, updatePlayerMoranDeathBirth, updatePlayerMoranDeathBirthAt, updatePlayerMoranImitate, updatePlayerMoranImitateAt, updatePlayerSwap, updateProportionalAbs, updateReplicatorHalf, updateReplicatorPlus, updateScoreAt, updateScoreAt, updateScoreAt, updateScores, updateThermal

Methods inherited from class Object

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

Field Details

cpairmodule

final Model.HasIBS.CPairs cpairmodule

For pairwise interaction modules module==pairmodule holds and null otherwise. Convenience field to reduce the number of (unnecessary) casts.

See Also:

• Model.HasIBS.CPairs

cgroupmodule

final Model.HasIBS.CGroups cgroupmodule

For group interaction modules module==groupmodule holds and null otherwise. Convenience field to reduce the number of (unnecessary) casts.

See Also:

• Model.HasIBS.CGroups

Constructor Details

IBSCPopulation

public IBSCPopulation(EvoLudo engine,
 Continuous module)

Creates a population of individuals with a single continuous trait for IBS simulations.

Parameters:

engine - the pacemaker for running the model

module - the module that defines the rules of the game

Method Details

setOpponentPop

public void setOpponentPop(IBSPopulation<?,?> opponent)

Description copied from class: IBSPopulation

Set the interaction partner/opponent of this population.

Overrides:

setOpponentPop in class IBSMCPopulation

Parameters:

opponent - the interaction partner/opponent

haveSameTrait

public boolean haveSameTrait(int a,
 int b)

Description copied from class: IBSPopulation

Check if individuals with index a and index b have the same traits.

Overrides:

haveSameTrait in class IBSMCPopulation

Parameters:

a - the index of first individual

b - the index of second individual

Returns:

true if the two individuals have the same traits

isSameTrait

public boolean isSameTrait(int a)

Description copied from class: IBSPopulation

Check if individual with index a has switched traits.

Note: this test is only meaningful before trait are committed.

Overrides:

isSameTrait in class IBSMCPopulation

Parameters:

a - index of individual

Returns:

true if trait remained unchanged

See Also:

• IBSPopulation.commitTraitAt(int)

swapTraits

public void swapTraits(int a,
 int b)

Description copied from class: IBSPopulation

Swap traits of individuals with index a and index b.

Note: the traits still need to be committed.

Overrides:

swapTraits in class IBSMCPopulation

Parameters:

a - the index of first individual

b - the index of second individual

See Also:

• IBSPopulation.commitTraitAt(int)

playPairGameAt

public void playPairGameAt(IBSGroup group)

Play a pairwise interaction with the individuals in group.

Continuous modules with a single trait never get here.

Continuous modules with multiple traits never get here.

Overrides:

playPairGameAt in class IBSMCPopulation

Parameters:

group - the group of individuals interacting in pairs

See Also:

• IBSMCPopulation.playPairGameAt(IBSGroup)

adjustPairGameScoresAt

public void adjustPairGameScoresAt(int me)

Adjusts scores of focal individual with index me and its neighbors after me changed trait. Only works if adjustScores==true.

Important: new trait must not yet have been committed.

Continuous modules with a single trait never get here.

Continuous modules with multiple traits never get here.

Overrides:

adjustPairGameScoresAt in class IBSMCPopulation

Parameters:

me - the index of the focal individual

See Also:

• IBSMCPopulation.adjustPairGameScoresAt(int)

playGroupGameAt

public void playGroupGameAt(IBSGroup group)

Play a group interaction with the individuals in group.

Continuous modules with a single trait never get here.

Continuous modules with multiple traits never get here.

Overrides:

playGroupGameAt in class IBSMCPopulation

Parameters:

group - the group of interacting individuals

See Also:

• IBSMCPopulation.playGroupGameAt(IBSGroup)

playGroupSequentiallyAt

void playGroupSequentiallyAt(int me,
 IBSGroup group,
 int nGroup)

Description copied from class: IBSMCPopulation

Evaluate sequential group interactions when not enough opponents are available simultaneously.

Overrides:

playGroupSequentiallyAt in class IBSMCPopulation

Parameters:

me - focal player index

group - sampled opponent group

nGroup - number of players participating in each interaction

playGroupOnceAt

void playGroupOnceAt(int me,
 IBSGroup group)

Description copied from class: IBSMCPopulation

Evaluate a single group interaction with the sampled opponents.

Overrides:

playGroupOnceAt in class IBSMCPopulation

Parameters:

me - focal player index

group - sampled opponent group

yalpGroupGameAt

public void yalpGroupGameAt(IBSGroup group)

Counterpart of IBSPopulation.playGroupGameAt(IBSGroup), IBSPopulation.playGameAt(int) and/or IBSPopulation.playGameSyncAt(int). Removes the payoffs of group interactions.

Continuous modules with a single trait never get here.

Continuous modules with multiple traits never get here.

Overrides:

yalpGroupGameAt in class IBSMCPopulation

Parameters:

group - the interaction group

See Also:

• IBSMCPopulation.yalpGroupGameAt(IBSGroup)

prepareTraits

public void prepareTraits()

Description copied from class: IBSPopulation

Prior to a synchronous update step the current state must be duplicated in preparation for processing the next step.

Overrides:

prepareTraits in class IBSMCPopulation

See Also:

• IBSPopulation.commitTraits()

commitTraitAt

public void commitTraitAt(int me)

Description copied from class: IBSPopulation

The change of a trait of the player at index is stored in a temporary variable and must be committed before proceeding.

Overrides:

commitTraitAt in class IBSMCPopulation

Parameters:

me - the index of the player that needs to have its new trait committed

getTraitHistogramData

public void getTraitHistogramData(double[] bins)

Creates a histogram for trait and returns the result in the array bins.

Parameters:

bins - the array to store the histogram(s)