Public Types | Public Member Functions | Data Fields

DGtal::IsWithinPointPredicate< TPoint > Struct Template Reference

Aim: The predicate returns true when the point is within the given bounds. More...

#include <BasicPointPredicates.h>

Inheritance diagram for DGtal::IsWithinPointPredicate< TPoint >:
Inheritance graph
[legend]
Collaboration diagram for DGtal::IsWithinPointPredicate< TPoint >:
Collaboration graph
[legend]

Public Types

typedef TPoint Point

Public Member Functions

 IsWithinPointPredicate (const Point &lowerBound, const Point &upperBound)
bool operator() (const Point &p) const

Data Fields

Point myLowerBound
Point myUpperBound

Detailed Description

template<typename TPoint>
struct DGtal::IsWithinPointPredicate< TPoint >

Aim: The predicate returns true when the point is within the given bounds.

Description of template class 'IsWithinPointPredicate'

Template Parameters:
TPoint any point type

Member Typedef Documentation

template<typename TPoint>
typedef TPoint DGtal::IsWithinPointPredicate< TPoint >::Point

Constructor & Destructor Documentation

template<typename TPoint>
DGtal::IsWithinPointPredicate< TPoint >::IsWithinPointPredicate ( const Point lowerBound,
const Point upperBound 
)

Constructor from lower bound and upper bound.


Member Function Documentation

template<typename TPoint>
bool DGtal::IsWithinPointPredicate< TPoint >::operator() ( const Point p  )  const
Parameters:
p any point.
Returns:
the value of the predicate at this point.

Field Documentation

template<typename TPoint>
Point DGtal::IsWithinPointPredicate< TPoint >::myLowerBound
template<typename TPoint>
Point DGtal::IsWithinPointPredicate< TPoint >::myUpperBound

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