RVLAlg::CountingThresholdIterationTable< Scalar > Class Template Reference

This terminator behaves like a combined CountTerminator and MinTerminator, with the added side effect of printing an iteration table with the value of the watched Scalar. More...

#include <ioterm.hh>

Inheritance diagram for RVLAlg::CountingThresholdIterationTable< Scalar >:

List of all members.

Public Types
typedef ScalarFieldTraits< Scalar >::AbsType	atype
Public Member Functions
	CountingThresholdIterationTable (int maxcount, const atype &val, atype tol, string &scalarname, ostream &out=cout)
	CountingThresholdIterationTable (int maxcount, const atype &val, atype tol, ostream &out=cout)
bool	query ()
Protected Attributes
atype	tol_
const atype &	val_
ostream &	out_

---

Detailed Description

template<class Scalar>
class RVLAlg::CountingThresholdIterationTable< Scalar >

This terminator behaves like a combined CountTerminator and MinTerminator, with the added side effect of printing an iteration table with the value of the watched Scalar.

Returns stop when the count exceeds maxcount or the Scalar falls below the specified tolerance.

Definition at line 323 of file ioterm.hh.

---

Member Typedef Documentation

template<class Scalar>

typedef ScalarFieldTraits<Scalar>::AbsType RVLAlg::CountingThresholdIterationTable< Scalar >::atype

Definition at line 326 of file ioterm.hh.

---

Constructor & Destructor Documentation

template<class Scalar>

RVLAlg::CountingThresholdIterationTable< Scalar >::CountingThresholdIterationTable	(	int	maxcount,
		const atype &	val,
		atype	tol,
		string &	scalarname,
		ostream &	out = cout
	)

Definition at line 328 of file ioterm.hh.

References RVLAlg::CountingThresholdIterationTable< Scalar >::out_.

template<class Scalar>

RVLAlg::CountingThresholdIterationTable< Scalar >::CountingThresholdIterationTable	(	int	maxcount,
		const atype &	val,
		atype	tol,
		ostream &	out = cout
	)

Definition at line 339 of file ioterm.hh.

References RVLAlg::CountingThresholdIterationTable< Scalar >::out_.

---

Member Function Documentation

template<class Scalar>

bool RVLAlg::CountingThresholdIterationTable< Scalar >::query

(

)

[virtual]

Reimplemented from RVLAlg::CountTerminator.

Definition at line 349 of file ioterm.hh.

References RVLAlg::CountTerminator::getCount(), RVLAlg::CountingThresholdIterationTable< Scalar >::out_, RVLAlg::CountTerminator::query(), RVLAlg::CountingThresholdIterationTable< Scalar >::tol_, and RVLAlg::CountingThresholdIterationTable< Scalar >::val_.

---

Member Data Documentation

template<class Scalar>

atype RVLAlg::CountingThresholdIterationTable< Scalar >::tol_ [protected]

Definition at line 366 of file ioterm.hh.

Referenced by RVLAlg::CountingThresholdIterationTable< Scalar >::query().

template<class Scalar>

const atype& RVLAlg::CountingThresholdIterationTable< Scalar >::val_ [protected]

Definition at line 367 of file ioterm.hh.

Referenced by RVLAlg::CountingThresholdIterationTable< Scalar >::query().

template<class Scalar>

ostream& RVLAlg::CountingThresholdIterationTable< Scalar >::out_ [protected]

Definition at line 368 of file ioterm.hh.

Referenced by RVLAlg::CountingThresholdIterationTable< Scalar >::CountingThresholdIterationTable(), and RVLAlg::CountingThresholdIterationTable< Scalar >::query().

---

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

• ioterm.hh

---