Package org.moeaframework.analysis.series

Enum Class IndexType

java.lang.Object

java.lang.Enum<IndexType>

org.moeaframework.analysis.series.IndexType

All Implemented Interfaces:

Serializable, Comparable<IndexType>, Constable

public enum IndexType
extends Enum<IndexType>

The type of index used by IndexedResult or ResultSeries.

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
Index	The index represents the sequential position of the result.
NFE	The index represents the number of function evaluations (NFE).
Singleton	The series contains a single entry, which is returned regardless of what index is provided.

Method Summary

Modifier and Type	Method	Description
static IndexType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IndexType[]	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

NFE

public static final IndexType NFE

The index represents the number of function evaluations (NFE). When finding the entry with a given NFE, we typically find the nearest match.

Index

public static final IndexType Index

The index represents the sequential position of the result. This typically means the entries are not associated with a single run of an algorithm.

Singleton

public static final IndexType Singleton

The series contains a single entry, which is returned regardless of what index is provided. This is typically used by reference sets.

Method Details

values

public static IndexType[] 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 IndexType 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