com.cureos.numerics

Enum CobylaExitStatus

java.lang.Object

java.lang.Enum<CobylaExitStatus>

com.cureos.numerics.CobylaExitStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CobylaExitStatus>

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

Enumeration of exit statuses associated with COBYLA2 optimization.

Author:

Anders Gustafsson, Cureos AB.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DivergingRoundingErrors Size of rounding error is becoming damaging, terminating prematurely.
MaxIterationsReached Maximum number of iterations (function/constraints evaluations) reached during optimization.
Normal Optimization successfully completed.
TerminateRequested Termination requested.

Method Summary

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

Normal

public static final CobylaExitStatus Normal

Optimization successfully completed.

MaxIterationsReached

public static final CobylaExitStatus MaxIterationsReached

Maximum number of iterations (function/constraints evaluations) reached during optimization.

DivergingRoundingErrors

public static final CobylaExitStatus DivergingRoundingErrors

Size of rounding error is becoming damaging, terminating prematurely.

TerminateRequested

public static final CobylaExitStatus TerminateRequested

Termination requested.

Method Detail

values

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

Returns:

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

valueOf

public static CobylaExitStatus 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