sc::MaxIterExceeded Class Reference

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

#include <util/misc/scexception.h>

Inheritance diagram for sc::MaxIterExceeded:

Public Member Functions
	MaxIterExceeded (const char *description=0, const char *file=0, int line=0, int maxiter=0, const ClassDesc *class_desc=0, const char *exception_type="MaxIterExceeded") MPQC__NOEXCEPT
	Create a MaxIterExceeded exception. More...
	MaxIterExceeded (const MaxIterExceeded &) MPQC__NOEXCEPT
int	max_iter () const MPQC__NOEXCEPT
	Return the maximum number of iterations.
Public Member Functions inherited from sc::AlgorithmException
	AlgorithmException (const char *description=0, const char *file=0, int line=0, const ClassDesc *class_desc=0, const char *exception_type="AlgorithmException") MPQC__NOEXCEPT
	Create an AlgorithmException. More...
	AlgorithmException (const AlgorithmException &) MPQC__NOEXCEPT
Public Member Functions inherited from sc::SCException
	SCException (const char *description=0, const char *file=0, int line=0, const ClassDesc *class_desc=0, const char *exception_type="SCException") MPQC__NOEXCEPT
	Create an SCException. More...
	SCException (const SCException &) MPQC__NOEXCEPT
const char *	what () const MPQC__NOEXCEPT
	overload of Exception::what()
const ClassDesc *	class_desc () const MPQC__NOEXCEPT
	Returns the class descriptor of the object which generated the exception. More...
const char *	exception_type () const MPQC__NOEXCEPT
	Returns the classname of the exception. May return null.
std::ostream &	elaborate ()
	Returns a stream where additional information about the exception can be written. More...
Public Member Functions inherited from sc::Exception
	Exception (const char *description=0, const char *file=0, int line=0) MPQC__NOEXCEPT
	Create an Exception. More...
	Exception (const Exception &) MPQC__NOEXCEPT
const char *	description () const MPQC__NOEXCEPT
	Reimplementation of std::exception::what(). More...
const char *	file () const MPQC__NOEXCEPT
	Returns the name of the file in which the exception was created. More...
int	line () const MPQC__NOEXCEPT
	Returns the line number where the exception was created. More...

Detailed Description

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

Constructor & Destructor Documentation

MaxIterExceeded()

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

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.
class_desc	the ClassDesc for the object causing the exception.
exception_type	the classname of the SCException specialization. The default is "MaxIterExceeded".

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

---

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

• src/lib/util/misc/scexception.h