RVLAlg::Norm2ThresholdTerminator< Scalar > Class Template Reference

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

#include <vectorterm.hh>

Inheritance diagram for RVLAlg::Norm2ThresholdTerminator< Scalar >:

List of all members.

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

---

Detailed Description

template<class Scalar>
class RVLAlg::Norm2ThresholdTerminator< Scalar >

Terminator which takes a vector and a tolerance.

STOP:

note: this is slightly cheaper than finding ||x|| < tol

Definition at line 168 of file vectorterm.hh.

---

Member Typedef Documentation

template<class Scalar>

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

Definition at line 170 of file vectorterm.hh.

---

Constructor & Destructor Documentation

template<class Scalar>

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

Definition at line 172 of file vectorterm.hh.

---

Member Function Documentation

template<class Scalar>

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

(

)

[virtual]

Implements RVLAlg::Terminator.

Definition at line 174 of file vectorterm.hh.

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

---

Member Data Documentation

template<class Scalar>

Vector<Scalar>& RVLAlg::Norm2ThresholdTerminator< Scalar >::x [protected]

Definition at line 179 of file vectorterm.hh.

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

template<class Scalar>

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

Definition at line 180 of file vectorterm.hh.

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

---

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

• vectorterm.hh

---