sbrt.kernel.math.optimization
Enum OptSense

java.lang.Object
  extended by java.lang.Enum<OptSense>
      extended by sbrt.kernel.math.optimization.OptSense
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<OptSense>

public enum OptSense
extends java.lang.Enum<OptSense>

This enum type is used to represent the sense, or direction, of an optimization problem.

Author:
This enum type was written and documented by Jeremiah Wright while in the Wagner lab.

Enum Constant Summary
MAX
          Used to indicate a maximization problem.
MIN
          Used to indicate a minimization problem.
 
Method Summary
 java.lang.String toString()
          Returns an appropriate string representation of this optimization sense.
static OptSense valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static OptSense[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

MAX

public static final OptSense MAX
Used to indicate a maximization problem.


MIN

public static final OptSense MIN
Used to indicate a minimization problem.

Method Detail

values

public static OptSense[] 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 (OptSense c : OptSense.values())
    System.out.println(c);

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

valueOf

public static OptSense valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()
Returns an appropriate string representation of this optimization sense.

Overrides:
toString in class java.lang.Enum<OptSense>
Returns:
an appropriate string representation of this optimization sense.