DGtal::concepts::CCellFunctor< T > Struct Template Reference

Aim: Defines a functor on cells. More...

#include <DGtal/topology/CCellFunctor.h>

Public Types
typedef T::Cell	Cell
typedef T::Quantity	Quantity

Public Member Functions
	BOOST_CONCEPT_ASSERT ((CUnaryFunctor< T, Cell, Quantity >))
	BOOST_CONCEPT_USAGE (CCellFunctor)
void	check_const_constraints () const

Private Attributes
T	myT

Detailed Description

template<typename T>
struct DGtal::concepts::CCellFunctor< T >

Aim: Defines a functor on cells.

Description of concept 'CCellFunctor'

Associates values to cells.

Refinement of CUnaryFunctor

Associated types

• Cell : specifies the type for a cells (inner type).
• Quantity : specifies the type for a quantity (inner type).

Notation

• X : A type that is a model of CCellFunctor
• x : Object of type X
• c : Object of type Cell
• q : Object of type Quantity

Definitions

Valid expressions and semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	Complexity
Apply function	x( c)		q		the quantity of the function x at cell c

Invariants

Notes

Definition at line 89 of file CCellFunctor.h.

Member Typedef Documentation

Cell

template<typename T >

typedef T::Cell DGtal::concepts::CCellFunctor< T >::Cell

Definition at line 93 of file CCellFunctor.h.

Quantity

template<typename T >

typedef T::Quantity DGtal::concepts::CCellFunctor< T >::Quantity

Definition at line 94 of file CCellFunctor.h.

Member Function Documentation

BOOST_CONCEPT_ASSERT()

template<typename T >

DGtal::concepts::CCellFunctor< T >::BOOST_CONCEPT_ASSERT

(

(CUnaryFunctor< T, Cell, Quantity >)

)

BOOST_CONCEPT_USAGE()

template<typename T >

DGtal::concepts::CCellFunctor< T >::BOOST_CONCEPT_USAGE ( CCellFunctor< T >  )

inline

Definition at line 98 of file CCellFunctor.h.

    {
      check_const_constraints();
    }

References DGtal::concepts::CCellFunctor< T >::check_const_constraints().

check_const_constraints()

template<typename T >

void DGtal::concepts::CCellFunctor< T >::check_const_constraints ( ) const

inline

Definition at line 102 of file CCellFunctor.h.

    {
    }

Referenced by DGtal::concepts::CCellFunctor< T >::BOOST_CONCEPT_USAGE().

Field Documentation

myT

template<typename T >

T DGtal::concepts::CCellFunctor< T >::myT

private

Definition at line 110 of file CCellFunctor.h.

---

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

• CCellFunctor.h