DGtal::IsWithinPointPredicate< TPoint > Struct Template Reference

#include <BasicPointPredicates.h>

Inheritance diagram for DGtal::IsWithinPointPredicate< TPoint >:

Collaboration diagram for DGtal::IsWithinPointPredicate< TPoint >:

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

Definition at line 173 of file BasicPointPredicates.h.

---

Member Typedef Documentation

template<typename TPoint>

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

Definition at line 175 of file BasicPointPredicates.h.

---

Constructor & Destructor Documentation

template<typename TPoint >

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

inline

Constructor from lower bound and upper bound.

Definition at line 83 of file BasicPointPredicates.ih.

  : myLowerBound( lowerBound ), myUpperBound( upperBound )
{}

---

Member Function Documentation

template<typename TPoint >

bool DGtal::IsWithinPointPredicate< TPoint >::operator() ( const Point &  p ) const

inline

Parameters:

p	any point.

Returns:

the value of the predicate at this point.

Definition at line 92 of file BasicPointPredicates.ih.

{
  return p.isUpper( myLowerBound )
    && p.isLower( myUpperBound );
}

---

Field Documentation

template<typename TPoint>

Point DGtal::IsWithinPointPredicate< TPoint >::myLowerBound

the upper bound.

Definition at line 189 of file BasicPointPredicates.h.

template<typename TPoint>

Point DGtal::IsWithinPointPredicate< TPoint >::myUpperBound

the lower bound.

Definition at line 191 of file BasicPointPredicates.h.

---

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

• BasicPointPredicates.h
• BasicPointPredicates.ih