Documentation

This is thrown when an iterative algorithm attempts to use more iterations than allowed.

Public Member Functions
	MaxIterExceeded (const char description=0, const char file=0, int line=0, int maxiter=0, const char *exception_type="MaxIterExceeded") noexcept

	MaxIterExceeded (const MaxIterExceeded &)=default

	MaxIterExceeded (MaxIterExceeded &&)=default

virtual	~MaxIterExceeded ()=default

int	max_iter () const noexcept
	Return the maximum number of iterations. 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

MaxIterExceeded::MaxIterExceeded	(	const char *	description = `0`,
		const char *	file = `0`,
		int	line = `0`,
		int	maxiter = `0`,
		const char *	exception_type = `"MaxIterExceeded"`
	)

noexcept

Create a MaxIterExceeded exception.

Parameters

description	a description of the problem.
file	the file name where the problem occured.
line	the line number where the exception occured.
maxiter	the maximum number of iterations.
exception_type	the classname of the Exception specialization. The default is "MaxIterExceeded".

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

mpqc::MaxIterExceeded::MaxIterExceeded ( const MaxIterExceeded & )

default

mpqc::MaxIterExceeded::MaxIterExceeded ( MaxIterExceeded && )

default

virtual mpqc::MaxIterExceeded::~MaxIterExceeded ( )

virtualdefault

int mpqc::MaxIterExceeded::max_iter ( ) const

inlinenoexcept

Return the maximum number of iterations.

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