Module com.darkcollective.relix.ast

Package com.darkcollective.relix.ast

Enum Class ObjectiveSense

java.lang.Object

java.lang.Enum<ObjectiveSense>

com.darkcollective.relix.ast.ObjectiveSense

All Implemented Interfaces:

Serializable, Comparable<ObjectiveSense>, Constable

public enum ObjectiveSense
extends Enum<ObjectiveSense>

The optimisation direction of an OptimizeNode: whether the objective is to be maximised or minimised.

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
MAXIMIZE	Maximise the objective (e.g.
MINIMIZE	Minimise the objective (e.g.

Method Summary

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

MAXIMIZE

public static final ObjectiveSense MAXIMIZE

Maximise the objective (e.g. total value).

MINIMIZE

public static final ObjectiveSense MINIMIZE

Minimise the objective (e.g. total cost).

Method Details

values

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