DGtal::EqualPointPredicate< TPoint > Struct Template Reference

#include <BasicPointPredicates.h>

Collaboration diagram for DGtal::EqualPointPredicate< TPoint >:

Public Types
typedef TPoint	Point

Public Member Functions
	EqualPointPredicate (const Point &aPoint)
bool	operator() (const Point &p) const

Data Fields
Point	myPoint

---

Detailed Description

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

Aim: The predicate returns true when the point given as argument equals the reference point given at construction.

Description of template class 'EqualPointPredicate'

Template Parameters:

TPoint

point type.

Definition at line 236 of file BasicPointPredicates.h.

---

Member Typedef Documentation

template<typename TPoint >

typedef TPoint DGtal::EqualPointPredicate< TPoint >::Point

Definition at line 238 of file BasicPointPredicates.h.

---

Constructor & Destructor Documentation

template<typename TPointPredicate >

DGtal::EqualPointPredicate< TPointPredicate >::EqualPointPredicate ( const Point &  aPoint )

inline

Constructor from a point.

Definition at line 119 of file BasicPointPredicates.ih.

  : myPoint( aPoint )
{
}

---

Member Function Documentation

template<typename TPointPredicate >

bool DGtal::EqualPointPredicate< TPointPredicate >::operator() ( const Point &  p ) const

inline

Parameters:

p	any point.

Returns:

the value of the predicate at this point.

Definition at line 128 of file BasicPointPredicates.ih.

{
  return (myPoint == p);
}

---

Field Documentation

template<typename TPoint >

Point DGtal::EqualPointPredicate< TPoint >::myPoint

Reference point.

Definition at line 252 of file BasicPointPredicates.h.

---

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

• BasicPointPredicates.h
• BasicPointPredicates.ih