com.bayesserver.optimization

Enum ObjectiveKind

java.lang.Object

java.lang.Enum<ObjectiveKind>

com.bayesserver.optimization.ObjectiveKind

All Implemented Interfaces:

Serializable, Comparable<ObjectiveKind>

public enum ObjectiveKind
extends Enum<ObjectiveKind>

The type of optimization to carry out, such as Minimization or Maximization.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAXIMIZE The optimization target should be maximized.
MINIMIZE The optimization target should be minimized.
TARGET The objective should be as close to a target value as possible

Method Summary

Modifier and Type	Method and Description
static ObjectiveKind	valueOf(String name) Returns the enum constant of this type with the specified name.
static ObjectiveKind[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MINIMIZE

public static final ObjectiveKind MINIMIZE

The optimization target should be minimized.

MAXIMIZE

public static final ObjectiveKind MAXIMIZE

The optimization target should be maximized.

TARGET

public static final ObjectiveKind TARGET

The objective should be as close to a target value as possible

Method Detail

values

public static ObjectiveKind[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ObjectiveKind c : ObjectiveKind.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ObjectiveKind valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null