jive::solver::SolverException Class Reference

Signals the failure of a solver or preconditioner. More...

Inheritance diagram for jive::solver::SolverException:

Public Member Functions
	SolverException (const jem::String &place=String(), const jem::String &msg=String())
	Constructs a new SolverException given a location and message string. More...
virtual jem::String	name () const
	Returns the class name of this exception. More...
Public Member Functions inherited from jem::Exception
	Exception (const String &place=String(), const String &msg=String())
	Creates an Exception instance. More...
Public Member Functions inherited from jem::Throwable
	Throwable (const String &place=String(), Const String &msg=String())
	Creates a new Throwable instance. More...
	Throwable (const Throwable &rhs)
	Creates a copy of another Throwable instance. More...
	~Throwable ()
	Destructor. More...
virtual String	where () const
	Returns a string describing the context in which this Throwable was thrown. More...
virtual String	what () const
	Returns a string describing why this Throwable was thrown. More...

Detailed Description

#include <jive/solver/SolverException.h>

A SolverException is thrown when a solver fails to compute the solution of a linear system of equations. It is typically thrown when: the system of equations is singular; the maximum number of iterations is exceeded; the solution algorithm breaks down; etc.

A SolverException is also thrown when a preconditioner fails to compute an estimate of the solution of a linear system of equations.

Constructor & Destructor Documentation

jive::solver::SolverException::SolverException ( const jem::String &  place = String(), const jem::String &  msg = String()  )

explicit

Constructs a new SolverException given a location and message string.

Parameters

place	- a string describing where this exception was thrown.
msg	- a string describing why this exception was thrown.

Member Function Documentation

virtual jem::String jive::solver::SolverException::name ( ) const

virtual

Returns the full class name – including namespaces – of this Throwable instance. This function should be overriden by derived classes. For instance, a class named flip::FlopException should return the string "flip::FlopException".

Returns

A string describing the class name of this object.

Reimplemented from jem::Exception.

Reimplemented in jive::solver::IterativeSolverException.