vona.math

Enum PDLS.SolveStatus

java.lang.Object

java.lang.Enum<PDLS.SolveStatus>

vona.math.PDLS.SolveStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PDLS.SolveStatus>

Enclosing class:

PDLS

public static enum PDLS.SolveStatus
extends java.lang.Enum<PDLS.SolveStatus>

possible return values from PDLS.solve()

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONVERGED PDLS.updateProblem(int) returned 0
CONVERGENCE_DISABLED Called PDLS.updateProblem(int) but cannot continue because PDLS.convergenceEnabled is false.
DIVERGING PDLS.updateProblem(int) returned negative and PDLS.abortOnDiverge
INTERRUPT PDLS.abortOnInterrupt and thread interrupt detected during PDLS.solve().
MAX_ITERATIONS PDLS.maxConvergenceIterations have been run but PDLS.updateProblem(int) still returns true.
MAX_TIME PDLS.maxConvergenceMS has been spent running convergence iterations but but PDLS.updateProblem(int) still returns true.
STALLED PDLS.thetaDiff magnitude less than PDLS.thetaDiffTol after an iteration.
SVD_ERROR PDLS.abortOnSVDError and SVD library error detected during PDLS.solve().

Method Summary

Methods

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

CONVERGED

public static final PDLS.SolveStatus CONVERGED

PDLS.updateProblem(int) returned 0

STALLED

public static final PDLS.SolveStatus STALLED

PDLS.thetaDiff magnitude less than PDLS.thetaDiffTol after an iteration.

DIVERGING

public static final PDLS.SolveStatus DIVERGING

PDLS.updateProblem(int) returned negative and PDLS.abortOnDiverge

MAX_ITERATIONS

public static final PDLS.SolveStatus MAX_ITERATIONS

PDLS.maxConvergenceIterations have been run but PDLS.updateProblem(int) still returns true.

MAX_TIME

public static final PDLS.SolveStatus MAX_TIME

PDLS.maxConvergenceMS has been spent running convergence iterations but but PDLS.updateProblem(int) still returns true.

CONVERGENCE_DISABLED

public static final PDLS.SolveStatus CONVERGENCE_DISABLED

Called PDLS.updateProblem(int) but cannot continue because PDLS.convergenceEnabled is false.

INTERRUPT

public static final PDLS.SolveStatus INTERRUPT

PDLS.abortOnInterrupt and thread interrupt detected during PDLS.solve().

The innermost ongoing iteration (convergence, limiting, or priority) is always finished.

SVD_ERROR

public static final PDLS.SolveStatus SVD_ERROR

PDLS.abortOnSVDError and SVD library error detected during PDLS.solve().

The innermost ongoing iteration (convergence, limiting, or priority) is always finished.

Method Detail

values

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

Returns:

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

valueOf

public static PDLS.SolveStatus 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