Documentation

This is thrown when when some tolerance is exceeded.

Public Member Functions
	ToleranceExceeded (const char description=0, const char file=0, int line=0, double tol=0, double val=0, const char *exception_type="ToleranceExceeded") noexcept

	ToleranceExceeded (const ToleranceExceeded &)=default

	ToleranceExceeded (ToleranceExceeded &&)=default

virtual	~ToleranceExceeded ()=default

double	tolerance () noexcept
	Return the required tolerance. More...

double	value () noexcept
	Return the value which was obtained. More...

Public Member Functions inherited from mpqc::AlgorithmException
	AlgorithmException (const char description=0, const char file=0, int line=0, const char *exception_type="AlgorithmException") noexcept

	AlgorithmException (const AlgorithmException &)=default

	AlgorithmException (AlgorithmException &&)=default

virtual	~AlgorithmException ()=default

Public Member Functions inherited from mpqc::Exception
	Exception (const char description=0, const char file=0, int line=0, const char *exception_type="Exception") noexcept

	Exception (const Exception &) noexcept

	Exception (Exception &&)=default

virtual	~Exception () noexcept

const char *	what () const noexcept
	overload of Exception::what() More...

const char *	exception_type () const noexcept
	Returns the classname of the exception. May return null. More...

std::ostream &	elaborate ()

Public Member Functions inherited from mpqc::detail::Exception
	Exception (const char description=0, const char file=0, int line=0) noexcept

	Exception (const Exception &)=default

	Exception (Exception &&)=default

const char *	description () const noexcept

const char *	file () const noexcept

int	line () const noexcept

Constructor & Destructor Documentation

◆ ToleranceExceeded() [1/3]

ToleranceExceeded::ToleranceExceeded	(	const char *	description = `0`,
		const char *	file = `0`,
		int	line = `0`,
		double	tol = `0`,
		double	val = `0`,
		const char *	exception_type = `"ToleranceExceeded"`
	)

noexcept

Create a ToleranceExceeded exception.

Parameters

description	a description of the problem.
file	the file name where the problem occured.
line	the line number where the exception occured.
tol	the required tolerance.
val	the value which was obtained.
exception_type	the classname of the Exception specialization. The default is "ToleranceExceeded".

It is suggested that the special macros FILE and LINE be given as the file and line arguments, respectively.

◆ ToleranceExceeded() [2/3]

mpqc::ToleranceExceeded::ToleranceExceeded ( const ToleranceExceeded & )

default

◆ ToleranceExceeded() [3/3]

mpqc::ToleranceExceeded::ToleranceExceeded ( ToleranceExceeded && )

default

◆ ~ToleranceExceeded()

virtual mpqc::ToleranceExceeded::~ToleranceExceeded ( )

virtualdefault

Member Function Documentation

◆ tolerance()

double mpqc::ToleranceExceeded::tolerance ( )

inlinenoexcept

Return the required tolerance.

◆ value()

double mpqc::ToleranceExceeded::value ( )