Package org.evoludo.simulator.modules

Enum Class Continuous.Benefits

Object
Enum<Continuous.Benefits>
Benefits
All Implemented Interfaces:
Serializable, Comparable<Continuous.Benefits>, Constable, CLOption.Key
Enclosing class:
Continuous
public static enum Continuous.Benefits extends Enum<Continuous.Benefits> implements CLOption.Key
Selected benefit functions to translate continuous traits into payoffs. Enum on steroids. Currently available benefit functions are:
0
Linear benefit function (independent of focal): \(B(x,y)=b_0\,y\).
1
Quadratic benefit function (independent of focal): \(B(x,y)=b_0\,y+\b_1\,y^2\).
2
Saturating benefit function following a square root (independent of focal): \(B(x,y)=b_0\sqrt{y}\).
3
Saturating benefit function following a logarithm (independent of focal): \(B(x,y)=b_0\log{b_1\,y+1}\).
4
Saturating benefit function following an exponential (independent of focal): \(B(x,y)=b_0 \left(1-e^{-b_1\,y}\right)\).
10
Linear benefit function (sum of focal, \(x\), and opponent, \(y\), traits): \(B(x,y)=b_0\,(x+y)\).
11
Quadratic benefit function (sum of focal, \(x\), and opponent, \(y\), traits): \(B(x,y)=b_0\,(x+y)+\b_1\,(x+y)^2\).
12
Saturating benefit function following a square root (sum of focal, \(x\), and opponent, \(y\), traits): \(B(x,y)=b_0\sqrt{x+y}\).
13
Saturating benefit function following a logarithm (sum of focal, \(x\), and opponent, \(y\), traits): \(B(x,y)=b_0\log{b_1\,(x+y)+1}\).
14
Saturating benefit function following an exponential (sum of focal, \(x\), and opponent, \(y\), traits): \(B(x,y)=b_0 \left(1-e^{-b_1\,(x+y)}\right)\).
20
Linear benefit function (with interaction term): \(B(x,y)=b_0\,x=b_1\,y+\b_2\,x\,y\).
30
Linear benefit function (independent of opponent): \(B(x,y)=b_0\,x\).
31
Quadratic benefit function (independent of opponent): \(B(x,y)=b_0\,x+b_1\,x^2\).
32
Cubic benefit function (independent of opponent): \(B(x,y)=b_0\,x+b_1\,x^2+b_2\,x^3\).

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ME_LINEAR
    Linear benefit function (independent of opponent): \(B(x,y)=b_0\,x\).
    ME_QUAD
    Quadratic benefit function (independent of opponent): \(B(x,y)=b_0\,x+b_1\,x^2\).
    ME_QUBIC
    Cubic benefit function (independent of opponent): \(B(x,y)=b_0\,x+b_1\,x^2+b_2\,x^3\).
    MEYOU_LINEAR
    Linear benefit function (with interaction term): \(B(x,y)=b_0\,x=b_1\,y+\b_2\,x\,y\).
    WE_EXP
    Saturating benefit function following an exponential (sum of focal, \(x\), and opponent, \(y\), traits): \(B(x,y)=b_0 \left(1-e^{-b_1\,(x+y)}\right)\).
    WE_LINEAR
    Linear benefit function (sum of focal, \(x\), and opponent, \(y\), traits): \(B(x,y)=b_0\,(x+y)\).
    WE_LOG
    Saturating benefit function following a logarithm (sum of focal, \(x\), and opponent, \(y\), traits): \(B(x,y)=b_0\log{b_1\,(x+y)+1}\).
    WE_QUAD
    Quadratic benefit function (sum of focal, \(x\), and opponent, \(y\), traits): \(B(x,y)=b_0\,(x+y)+\b_1\,(x+y)^2\).
    WE_SQRT
    Saturating benefit function following a square root (sum of focal, \(x\), and opponent, \(y\), traits): \(B(x,y)=b_0\sqrt{x+y}\).
    YOU_EXP
    Saturating benefit function following an exponential (independent of focal): \(B(x,y)=b_0 \left(1-e^{-b_1\,y}\right)\).
    YOU_LINEAR
    Linear benefit function (independent of focal): \(B(x,y)=b_0\,y\).
    YOU_LOG
    Saturating benefit function following a logarithm (independent of focal): \(B(x,y)=b_0\log{b_1\,y+1}\).
    YOU_QUAD
    Quadratic benefit function (independent of focal): \(B(x,y)=b_0\,y+\b_1\,y^2\).
    YOU_SQRT
    Saturating benefit function following a square root (independent of focal): \(B(x,y)=b_0\sqrt{y}\).

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    (package private) String
    key
    The key of the benefit function.
    (package private) int
    nParams
    The number of parameters of the benefit function.
    (package private) String
    title
    The brief description of the benefit function for the help display.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    Benefits(String key, String title, int nParams)
    Create a new type of benefit function with key key and description title as well as nParams parameters.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getKey()
    Return key of in this collection.
    String
    getTitle()
    Brief description of purpose of this key.
    String
    toString()
     
    static Continuous.Benefits
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Continuous.Benefits[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface CLOption.Key

    getDescription

  • Enum Constant Details

    • YOU_LINEAR

      public static final Continuous.Benefits YOU_LINEAR
      Linear benefit function (independent of focal): \(B(x,y)=b_0\,y\).

    • YOU_QUAD

      public static final Continuous.Benefits YOU_QUAD
      Quadratic benefit function (independent of focal): \(B(x,y)=b_0\,y+\b_1\,y^2\).

    • YOU_SQRT

      public static final Continuous.Benefits YOU_SQRT
      Saturating benefit function following a square root (independent of focal): \(B(x,y)=b_0\sqrt{y}\).

    • YOU_LOG

      public static final Continuous.Benefits YOU_LOG
      Saturating benefit function following a logarithm (independent of focal): \(B(x,y)=b_0\log{b_1\,y+1}\).

    • YOU_EXP

      public static final Continuous.Benefits YOU_EXP
      Saturating benefit function following an exponential (independent of focal): \(B(x,y)=b_0 \left(1-e^{-b_1\,y}\right)\).

    • WE_LINEAR

      public static final Continuous.Benefits WE_LINEAR
      Linear benefit function (sum of focal, \(x\), and opponent, \(y\), traits): \(B(x,y)=b_0\,(x+y)\).

    • WE_QUAD

      public static final Continuous.Benefits WE_QUAD
      Quadratic benefit function (sum of focal, \(x\), and opponent, \(y\), traits): \(B(x,y)=b_0\,(x+y)+\b_1\,(x+y)^2\).

    • WE_SQRT

      public static final Continuous.Benefits WE_SQRT
      Saturating benefit function following a square root (sum of focal, \(x\), and opponent, \(y\), traits): \(B(x,y)=b_0\sqrt{x+y}\).

    • WE_LOG

      public static final Continuous.Benefits WE_LOG
      Saturating benefit function following a logarithm (sum of focal, \(x\), and opponent, \(y\), traits): \(B(x,y)=b_0\log{b_1\,(x+y)+1}\).

    • WE_EXP

      public static final Continuous.Benefits WE_EXP
      Saturating benefit function following an exponential (sum of focal, \(x\), and opponent, \(y\), traits): \(B(x,y)=b_0 \left(1-e^{-b_1\,(x+y)}\right)\).

    • MEYOU_LINEAR

      public static final Continuous.Benefits MEYOU_LINEAR
      Linear benefit function (with interaction term): \(B(x,y)=b_0\,x=b_1\,y+\b_2\,x\,y\).

    • ME_LINEAR

      public static final Continuous.Benefits ME_LINEAR
      Linear benefit function (independent of opponent): \(B(x,y)=b_0\,x\).

    • ME_QUAD

      public static final Continuous.Benefits ME_QUAD
      Quadratic benefit function (independent of opponent): \(B(x,y)=b_0\,x+b_1\,x^2\).

    • ME_QUBIC

      public static final Continuous.Benefits ME_QUBIC
      Cubic benefit function (independent of opponent): \(B(x,y)=b_0\,x+b_1\,x^2+b_2\,x^3\).

  • Field Details

    • key

      String key
      The key of the benefit function. Used when parsing command line options.
      See Also:

    • title

      String title
      The brief description of the benefit function for the help display.
      See Also:

    • nParams

      int nParams
      The number of parameters of the benefit function.

  • Constructor Details

    • Benefits

      private Benefits(String key, String title, int nParams)
      Create a new type of benefit function with key key and description title as well as nParams parameters.
      Parameters:
      key - the identifier for parsing of command line option
      title - the summary of the benefit function
      nParams - the number of parameters

  • Method Details

    • values

      public static Continuous.Benefits[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Continuous.Benefits valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<Continuous.Benefits>

    • getKey

      public String getKey()
      Description copied from interface: CLOption.Key
      Return key of in this collection. Used when parsing command line options.
      Specified by:
      getKey in interface CLOption.Key
      Returns:
      the key of the command line option

    • getTitle

      public String getTitle()
      Description copied from interface: CLOption.Key
      Brief description of purpose of this key. Used in GUI and in help display.
      Specified by:
      getTitle in interface CLOption.Key
      Returns:
      the title of the command line option
      See Also: