Enum ConvergenceFailure.Reason
- java.lang.Object
-
- java.lang.Enum<ConvergenceFailure.Reason>
-
- dev.nm.algebra.linear.matrix.doubles.matrixtype.sparse.solver.iterative.ConvergenceFailure.Reason
-
- All Implemented Interfaces:
Serializable
,Comparable<ConvergenceFailure.Reason>
- Enclosing class:
- ConvergenceFailure
public static enum ConvergenceFailure.Reason extends Enum<ConvergenceFailure.Reason>
the reasons for the convergence failure
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BREAKDOWN
Thrown when the iterative algorithm fails to proceed during its iterations, due to, for example, division-by-zero.MAX_ITERATIONS_EXCEEDED
Thrown if the iterative algorithm fails to converge to a solution within a specified tolerance after the specified maximum number of iterations.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static ConvergenceFailure.Reason
valueOf(String name)
Returns the enum constant of this type with the specified name.static ConvergenceFailure.Reason[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
BREAKDOWN
public static final ConvergenceFailure.Reason BREAKDOWN
Thrown when the iterative algorithm fails to proceed during its iterations, due to, for example, division-by-zero.
-
MAX_ITERATIONS_EXCEEDED
public static final ConvergenceFailure.Reason MAX_ITERATIONS_EXCEEDED
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 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 (ConvergenceFailure.Reason c : 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 ConvergenceFailure.Reason 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 nameNullPointerException
- if the argument is null
-
-