RVLAlg::NormThresholdTerminator< Scalar > Class Template Reference

Terminator which takes a vector and a tolerance. More...

#include <vectorterm.hh>

Inheritance diagram for RVLAlg::NormThresholdTerminator< Scalar >:

List of all members.

Public Types
typedef ScalarFieldTraits< Scalar >::AbsType	NormRetType
Public Member Functions
	NormThresholdTerminator (const Vector< Scalar > &tx, NormRetType ttol)
virtual bool	query ()
Protected Attributes
const Vector< Scalar > &	x
NormRetType	tol

---

Detailed Description

template<class Scalar>
class RVLAlg::NormThresholdTerminator< Scalar >

Terminator which takes a vector and a tolerance.

STOP:

Definition at line 145 of file vectorterm.hh.

---

Member Typedef Documentation

template<class Scalar>

typedef ScalarFieldTraits<Scalar>::AbsType RVLAlg::NormThresholdTerminator< Scalar >::NormRetType

Definition at line 147 of file vectorterm.hh.

---

Constructor & Destructor Documentation

template<class Scalar>

RVLAlg::NormThresholdTerminator< Scalar >::NormThresholdTerminator	(	const Vector< Scalar > &	tx,
		NormRetType	ttol
	)

Definition at line 149 of file vectorterm.hh.

---

Member Function Documentation

template<class Scalar>

virtual bool RVLAlg::NormThresholdTerminator< Scalar >::query

(

)

[virtual]

Implements RVLAlg::Terminator.

Definition at line 151 of file vectorterm.hh.

References RVLAlg::NormThresholdTerminator< Scalar >::tol, and RVLAlg::NormThresholdTerminator< Scalar >::x.

---

Member Data Documentation

template<class Scalar>

const Vector<Scalar>& RVLAlg::NormThresholdTerminator< Scalar >::x [protected]

Definition at line 156 of file vectorterm.hh.

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

template<class Scalar>

NormRetType RVLAlg::NormThresholdTerminator< Scalar >::tol [protected]

Definition at line 157 of file vectorterm.hh.

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

---

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

• vectorterm.hh

---