RVLAlg::UnaryThresholdTerminator< Scalar > Class Template Reference

Terminator which takes a unary function object, a vector, and a tolerance. More...

#include <vectorterm.hh>

Inheritance diagram for RVLAlg::UnaryThresholdTerminator< Scalar >:

List of all members.

Public Member Functions
	UnaryThresholdTerminator (FunctionObjectScalarRedn< Scalar > &tf, Vector< Scalar > &tx, Scalar ttol)
virtual bool	query ()
Protected Attributes
FunctionObjectScalarRedn< Scalar > &	f
Vector< Scalar > &	x
Scalar	tol

---

Detailed Description

template<class Scalar>
class RVLAlg::UnaryThresholdTerminator< Scalar >

Terminator which takes a unary function object, a vector, and a tolerance.

STOP:

Definition at line 56 of file vectorterm.hh.

---

Constructor & Destructor Documentation

template<class Scalar>

RVLAlg::UnaryThresholdTerminator< Scalar >::UnaryThresholdTerminator	(	FunctionObjectScalarRedn< Scalar > &	tf,
		Vector< Scalar > &	tx,
		Scalar	ttol
	)

Definition at line 59 of file vectorterm.hh.

---

Member Function Documentation

template<class Scalar>

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

(

)

[virtual]

Implements RVLAlg::Terminator.

Definition at line 64 of file vectorterm.hh.

References RVLAlg::UnaryThresholdTerminator< Scalar >::f, RVL::ScalarRedn< Scalar >::getValue(), RVLAlg::UnaryThresholdTerminator< Scalar >::tol, and RVLAlg::UnaryThresholdTerminator< Scalar >::x.

---

Member Data Documentation

template<class Scalar>

FunctionObjectScalarRedn<Scalar>& RVLAlg::UnaryThresholdTerminator< Scalar >::f [protected]

Definition at line 71 of file vectorterm.hh.

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

template<class Scalar>

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

Definition at line 72 of file vectorterm.hh.

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

template<class Scalar>

Scalar RVLAlg::UnaryThresholdTerminator< Scalar >::tol [protected]

Definition at line 73 of file vectorterm.hh.

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

---

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

• vectorterm.hh

---