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

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.numericalmethod.suanshu.matrix.doubles.matrixtype.sparse.solver.iterative.IterativeSolver.ConvergenceFailure

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

IterativeSolver

public static class IterativeSolver.ConvergenceFailure
extends java.lang.Exception

This exception is thrown by IterativeSolver.solve(com.numericalmethod.suanshu.matrix.doubles.matrixtype.sparse.solver.iterative.IterativeSolver.Problem) when the iterative algorithm detects a breakdown or fails to converge.

See Also:

Serialized Form

Nested Class Summary

static class

IterativeSolver.ConvergenceFailure.Reason The reason for the convergence failure.

Constructor Summary

IterativeSolver.ConvergenceFailure(IterativeSolver.ConvergenceFailure.Reason reason)
Create an exception with reason.

IterativeSolver.ConvergenceFailure(IterativeSolver.ConvergenceFailure.Reason reason, java.lang.String message)
Create an exception with reason and error message.

Method Summary

IterativeSolver.ConvergenceFailure.Reason

reason() Get the reason for the convergence failure.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IterativeSolver.ConvergenceFailure

public IterativeSolver.ConvergenceFailure(IterativeSolver.ConvergenceFailure.Reason reason)

Create an exception with reason.

Parameters:

reason - the reason for the failure

IterativeSolver.ConvergenceFailure

public IterativeSolver.ConvergenceFailure(IterativeSolver.ConvergenceFailure.Reason reason,
                                          java.lang.String message)

Create an exception with reason and error message.

Parameters:

reason - the reason for the failure

message - the error message

Method Detail

reason

public IterativeSolver.ConvergenceFailure.Reason reason()

Get the reason for the convergence failure.