NumErr Class Reference

exception base class for the TBCI NumLib More...

#include <except.h>

Inheritance diagram for NumErr:

Collaboration diagram for NumErr:

Public Member Functions
	NumErr ()
	NumErr (const char *txt, const long idx=0)
	NumErr (const std::string &str, const long idx=0)
	NumErr (const NumErr &ne)
virtual const char *	what () const throw ()
virtual	~NumErr () throw ()

Public Attributes
const char *	errtext
	Short error description in _what.
long	index
	Index for out of bounds error.

Detailed Description

exception base class for the TBCI NumLib

All exceptions that are generated by the TBCI library are derived from this class.

Currently, the structure uses an exception type depending on the storage object dealt with – so there is TBCI::VecErr, TBCI::MatErr etc.

In a later version, this will be changed to a scheme, where the exception class is based on the type of exception, such as RangeError, BadAlloc, Arithmetic (e.g. div by zero), Convergence, ...

Checking for error conditions such as bound checking ... are only done if ERRCHECK is defined at compile time. Otherwise, the checks are left out for performance reasons. All these checks are implemented using the BCHK macros.

The behaviour in case of error conditions with ERRCHECK defined defaults to reporting the error to stderr / cerr, but continuing the program execution. This allows to find more than one error at a time.

If you define ABORT_ON_ERROR (additionally to ERRCHECK), the error checks will call abort() after printing out the error message. This is useful, when you want to backtrace errors with a debugger.

If you define EXCEPT (additionally to ERRCHECK), an exception is thrown on error conditions, so you might catch and handle such conditions. If you don't, the results will be similar to calling abort() ...

Definition at line 58 of file except.h.

Constructor & Destructor Documentation

NumErr() [1/4]

NumErr::NumErr ( )

inline

Definition at line 65 of file except.h.

References errtext, index, and STD__.

Referenced by BdMatrixErr::BdMatrixErr(), BdMatrixErr::BdMatrixErr(), BdMatrixErr::BdMatrixErr(), CRMatErr::CRMatErr(), CRMatErr::CRMatErr(), CRMatErr::CRMatErr(), CSCMatErr::CSCMatErr(), CSCMatErr::CSCMatErr(), CSCMatErr::CSCMatErr(), F_BandMatErr::F_BandMatErr(), F_BandMatErr::F_BandMatErr(), FSVecErr::FSVecErr(), FSVecErr::FSVecErr(), FSVecErr::FSVecErr(), IdxErr::IdxErr(), IdxErr::IdxErr(), IdxErr::IdxErr(), MatErr::MatErr(), MatErr::MatErr(), MatErr::MatErr(), NumErr(), SymmBdMatrixErr::SymmBdMatrixErr(), SymmBdMatrixErr::SymmBdMatrixErr(), SymmBdMatrixErr::SymmBdMatrixErr(), TensErr::TensErr(), TensErr::TensErr(), TensErr::TensErr(), VecErr::VecErr(), VecErr::VecErr(), and VecErr::VecErr().

NumErr() [2/4]

NumErr::NumErr ( const char * txt, const long idx = 0 )

inline

Definition at line 70 of file except.h.

References errtext, index, and STD__.

NumErr() [3/4]

NumErr::NumErr ( const std::string & str, const long idx = 0 )

inline

Definition at line 75 of file except.h.

References errtext, index, and STD__.

NumErr() [4/4]

NumErr::NumErr ( const NumErr & ne )

inline

Definition at line 80 of file except.h.

References errtext, index, NumErr(), and STD__.

~NumErr()

virtual NumErr::~NumErr ( ) throw (  )

inlinevirtual

Definition at line 87 of file except.h.

References CSTD__, and errtext.

Member Function Documentation

what()

virtual const char * NumErr::what ( ) const throw (  )

inlinevirtual

Definition at line 85 of file except.h.

References errtext.

Member Data Documentation

errtext

const char* NumErr::errtext

Short error description in _what.

Definition at line 62 of file except.h.

Referenced by NumErr(), NumErr(), NumErr(), NumErr(), what(), and ~NumErr().

index

long NumErr::index

Index for out of bounds error.

Definition at line 64 of file except.h.

Referenced by NumErr(), NumErr(), NumErr(), and NumErr().

---

The documentation for this class was generated from the following file:

• except.h