RVLAlg::DiffThresholdTerminator< Scalar > Class Template Reference

Terminator which takes two vectors and a tolerance. More...

#include <vectorterm.hh>

Inheritance diagram for RVLAlg::DiffThresholdTerminator< Scalar >:

List of all members.

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

---

Detailed Description

template<class Scalar>
class RVLAlg::DiffThresholdTerminator< Scalar >

Terminator which takes two vectors and a tolerance.

STOP:

Definition at line 190 of file vectorterm.hh.

---

Member Typedef Documentation

template<class Scalar>

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

Definition at line 192 of file vectorterm.hh.

---

Constructor & Destructor Documentation

template<class Scalar>

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

Definition at line 194 of file vectorterm.hh.

References RVLAlg::DiffThresholdTerminator< Scalar >::x, and RVLAlg::DiffThresholdTerminator< Scalar >::y.

---

Member Function Documentation

template<class Scalar>

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

(

)

[virtual]

Implements RVLAlg::Terminator.

Definition at line 202 of file vectorterm.hh.

References RVLAlg::DiffThresholdTerminator< Scalar >::tol, RVLAlg::DiffThresholdTerminator< Scalar >::x, and RVLAlg::DiffThresholdTerminator< Scalar >::y.

---

Member Data Documentation

template<class Scalar>

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

Definition at line 209 of file vectorterm.hh.

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

template<class Scalar>

Vector<Scalar>& RVLAlg::DiffThresholdTerminator< Scalar >::y [protected]

Definition at line 210 of file vectorterm.hh.

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

template<class Scalar>

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

Definition at line 211 of file vectorterm.hh.

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

---

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

• vectorterm.hh

---