Package org.uma.jmetal.qualityindicator.impl.hypervolume

Class Hypervolume

java.lang.Object

org.uma.jmetal.qualityindicator.QualityIndicator

org.uma.jmetal.qualityindicator.impl.hypervolume.Hypervolume

Direct Known Subclasses:

PISAHypervolume, WFGHypervolume

public abstract class Hypervolume
extends QualityIndicator

This interface represents implementations of the Hypervolume quality indicator

Author:

Antonio J. Nebro, Juan J. Durillo

Field Summary

Fields inherited from class org.uma.jmetal.qualityindicator.QualityIndicator

referenceFront

Constructor Summary

Constructors

Constructor	Description
Hypervolume()	Default constructor.
Hypervolume(double[] referencePoint)	Constructor with reference point.
Hypervolume(double[][] referenceFront)	Constructor with reference front.

Method Summary

Modifier and Type	Method	Description
double[]	getReferencePoint()	Gets the reference point used by this hypervolume indicator.
boolean	isTheLowerTheIndicatorValueTheBetter()	Returns true if lower indicator values are preferred and false otherwise
String	name()
void	setReferencePoint(double[] referencePoint)	Sets the reference point for this hypervolume indicator.

Methods inherited from class org.uma.jmetal.qualityindicator.QualityIndicator

compute, description, newInstance, referenceFront, referenceFront

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Hypervolume

public Hypervolume()

Default constructor.

Hypervolume

public Hypervolume(double[][] referenceFront)

Constructor with reference front.

Parameters:

referenceFront - The reference front

Throws:

IllegalArgumentException - if referenceFront is null or empty

Hypervolume

public Hypervolume(double[] referencePoint)

Constructor with reference point.

Parameters:

referencePoint - The reference point

Throws:

IllegalArgumentException - if referencePoint is null or empty

Method Details

getReferencePoint

public double[] getReferencePoint()

Gets the reference point used by this hypervolume indicator. The reference point is derived from the reference front by taking the maximum value in each objective dimension.

Returns:

The reference point

Throws:

IllegalStateException - if no reference front has been set

setReferencePoint

public void setReferencePoint(double[] referencePoint)

Sets the reference point for this hypervolume indicator. This will update the reference front accordingly.

Parameters:

referencePoint - The new reference point

Throws:

IllegalArgumentException - if referencePoint is null or empty

name

public String name()

Specified by:

name in class QualityIndicator

isTheLowerTheIndicatorValueTheBetter

public boolean isTheLowerTheIndicatorValueTheBetter()

Description copied from class: QualityIndicator

Returns true if lower indicator values are preferred and false otherwise

Specified by:

isTheLowerTheIndicatorValueTheBetter in class QualityIndicator