RVLAlg::IPThresholdTerminator< Scalar > Class Template Reference

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

#include <vectorterm.hh>

Inheritance diagram for RVLAlg::IPThresholdTerminator< Scalar >:

RVLAlg::Terminator List of all members.

Public Member Functions

 IPThresholdTerminator (Vector< Scalar > &tx, Vector< Scalar > &ty, Scalar ttol)
virtual bool query ()

Protected Attributes

Vector< Scalar > & x
Vector< Scalar > & y
Scalar tol

Detailed Description

template<class Scalar>
class RVLAlg::IPThresholdTerminator< Scalar >

Terminator which takes two vectors and a tolerance.

STOP: $\left< x, y \right> < tol$

Definition at line 254 of file vectorterm.hh.


Constructor & Destructor Documentation

template<class Scalar>
RVLAlg::IPThresholdTerminator< Scalar >::IPThresholdTerminator ( Vector< Scalar > &  tx,
Vector< Scalar > &  ty,
Scalar  ttol 
)

Definition at line 256 of file vectorterm.hh.

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


Member Function Documentation

template<class Scalar>
virtual bool RVLAlg::IPThresholdTerminator< Scalar >::query (  )  [virtual]

Implements RVLAlg::Terminator.

Definition at line 264 of file vectorterm.hh.

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


Member Data Documentation

template<class Scalar>
Vector<Scalar>& RVLAlg::IPThresholdTerminator< Scalar >::x [protected]

Definition at line 270 of file vectorterm.hh.

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

template<class Scalar>
Vector<Scalar>& RVLAlg::IPThresholdTerminator< Scalar >::y [protected]

Definition at line 271 of file vectorterm.hh.

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

template<class Scalar>
Scalar RVLAlg::IPThresholdTerminator< Scalar >::tol [protected]

Definition at line 272 of file vectorterm.hh.

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


The documentation for this class was generated from the following file:
Generated on 5 Jan 2017 for RvlAlg by  doxygen 1.4.7