edu.stanford.rsl.jpop
Enum FunctionOptimizer.TerminationCode

java.lang.Object
  extended by java.lang.Enum<FunctionOptimizer.TerminationCode>
      extended by edu.stanford.rsl.jpop.FunctionOptimizer.TerminationCode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<FunctionOptimizer.TerminationCode>
Enclosing class:
FunctionOptimizer

public static enum FunctionOptimizer.TerminationCode
extends java.lang.Enum<FunctionOptimizer.TerminationCode>

Termination codes ITRMCD = 0: Optimal solution found ITRMCD = 1: Terminated with gradient small, X is probably optimal ITRMCD = 2: Terminated with stepsize small, X is probably optimal ITRMCD = 3: Lower point cannot be found, X is probably optimal ITRMCD = 4: Iteration limit (150) exceeded ITRMCD = 5: Too many large steps, function may be unbounded


Enum Constant Summary
GradientSmall
           
IterationLimit
           
LowestPointFound
           
OptimalSolution
           
StepsizeSmall
           
TooManyLargeStepsProbableUnboundFunction
           
 
Method Summary
static FunctionOptimizer.TerminationCode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static FunctionOptimizer.TerminationCode[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

OptimalSolution

public static final FunctionOptimizer.TerminationCode OptimalSolution

GradientSmall

public static final FunctionOptimizer.TerminationCode GradientSmall

StepsizeSmall

public static final FunctionOptimizer.TerminationCode StepsizeSmall

LowestPointFound

public static final FunctionOptimizer.TerminationCode LowestPointFound

IterationLimit

public static final FunctionOptimizer.TerminationCode IterationLimit

TooManyLargeStepsProbableUnboundFunction

public static final FunctionOptimizer.TerminationCode TooManyLargeStepsProbableUnboundFunction
Method Detail

values

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

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

valueOf

public static FunctionOptimizer.TerminationCode 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