DGtal  1.5.beta
DGtal::functors::IsWithinPointPredicate< TPoint > Struct Template Reference

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

#include <DGtal/kernel/BasicPointPredicates.h>

Inheritance diagram for DGtal::functors::IsWithinPointPredicate< TPoint >:
[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
 the upper bound. More...
 
Point myUpperBound
 the lower bound. More...
 

Detailed Description

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

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

Description of template class 'IsWithinPointPredicate'

Template Parameters
TPointany point type

Definition at line 175 of file BasicPointPredicates.h.

Member Typedef Documentation

◆ Point

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

Definition at line 177 of file BasicPointPredicates.h.

Constructor & Destructor Documentation

◆ IsWithinPointPredicate()

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

Constructor from lower bound and upper bound.

Member Function Documentation

◆ operator()()

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

Field Documentation

◆ myLowerBound

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

the upper bound.

Definition at line 192 of file BasicPointPredicates.h.

◆ myUpperBound

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

the lower bound.

Definition at line 194 of file BasicPointPredicates.h.


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