MOEA Framework 2.12
API Specification

org.moeaframework.core.indicator
Class Contribution

java.lang.Object
  extended by org.moeaframework.core.indicator.Contribution
All Implemented Interfaces:
Indicator

public class Contribution
extends Object
implements Indicator

Measures the contribution of the approximation set to the reference set.


Constructor Summary
Contribution(NondominatedPopulation referenceSet)
          Constructs the contribution indicator using the specified reference set.
Contribution(NondominatedPopulation referenceSet, double epsilon)
          Constructs the contribution indicator using the specified reference set and ε value.
Contribution(NondominatedPopulation referenceSet, double[] epsilon)
          Constructs the contribution indicator using the specified reference set and ε values.
Contribution(NondominatedPopulation referenceSet, EpsilonBoxDominanceComparator comparator)
          Constructs the contribution indicator using the specified reference set and ε-box dominance comparator.
 
Method Summary
 double evaluate(NondominatedPopulation approximationSet)
          Returns the value of this unary quality indicator given the specified non-dominated population.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Contribution

public Contribution(NondominatedPopulation referenceSet)
Constructs the contribution indicator using the specified reference set. Exact matching is used.

Parameters:
referenceSet - the reference set
Throws:
IllegalArgumentException - if the reference set is empty

Contribution

public Contribution(NondominatedPopulation referenceSet,
                    double epsilon)
Constructs the contribution indicator using the specified reference set and ε value. Solutions residing in the same ε-box are considered to be equivalent.

Parameters:
referenceSet - the reference set
epsilon - the ε value
Throws:
IllegalArgumentException - if the reference set is empty

Contribution

public Contribution(NondominatedPopulation referenceSet,
                    double[] epsilon)
Constructs the contribution indicator using the specified reference set and ε values. Solutions residing in the same ε-box are considered to be equivalent.

Parameters:
referenceSet - the reference set
epsilon - the ε values
Throws:
IllegalArgumentException - if the reference set is empty

Contribution

public Contribution(NondominatedPopulation referenceSet,
                    EpsilonBoxDominanceComparator comparator)
Constructs the contribution indicator using the specified reference set and ε-box dominance comparator. Solutions residing in the same ε-box are considered to be equivalent.If the comparator is null, exact matching is used.

Parameters:
referenceSet - the reference set
comparator - the ε-box dominance comparator used to determine if solutions in the reference set are covered by solutions in the approximation set; or null if exact matching is used
Throws:
IllegalArgumentException - if the reference set is empty
Method Detail

evaluate

public double evaluate(NondominatedPopulation approximationSet)
Description copied from interface: Indicator
Returns the value of this unary quality indicator given the specified non-dominated population.

Specified by:
evaluate in interface Indicator
Parameters:
approximationSet - the non-dominated population to be evaluated
Returns:
the value of this quality indicator given the specified non-dominated population

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!