DGtal  1.1.0
Public Types | Private Attributes
DGtal::concepts::CPredicate< T, TElement > Struct Template Reference

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

#include <DGtal/base/CPredicate.h>

Inheritance diagram for DGtal::concepts::CPredicate< T, TElement >:
[legend]
Collaboration diagram for DGtal::concepts::CPredicate< T, TElement >:
[legend]

Public Types

typedef TElement Element
 

Private Attributes

myPred
 
Element myElement
 
bool myBool
 

Additional Inherited Members

- Public Member Functions inherited from DGtal::concepts::CUnaryFunctor< T, TElement, bool >
 BOOST_CONCEPT_USAGE (CUnaryFunctor)
 

Detailed Description

template<typename T, typename TElement>
struct DGtal::concepts::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
Tthe type that should be a model of this predicate
TElementthe type of an element of the predicate domain.

Refinement of

Associated types

Notation

Definitions

Valid expressions and semantics

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

Invariants

Models

Notes

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

Definition at line 93 of file CPredicate.h.

Member Typedef Documentation

◆ Element

template<typename T , typename TElement >
typedef TElement DGtal::concepts::CPredicate< T, TElement >::Element

Definition at line 97 of file CPredicate.h.

Field Documentation

◆ myBool

template<typename T , typename TElement >
bool DGtal::concepts::CPredicate< T, TElement >::myBool
private

Definition at line 103 of file CPredicate.h.

◆ myElement

template<typename T , typename TElement >
Element DGtal::concepts::CPredicate< T, TElement >::myElement
private

Definition at line 102 of file CPredicate.h.

◆ myPred

template<typename T , typename TElement >
T DGtal::concepts::CPredicate< T, TElement >::myPred
private

Definition at line 101 of file CPredicate.h.


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