DGtal::IsLowerPointPredicate< TPoint > Struct Template Reference

#include <BasicPointPredicates.h>

Public Types
typedef TPoint	Point

Public Member Functions
	IsLowerPointPredicate (const Point &upperBound)
bool	operator() (const Point &p) const

Data Fields
Point	myUpperBound

---

Detailed Description

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

Aim: The predicate returns true when the point is below (or equal) the given upper bound.

Description of template class 'IsLowerPointPredicate'

Template Parameters:

TPoint

any point type

Definition at line 118 of file BasicPointPredicates.h.

---

Member Typedef Documentation

template<typename TPoint >

typedef TPoint DGtal::IsLowerPointPredicate< TPoint >::Point

Definition at line 120 of file BasicPointPredicates.h.

---

Constructor & Destructor Documentation

template<typename TPoint >

DGtal::IsLowerPointPredicate< TPoint >::IsLowerPointPredicate ( const Point &  upperBound )

inline

Constructor from upper bound.

Definition at line 49 of file BasicPointPredicates.ih.

  : myUpperBound( upperBound )
{}

---

Member Function Documentation

template<typename TPoint >

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

inline

Parameters:

p	any point.

Returns:

the value of the predicate at this point.

Definition at line 57 of file BasicPointPredicates.ih.

{
  return p.isLower( myUpperBound );
}

---

Field Documentation

template<typename TPoint >

Point DGtal::IsLowerPointPredicate< TPoint >::myUpperBound

the upper bound.

Definition at line 133 of file BasicPointPredicates.h.

---

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

• BasicPointPredicates.h
• BasicPointPredicates.ih