net.von_gagern.martin.confoo.opt
Enum Newton.ExitCondition

java.lang.Object
  java.lang.Enum<Newton.ExitCondition>
      net.von_gagern.martin.confoo.opt.Newton.ExitCondition

All Implemented Interfaces:

Serializable, Comparable<Newton.ExitCondition>

Enclosing class:

Newton

public static enum Newton.ExitCondition
extends Enum<Newton.ExitCondition>

Enumeration of possible reasons for the termination of an optimization.

This enumeration identifies the possible reasons that can cause the optimization to terminate without throwing an exception.

Since:

1.0

Author:

Martin von Gagern

See Also:

Newton.getExitCondition()

Enum Constant Summary

DELTA
Exit due to a small change in parameter space.

ESTIMATE
Exit due to a low estimate of residual value error.

GRADIENT
Exit due to a small gradient.

ITERATIONS
Exit due to maximum iteration count.

Method Summary

static Newton.ExitCondition	valueOf(String name) Returns the enum constant of this type with the specified name.
static Newton.ExitCondition[]	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

GRADIENT

public static final Newton.ExitCondition GRADIENT

Exit due to a small gradient. Optimization terminates for this reason if the norm of the gradient comes within the specified bound.

ESTIMATE

public static final Newton.ExitCondition ESTIMATE

Exit due to a low estimate of residual value error. Optimization terminates for this reason if the estimation of residual error value based on the second order approximation comes within the specified bound.

DELTA

public static final Newton.ExitCondition DELTA

Exit due to a small change in parameter space. Optimization terminates for this reason if the change of the function argument vector comes within the specified bound.

ITERATIONS

public static final Newton.ExitCondition ITERATIONS

Exit due to maximum iteration count. Optimization terminates for this reason if the maximum number of iterations has been reached.

Method Detail

values

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

Returns:

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

valueOf

public static Newton.ExitCondition valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null