DGtal::CPredicate< T, TElement > Struct Template Reference

#include <CPredicate.h>

Inheritance diagram for DGtal::CPredicate< T, TElement >:

Collaboration diagram for DGtal::CPredicate< T, TElement >:

Public Types
typedef TElement	Element

Public Member Functions
	BOOST_CONCEPT_USAGE (CPredicate)
void	checkConstConstraints () const

Private Attributes
T	myPred
Element	myElement
bool	myBool

---

Detailed Description

template<typename T, typename TElement>
struct DGtal::CPredicate< T, TElement >

Aim: Defines a predicate function, ie. a functor mapping a domain into the set of booleans.

Description of concept 'CPredicate'

Template Parameters:

T	the type that should be a model of this predicate
TELement	the type of an element of the predicate domain.

Refinement of boost::Assignable<T>

Associated types :

Notation

• X : A type that is a model of CPredicate
• x : Object of type X
• p : Object of type TElement

Definitions

Valid expressions and semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Postcondition	Complexity
Apply predicate	x( p )		bool		the value of the predicate x at element p

Invariants

Models

 - specializations: CPointPredicate, CVertexPredicate

Notes

 CPredicate allows to factor codes when writing concepts for new
 kinds of predicates.

Definition at line 107 of file CPredicate.h.

---

Member Typedef Documentation

template<typename T, typename TElement>

typedef TElement DGtal::CPredicate< T, TElement >::Element

Definition at line 111 of file CPredicate.h.

---

Member Function Documentation

template<typename T, typename TElement>

DGtal::CPredicate< T, TElement >::BOOST_CONCEPT_USAGE ( CPredicate< T, TElement >  )

inline

Definition at line 113 of file CPredicate.h.

    {
      checkConstConstraints();
    }

template<typename T, typename TElement>

void DGtal::CPredicate< T, TElement >::checkConstConstraints ( ) const

inline

Definition at line 118 of file CPredicate.h.

Referenced by DGtal::CPredicate< T, T::Vertex >::BOOST_CONCEPT_USAGE().

    {
      // x( p ) returns bool.
      ConceptUtils::sameType( myBool, myPred.operator() ( myElement ) );
    }

---

Field Documentation

template<typename T, typename TElement>

bool DGtal::CPredicate< T, TElement >::myBool

private

Definition at line 127 of file CPredicate.h.

Referenced by DGtal::CPredicate< T, T::Vertex >::checkConstConstraints().

template<typename T, typename TElement>

Element DGtal::CPredicate< T, TElement >::myElement

private

Definition at line 126 of file CPredicate.h.

Referenced by DGtal::CPredicate< T, T::Vertex >::checkConstConstraints().

template<typename T, typename TElement>

T DGtal::CPredicate< T, TElement >::myPred

private

Definition at line 125 of file CPredicate.h.

Referenced by DGtal::CPredicate< T, T::Vertex >::checkConstConstraints().

---

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

• CPredicate.h