com.numericalmethod.suanshu.matrix.doubles.matrixtype.sparse.solver.iterative
Enum IterativeSolver.ConvergenceFailure.Reason

java.lang.Object
  java.lang.Enum<IterativeSolver.ConvergenceFailure.Reason>
      com.numericalmethod.suanshu.matrix.doubles.matrixtype.sparse.solver.iterative.IterativeSolver.ConvergenceFailure.Reason

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IterativeSolver.ConvergenceFailure.Reason>

Enclosing class:

IterativeSolver.ConvergenceFailure

public static enum IterativeSolver.ConvergenceFailure.Reason
extends java.lang.Enum<IterativeSolver.ConvergenceFailure.Reason>

The reason for the convergence failure.

Enum Constant Summary

BREAKDOWN
Thrown when the iterative algorithm fails to proceed during its iterations, due to, for example, division-by-zero.

ITERATIONS
Thrown if the iterative algorithm fails to converge to a solution within a specified tolerance after the specified maximum number of iterations.

Method Summary

static IterativeSolver.ConvergenceFailure.Reason	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IterativeSolver.ConvergenceFailure.Reason[]	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

BREAKDOWN

public static final IterativeSolver.ConvergenceFailure.Reason BREAKDOWN

Thrown when the iterative algorithm fails to proceed during its iterations, due to, for example, division-by-zero.

ITERATIONS

public static final IterativeSolver.ConvergenceFailure.Reason ITERATIONS

Thrown if the iterative algorithm fails to converge to a solution within a specified tolerance after the specified maximum number of iterations.

Method Detail

values

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

Returns:

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

valueOf

public static IterativeSolver.ConvergenceFailure.Reason 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