MOEA Framework 2.12
API Specification

org.moeaframework.core.indicator
Class QualityIndicator

java.lang.Object
  extended by org.moeaframework.core.indicator.QualityIndicator

public class QualityIndicator
extends Object

Evaluates multiple indicators while avoiding repetitive computations.


Constructor Summary
QualityIndicator(Problem problem, NondominatedPopulation referenceSet)
          Constructs a quality indicator evaluator for the specified problem and corresponding reference set.
 
Method Summary
 void calculate(NondominatedPopulation approximationSet)
          Calculates all the metrics for the specified approximation set.
 double getAdditiveEpsilonIndicator()
          Returns the additive ε-indicator of the approximation set from the last invocation of calculate.
 double getGenerationalDistance()
          Returns the generational distance of the approximation set from the last invocation of calculate.
 double getHypervolume()
          Returns the hypervolume of the approximation set from the last invocation of calculate.
 double getInvertedGenerationalDistance()
          Returns the inverted generational distance of the approximation set from the last invocation of calculate.
 double getMaximumParetoFrontError()
          Returns the maximum Pareto front error of the approximation set from the last invocation of calculate.
 Problem getProblem()
          Returns the problem.
 NondominatedPopulation getReferenceSet()
          The reference set for the problem.
 double getSpacing()
          Returns the spacing of the approximation set from the last invocation of calculate.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QualityIndicator

public QualityIndicator(Problem problem,
                        NondominatedPopulation referenceSet)
Constructs a quality indicator evaluator for the specified problem and corresponding reference set.

Parameters:
problem - the problem
referenceSet - the reference set for the problem
Method Detail

getProblem

public Problem getProblem()
Returns the problem.

Returns:
the problem

getGenerationalDistance

public double getGenerationalDistance()
Returns the generational distance of the approximation set from the last invocation of calculate.

Returns:
the generational distance of the approximation set from the last invocation of calculate
Throws:
IllegalStateException - if the calculate method has not been invoked

getInvertedGenerationalDistance

public double getInvertedGenerationalDistance()
Returns the inverted generational distance of the approximation set from the last invocation of calculate.

Returns:
the inverted generational distance of the approximation set from the last invocation of calculate
Throws:
IllegalStateException - if the calculate method has not been invoked

getAdditiveEpsilonIndicator

public double getAdditiveEpsilonIndicator()
Returns the additive ε-indicator of the approximation set from the last invocation of calculate.

Returns:
the additive ε-indicator of the approximation set from the last invocation of calculate
Throws:
IllegalStateException - if the calculate method has not been invoked

getHypervolume

public double getHypervolume()
Returns the hypervolume of the approximation set from the last invocation of calculate.

Returns:
the hypervolume of the approximation set from the last invocation of calculate
Throws:
IllegalStateException - if the calculate method has not been invoked

getMaximumParetoFrontError

public double getMaximumParetoFrontError()
Returns the maximum Pareto front error of the approximation set from the last invocation of calculate.

Returns:
the maximum Pareto front error of the approximation set from the last invocation of calculate
Throws:
IllegalStateException - if the calculate method has not been invoked

getSpacing

public double getSpacing()
Returns the spacing of the approximation set from the last invocation of calculate.

Returns:
the spacing of the approximation set from the last invocation of calculate
Throws:
IllegalStateException - if the calculate method has not been invoked

getReferenceSet

public NondominatedPopulation getReferenceSet()
The reference set for the problem.

Returns:
the reference set for the problem
Throws:
IllegalStateException - if the calculate method has not been invoked

calculate

public void calculate(NondominatedPopulation approximationSet)
Calculates all the metrics for the specified approximation set. By grouping all calculates into one method, repetitive calculates are avoided.

Parameters:
approximationSet - the approximation set

MOEA Framework 2.12
API Specification

Copyright 2009-2016 MOEA Framework. All rights reserved.
Licensed under the GNU Lesser General Public License.
Return to the MOEA Framework homepage. Visit us on Github!