Package org.moeaframework.core.indicator

Class Indicators.IndicatorValues

java.lang.Object
org.moeaframework.core.indicator.Indicators.IndicatorValues
All Implemented Interfaces:
Displayable, Formattable<org.apache.commons.lang3.tuple.Pair<StandardIndicator,Double>>
Enclosing class:
Indicators
public static class Indicators.IndicatorValues extends Object implements Formattable<org.apache.commons.lang3.tuple.Pair<StandardIndicator,Double>>
Collection of indicator results, with values defaulting to 0d/0d if not included.

  • Constructor Details

    • IndicatorValues

      public IndicatorValues(NondominatedPopulation approximationSet)
      Constructs a new indicator result object for the given approximation set. All indicator values are defaulted to 0d/0d.
      Parameters:
      approximationSet - the approximation set used to compute these indicator values

  • Method Details

    • getApproximationSet

      public NondominatedPopulation getApproximationSet()
      Returns the approximation set used when computing these indicators values.
      Returns:
      the approximation set

    • get

      public double get(StandardIndicator indicator)
      Returns the indicator value, or 0d/0d if not configured to compute this metric.
      Parameters:
      indicator - the indicator
      Returns:
      the indicator value

    • getHypervolume

      public double getHypervolume()
      Returns the hypervolume value, or 0d/0d if not configured to compute this metric.
      Returns:
      the hypervolume value

    • getGenerationalDistance

      public double getGenerationalDistance()
      Returns the generational distance value, or 0d/0d if not configured to compute this metric.
      Returns:
      the generational distance value

    • getGenerationalDistancePlus

      public double getGenerationalDistancePlus()
      Returns the generational distance plus value, or 0d/0d if not configured to compute this metric.
      Returns:
      the generational distance plus value

    • getInvertedGenerationalDistance

      public double getInvertedGenerationalDistance()
      Returns the inverted generational distance value, or 0d/0d if not configured to compute this metric
      Returns:
      the inverted generational distance value

    • getInvertedGenerationalDistancePlus

      public double getInvertedGenerationalDistancePlus()
      Returns the inverted generational distance plus value, or 0d/0d if not configured to compute this metric
      Returns:
      the inverted generational distance plus value

    • getAdditiveEpsilonIndicator

      public double getAdditiveEpsilonIndicator()
      Returns the additive epsilon indicator value, or 0d/0d if not configured to compute this metric
      Returns:
      the additive epsilon indicator value

    • getSpacing

      public double getSpacing()
      Returns the spacing value, or 0d/0d if not configured to compute this metric.
      Returns:
      the spacing value

    • getMaximumParetoFrontError

      public double getMaximumParetoFrontError()
      Returns the maximum Pareto front error value, or 0d/0d if not configured to compute this metric
      Returns:
      the maximum Pareto front error value

    • getContribution

      public double getContribution()
      Returns the contribution value, or 0d/0d if not configured to compute this metric.
      Returns:
      the contribution value

    • getR1

      public double getR1()
      Returns the R1 indicator value, or 0d/0d if not configured to compute this metric.
      Returns:
      the R1 indicator value

    • getR2

      public double getR2()
      Returns the R2 indicator value, or 0d/0d if not configured to compute this metric.
      Returns:
      the R2 indicator value

    • getR3

      public double getR3()
      Returns the R3 indicator value, or 0d/0d if not configured to compute this metric.
      Returns:
      the R3 indicator value

    • asProperties

      public TypedProperties asProperties()
      Returns the indicator values as a typed properties object. This is useful for storing the data, such as with ResultFileWriter.
      Returns:
      the indicator values as typed properties

    • asTabularData

      public TabularData<org.apache.commons.lang3.tuple.Pair<StandardIndicator,Double>> asTabularData()
      Description copied from interface: Formattable
      Returns the contents of this object as a TabularData instance, which can be used to save, print, or format the data in various ways.
      Specified by:
      asTabularData in interface Formattable<org.apache.commons.lang3.tuple.Pair<StandardIndicator,Double>>
      Returns:
      the TabularData instance