Interface Features

All Known Subinterfaces:
Features.Groups, Features.Multispecies, Features.Pairs, Features.Payoffs, Features.Static, IBS.HasIBS.CGroups, IBS.HasIBS.CPairs, IBS.HasIBS.DGroups, IBS.HasIBS.DPairs, IBS.HasIBS.MCGroups, IBS.HasIBS.MCPairs, Model.HasDE.DGroups, Model.HasDE.DPairs
All Known Implementing Classes:
ATBT, CDL, CDLP, CDLPQ, Centipede, CLabour, Continuous, CSD, DemesTBT, Discrete, EcoPGG, LV, Module, Moran, NetGames, Predator, RSP, scanCSD, simCDL, simCDLP, simCDLPQ, simMoran, simTBT, simTraits, SIR, TBT, Traits

public interface Features
Interface to query features of the Module.
Author:
Christoph Hauert
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    All modules that admit interactions in larger groups (as opposed to interactions in pairs) should implement this interface.
    static interface 
    All modules that admit multiple species should implement this interface.
    static interface 
    All modules that admit interactions in pairs (as opposed to larger groups) should implement this interface.
    static interface 
    Interface that all modules with frequency dependent fitness/payoffs should implement.
    static interface 
    Interface that all modules with static fitness/payoffs should implement.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns title of active module, e.g.
    default boolean
    Returns whether the module implements multiple species.
    default boolean
    Returns whether interactions are restricted to pairs (false by default).
    default boolean
    Modules that are based on static fitness should implement the Features.Static interface and thus return true.
  • Method Details

    • getTitle

      String getTitle()
      Returns title of active module, e.g. 2x2 games in TBT returns "2x2 Games".
      Returns:
      the title of active module
    • isStatic

      default boolean isStatic()
      Modules that are based on static fitness should implement the Features.Static interface and thus return true. The Moran modules is an example. All other modules must return false.
      Returns:
      false by default
      See Also:
    • isPairwise

      default boolean isPairwise()
      Returns whether interactions are restricted to pairs (false by default). For modules that allow interactions in larger groups this returns true only if the group size parameter is set to 2.
      Returns:
      true if pairwise interactions
      See Also:
    • isMultispecies

      default boolean isMultispecies()
      Returns whether the module implements multiple species.
      Returns:
      true for multiple species