RVLAlg::TernaryThresholdTerminator< Scalar > Class Template Reference

Terminator which takes a ternary function object, three vectors, and a tolerance. More...

#include <vectorterm.hh>

Inheritance diagram for RVLAlg::TernaryThresholdTerminator< Scalar >:

List of all members.

Public Member Functions
	TernaryThresholdTerminator (FunctionObjectScalarRedn< Scalar > &tf, Vector< Scalar > &tx, Vector< Scalar > &ty, Vector< Scalar > &tz, Scalar ttol)
virtual bool	query ()
Protected Attributes
FunctionObjectScalarRedn< Scalar > &	f
Vector< Scalar > &	x
Vector< Scalar > &	y
Vector< Scalar > &	z
Scalar	tol

---

Detailed Description

template<class Scalar>
class RVLAlg::TernaryThresholdTerminator< Scalar >

Terminator which takes a ternary function object, three vectors, and a tolerance.

STOP:

Definition at line 114 of file vectorterm.hh.

---

Constructor & Destructor Documentation

template<class Scalar>

RVLAlg::TernaryThresholdTerminator< Scalar >::TernaryThresholdTerminator	(	FunctionObjectScalarRedn< Scalar > &	tf,
		Vector< Scalar > &	tx,
		Vector< Scalar > &	ty,
		Vector< Scalar > &	tz,
		Scalar	ttol
	)

Definition at line 117 of file vectorterm.hh.

---

Member Function Documentation

template<class Scalar>

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

(

)

[virtual]

Implements RVLAlg::Terminator.

Definition at line 124 of file vectorterm.hh.

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

---

Member Data Documentation

template<class Scalar>

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

Definition at line 132 of file vectorterm.hh.

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

template<class Scalar>

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

Definition at line 133 of file vectorterm.hh.

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

template<class Scalar>

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

Definition at line 134 of file vectorterm.hh.

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

template<class Scalar>

Vector<Scalar>& RVLAlg::TernaryThresholdTerminator< Scalar >::z [protected]

Definition at line 135 of file vectorterm.hh.

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

template<class Scalar>

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

Definition at line 136 of file vectorterm.hh.

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

---

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

• vectorterm.hh

---