Package org.moeaframework.analysis.io

Enum Class MetricFileWriter.Metric

java.lang.Object

java.lang.Enum<MetricFileWriter.Metric>

org.moeaframework.analysis.io.MetricFileWriter.Metric

All Implemented Interfaces:

Serializable, Comparable<MetricFileWriter.Metric>, Constable

Enclosing class:

MetricFileWriter

public static enum MetricFileWriter.Metric
extends Enum<MetricFileWriter.Metric>

Enumeration of metrics that are written to the metric file. This also specifies the order of the columns.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EpsilonIndicator	Additive epsilon-indicator (AEI).
GenerationalDistance	Generational distance (GD).
Hypervolume	Hypervolume.
InvertedGenerationalDistance	Inverted generational distance (IGD).
MaximumParetoFrontError	Maximum Pareto front error.
Spacing	Spacing.

Method Summary

Modifier and Type	Method	Description
static MetricFileWriter.Metric	fromString(String value)	Determine the metric from its string representation using case-insensitive matching.
static int	getNumberOfMetrics()	Returns the number of metrics written to the metric file.
static MetricFileWriter.Metric	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MetricFileWriter.Metric[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Hypervolume

public static final MetricFileWriter.Metric Hypervolume

Hypervolume.

GenerationalDistance

public static final MetricFileWriter.Metric GenerationalDistance

Generational distance (GD).

InvertedGenerationalDistance

public static final MetricFileWriter.Metric InvertedGenerationalDistance

Inverted generational distance (IGD).

Spacing

public static final MetricFileWriter.Metric Spacing

Spacing.

EpsilonIndicator

public static final MetricFileWriter.Metric EpsilonIndicator

Additive epsilon-indicator (AEI).

MaximumParetoFrontError

public static final MetricFileWriter.Metric MaximumParetoFrontError

Maximum Pareto front error.

Method Details

values

public static MetricFileWriter.Metric[] 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 MetricFileWriter.Metric 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

getNumberOfMetrics

public static int getNumberOfMetrics()

Returns the number of metrics written to the metric file.

Returns:

the number of metrics

fromString

public static MetricFileWriter.Metric fromString(String value)

Determine the metric from its string representation using case-insensitive matching.

Parameters:

value - the string representation of the metric

Returns:

the metric

Throws:

IllegalArgumentException - if the metric is not supported