Enum Class Direction

java.lang.Object

java.lang.Enum<Direction>

com.eqixiac.equinix.design.spi.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>, Constable

public enum Direction
extends Enum<Direction>

Whether a smaller or a larger Objective value is better.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MAXIMIZE	Larger is better (coverage, resilience).
MINIMIZE	Smaller is better (latency, cost).

Method Summary

Modifier and Type	Method	Description
int	compare(double a, double b)	Compares two values of an objective with this direction.
static Direction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Direction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MINIMIZE

public static final Direction MINIMIZE

Smaller is better (latency, cost).

MAXIMIZE

public static final Direction MAXIMIZE

Larger is better (coverage, resilience).

Method Details

values

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

compare

public int compare(double a,
 double b)

Compares two values of an objective with this direction.

Parameters:

a - one value

b - another value

Returns:

negative when a is better, positive when b is better, zero when equal