DGtal::deprecated::SetPredicate< TDigitalSet > Struct Template Reference

Aim: The predicate returning true iff the point is in the set given at construction. The set given at construction is aliased in the predicate and not cloned, which means that the lifetime of the set should exceed the lifetime of the predicate. More...

#include <DGtal/kernel/sets/SetPredicate.h>

Public Types
typedef TDigitalSet	DigitalSet
typedef DigitalSet::Domain	Domain
typedef Domain::Point	Point

Public Member Functions
	SetPredicate (ConstAlias< DigitalSet > aSet)
	SetPredicate (const SetPredicate &other)
SetPredicate &	operator= (const SetPredicate &other)
bool	operator() (const Point &p) const

Protected Member Functions
	SetPredicate ()

Private Attributes
const DigitalSet *	mySet

Detailed Description

template<typename TDigitalSet>
struct DGtal::deprecated::SetPredicate< TDigitalSet >

Aim: The predicate returning true iff the point is in the set given at construction. The set given at construction is aliased in the predicate and not cloned, which means that the lifetime of the set should exceed the lifetime of the predicate.

Description of template class 'SetPredicate'

Model of concepts::CPointPredicate.

Deprecated

Since 0.6, digital sets are also models of concepts::CPointPredicate, hence using a SetPredicate is therefore no more useful.

Definition at line 73 of file SetPredicate.h.

Member Typedef Documentation

DigitalSet

template<typename TDigitalSet >

typedef TDigitalSet DGtal::deprecated::SetPredicate< TDigitalSet >::DigitalSet

Definition at line 77 of file SetPredicate.h.

Domain

template<typename TDigitalSet >

typedef DigitalSet::Domain DGtal::deprecated::SetPredicate< TDigitalSet >::Domain

Definition at line 78 of file SetPredicate.h.

Point

template<typename TDigitalSet >

typedef Domain::Point DGtal::deprecated::SetPredicate< TDigitalSet >::Point

Definition at line 79 of file SetPredicate.h.

Constructor & Destructor Documentation

SetPredicate() [1/3]

template<typename TDigitalSet >

DGtal::deprecated::SetPredicate< TDigitalSet >::SetPredicate

(

ConstAlias< DigitalSet >

aSet

)

Constructor.

Parameters

aSet	any set (only aliased).

SetPredicate() [2/3]

template<typename TDigitalSet >

DGtal::deprecated::SetPredicate< TDigitalSet >::SetPredicate

(

const SetPredicate< TDigitalSet > &

other

)

Copy constructor.

Parameters

other

the object to clone.

SetPredicate() [3/3]

template<typename TDigitalSet >

DGtal::deprecated::SetPredicate< TDigitalSet >::SetPredicate ( )

protected

Constructor. Forbidden by default (protected to avoid g++ warnings).

Member Function Documentation

operator()()

template<typename TDigitalSet >

bool DGtal::deprecated::SetPredicate< TDigitalSet >::operator()

(

const Point &

p

)

const

Parameters

p	any point.

Returns

true iff p is in the domain.

operator=()

template<typename TDigitalSet >

SetPredicate & DGtal::deprecated::SetPredicate< TDigitalSet >::operator=

(

const SetPredicate< TDigitalSet > &

other

)

Assignment.

Parameters

other

the object to copy.

Returns

a reference on 'this'.

Field Documentation

mySet

template<typename TDigitalSet >

const DigitalSet* DGtal::deprecated::SetPredicate< TDigitalSet >::mySet

private

Aliasing pointer on the underlying set

Definition at line 120 of file SetPredicate.h.

---

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

• SetPredicate.h