Package org.moeaframework.core.indicator

Enum Class StandardIndicator

java.lang.Object
java.lang.Enum<StandardIndicator>
org.moeaframework.core.indicator.StandardIndicator
All Implemented Interfaces:
Serializable, Comparable<StandardIndicator>, Constable
public enum StandardIndicator extends Enum<StandardIndicator>
Enumeration of standard indicators provided by the MOEA Framework. These constants should match the corresponding class names.

  • Enum Constant Details

    • Hypervolume

      public static final StandardIndicator Hypervolume
      Hypervolume. The ideal approximation set has a value matching the hypervolume of the reference set. Since the sets are normalized, the largest possible hypervolume value is 1.0, but in practice the Pareto front typically will not dominate the entire space resulting in a hypervolume <= 1.0.

    • GenerationalDistance

      public static final StandardIndicator GenerationalDistance
      Generational distance (GD). The ideal approximation set has a distance of 0.0.

    • GenerationalDistancePlus

      public static final StandardIndicator GenerationalDistancePlus
      Generational distance plus (GD+), which modifies the distance calculation used by GD to construct a weakly Pareto compliance version of the indicator. The ideal approximation set has a distance of 0.0.

    • InvertedGenerationalDistance

      public static final StandardIndicator InvertedGenerationalDistance
      Inverted generational distance (IGD). The ideal approximation set has a distance of 0.0.

    • InvertedGenerationalDistancePlus

      public static final StandardIndicator InvertedGenerationalDistancePlus
      Inverted generational distance plus (IGD+), which modifies the distance calculation used by GD to construct a weakly Pareto compliance version of the indicator. The ideal approximation set has a distance of 0.0.

    • AdditiveEpsilonIndicator

      public static final StandardIndicator AdditiveEpsilonIndicator
      Additive epsilon-indicator (AEI). The ideal approximation set has a value of 0.0.

    • Spacing

      public static final StandardIndicator Spacing
      Spacing.

    • MaximumParetoFrontError

      public static final StandardIndicator MaximumParetoFrontError
      Maximum Pareto front error. The ideal approximation set has a value of 0.0.

    • Contribution

      public static final StandardIndicator Contribution
      Pareto set contribution. The ideal approximation set has a value of 1.0, meaning each point in the reference set is "covered" by a point in the approximation set.

    • R1Indicator

      public static final StandardIndicator R1Indicator
      R1 indicator. The ideal approximation set has a value of 1.0.

    • R2Indicator

      public static final StandardIndicator R2Indicator
      R2 indicator. The ideal approximation set has a value of -1.0.

    • R3Indicator

      public static final StandardIndicator R3Indicator
      R3 indicator. The ideal approximation set has a value of -1d/0d.

  • Method Details

    • values

      public static StandardIndicator[] 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 StandardIndicator 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

    • areLargerValuesPreferred

      public boolean areLargerValuesPreferred()
      Returns true if larger indicator values are preferred; false if smaller values are preferred. Note that many of these indicators, especially those that are normalized, have bounded ranges.
      Returns:
      true if larger indicator values are preferred; false otherwise

    • isParetoCompliant

      public boolean isParetoCompliant()
      Returns true if the indicator is Pareto compliant, meaning if one approximation set strictly dominates another set, the indicator value will be lower.
      Returns:
      true if Pareto compliant; false otherwise

    • isReferenceSetRequired

      public boolean isReferenceSetRequired()
      Returns true if a reference set is required to calculate the indicator. All normalized indicators require a reference set (unless normalization has been disabled).
      Returns:
      true if a reference set is required; false otherwise