Class ConvergenceFailure
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- dev.nm.algebra.linear.matrix.doubles.matrixtype.sparse.solver.iterative.ConvergenceFailure
-
- All Implemented Interfaces:
Serializable
public class ConvergenceFailure extends Exception
This exception is thrown byIterativeLinearSystemSolver.solve(dev.nm.algebra.linear.matrix.doubles.linearsystem.LSProblem, dev.nm.misc.algorithm.iterative.monitor.IterationMonitor)
when the iterative algorithm detects a breakdown or fails to converge.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ConvergenceFailure.Reason
the reasons for the convergence failure
-
Constructor Summary
Constructors Constructor Description ConvergenceFailure(ConvergenceFailure.Reason reason)
Construct an exception with reason.ConvergenceFailure(ConvergenceFailure.Reason reason, String message)
Construct an exception with reason and error message.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ConvergenceFailure.Reason
getReason()
Get the reason for the convergence failure.-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
Constructor Detail
-
ConvergenceFailure
public ConvergenceFailure(ConvergenceFailure.Reason reason)
Construct an exception with reason.- Parameters:
reason
- the reason for the failure
-
ConvergenceFailure
public ConvergenceFailure(ConvergenceFailure.Reason reason, String message)
Construct an exception with reason and error message.- Parameters:
reason
- the reason for the failuremessage
- the error message
-
-
Method Detail
-
getReason
public ConvergenceFailure.Reason getReason()
Get the reason for the convergence failure.- Returns:
- the failure reason
-
-