RVLAlg::AbsIPThresholdTerminator< Scalar > Class Template Reference

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

#include <vectorterm.hh>

Inheritance diagram for RVLAlg::AbsIPThresholdTerminator< Scalar >:

RVLAlg::Terminator List of all members.

Public Types

typedef ScalarFieldTraits<
Scalar >::AbsType 
NormRetType

Public Member Functions

 AbsIPThresholdTerminator (Vector< Scalar > &tx, Vector< Scalar > &ty, NormRetType ttol)
 ~AbsIPThresholdTerminator ()
virtual bool query ()

Protected Attributes

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

Detailed Description

template<class Scalar>
class RVLAlg::AbsIPThresholdTerminator< Scalar >

Terminator which takes two vectors and a tolerance.

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

Definition at line 281 of file vectorterm.hh.


Member Typedef Documentation

template<class Scalar>
typedef ScalarFieldTraits<Scalar>::AbsType RVLAlg::AbsIPThresholdTerminator< Scalar >::NormRetType

Definition at line 283 of file vectorterm.hh.


Constructor & Destructor Documentation

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

Definition at line 285 of file vectorterm.hh.

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

template<class Scalar>
RVLAlg::AbsIPThresholdTerminator< Scalar >::~AbsIPThresholdTerminator (  ) 

Definition at line 292 of file vectorterm.hh.


Member Function Documentation

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

Implements RVLAlg::Terminator.

Definition at line 294 of file vectorterm.hh.

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


Member Data Documentation

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

Definition at line 300 of file vectorterm.hh.

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

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

Definition at line 301 of file vectorterm.hh.

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

template<class Scalar>
NormRetType RVLAlg::AbsIPThresholdTerminator< Scalar >::tol [protected]

Definition at line 302 of file vectorterm.hh.

Referenced by RVLAlg::AbsIPThresholdTerminator< 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