Class Predator

Object

Module<Discrete>

Discrete

Predator

All Implemented Interfaces:

Runnable, LifecycleListener, Model.HasDE, RunListener, Features, Features.Multispecies, CLOProvider

class Predator
extends Discrete
implements Features.Multispecies, Model.HasDE

Predator class representing the predator species in the Lotka-Volterra model.

Nested Class Summary

Nested classes/interfaces inherited from interface Features

Features.Groups, Features.Multispecies, Features.Pairs, Features.Payoffs, Features.Static

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
(package private) static final int	PREDATOR	The index of the predator.
(package private) LV	prey	The reference to the prey species.
(package private) double[]	rates	The reaction rates for predator reproduction, predation, and competition.

Fields inherited from class Discrete

cloMonoStop, monoStop, mutation

Fields inherited from class Module

active, birthRate, cloBirthRate, cloCompRate, cloDeathRate, cloGeometry, cloModel, cloNGroup, cloNPopulation, cloPhase2DAxes, cloTraitColors, cloTraitDisable, cloTraitNames, competitionRate, competitionRates, deathRate, defaultColor, engine, ibspop, id, logger, map2fitness, model, nActive, name, nGroup, nPopulation, nTraits, opponent, playerUpdate, species, structure, traitColor, traitName, trajectoryColor, VACANT_COLOR, VACANT_NAME, vacantIdx

Constructor Summary

Constructors

Constructor	Description
Predator(LV prey)	Create a new instance of the phage population.

Method Summary

Modifier and Type	Method	Description
IBSPop	createIBSPopulation()	Opportunity to supply custom individual based simulations.
int	getDependent()	For replicator dynamics the frequencies of all traits must sum up to one.
void	load()	Load new module and perform basic initializations.

Methods inherited from class Discrete

collectCLO, createModel, getMaxMonoPayoff, getMinMonoPayoff, getMonoPayoff, getMonoStop, getMutation, setMonoStop, unload

Methods inherited from class Module

add, check, getActiveTraits, getAuthors, getBirthRate, getCompetitionRate, getCompetitionRates, getDeathRate, getGeometry, getIBSPopulation, getId, getKey, getMap2Fitness, getMeanColors, getModelType, getModelTypes, getNActive, getName, getNGroup, getNPopulation, getNRoles, getNSpecies, getNTraits, getOpponent, getPlayerUpdate, getSpecies, getSpecies, getTraitColor, getTraitColors, getTraitName, getTraitNames, getTrajectoryColor, getVacantIdx, hasVacant, init, preprocessModelOption, processColorMap, reset, run, setActiveTraits, setBirthRate, setCompetitionRates, setDeathRate, setIBSPopulation, setModel, setName, setNGroup, setNPopulation, setNTraits, 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 CLOProvider

adjustCLO

Methods inherited from interface Features

isPairwise, isStatic

Methods inherited from interface Features.Multispecies

getTitle, isMultispecies

Methods inherited from interface LifecycleListener

modelLoaded, modelUnloaded, moduleLoaded, moduleRestored, moduleUnloaded

Methods inherited from interface RunListener

modelDidInit, modelDidReset, modelRelaxed, modelRunning, modelSettings, modelStopped

Field Details

PREDATOR

static final int PREDATOR

The index of the predator.

See Also:

• Constant Field Values

prey

LV prey

The reference to the prey species.

rates

double[] rates

The reaction rates for predator reproduction, predation, and competition.

Constructor Details

Predator

public Predator(LV prey)

Create a new instance of the phage population.

Parameters:

prey - the reference to the prey species

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)
• LifecycleListener.moduleLoaded()

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)

createIBSPopulation

public IBSPop createIBSPopulation()

Description copied from class: Module

Opportunity to supply custom individual based simulations.

Overrides:

createIBSPopulation in class Module<Discrete>

Returns:

the custom IBSPopulation or null to use default.