DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType > Class Template Reference

Aim: Define a new Functor from the composition of two other functors. More...

#include <DGtal/base/BasicFunctors.h>

Public Types
typedef ReturnType	Value
	Necessary for DistanceVisitor. More...

Public Member Functions
	Composer ()
	Composer (const TFunctor1 &aF1, const TFunctor2 &aF2)
	Composer (const Composer &other)
Composer &	operator= (const Composer &other)
template<typename TInput >
ReturnType	operator() (const TInput &aInput) const

Private Attributes
const TFunctor1 *	myF1
const TFunctor2 *	myF2

Detailed Description

template<typename TFunctor1, typename TFunctor2, typename ReturnType>
class DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >

Aim: Define a new Functor from the composition of two other functors.

Description of template class 'Composer'

Template Parameters

TFunctor1	first functor
TFunctor2	second functor
ReturnType	return type

Examples

graph/volDistanceTraversal.cpp.

Definition at line 417 of file BasicFunctors.h.

Member Typedef Documentation

Value

template<typename TFunctor1 , typename TFunctor2 , typename ReturnType >

typedef ReturnType DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::Value

Necessary for DistanceVisitor.

Definition at line 421 of file BasicFunctors.h.

Constructor & Destructor Documentation

Composer() [1/3]

template<typename TFunctor1 , typename TFunctor2 , typename ReturnType >

DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::Composer ( )

inline

Default constructor

Definition at line 426 of file BasicFunctors.h.

: myF1(NULL), myF2(NULL) {}

Composer() [2/3]

template<typename TFunctor1 , typename TFunctor2 , typename ReturnType >

DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::Composer ( const TFunctor1 &  aF1, const TFunctor2 &  aF2  )

inline

Constructor

Parameters

aF1	any Functor
aF2	any Functor

Definition at line 432 of file BasicFunctors.h.

: myF1(&aF1), myF2(&aF2) {}

Composer() [3/3]

template<typename TFunctor1 , typename TFunctor2 , typename ReturnType >

DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::Composer ( const Composer< TFunctor1, TFunctor2, ReturnType > &  other )

inline

Copy Operator

Parameters

other

object to copy

Definition at line 437 of file BasicFunctors.h.

: myF1(other.myF1), myF2(other.myF2) {}

Member Function Documentation

operator()()

template<typename TFunctor1 , typename TFunctor2 , typename ReturnType >

template<typename TInput >

ReturnType DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::operator() ( const TInput &  aInput ) const

inline

Operator ()

NB: myF2 return type should be equal to (or implicitly castable into) ReturnType

Returns

object of type ReturnType coming from the composition myF1 o myF2 on aInput, ie. myF2 ( myF1 ( aInput ) )

Template Parameters

TInput

type of the input value

Definition at line 468 of file BasicFunctors.h.

    {
      ASSERT( myF1 );
      ASSERT( myF2 );
      return myF2->operator()( myF1->operator()( aInput ) );
    }

References DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::myF1, and DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::myF2.

operator=()

template<typename TFunctor1 , typename TFunctor2 , typename ReturnType >

Composer& DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::operator= ( const Composer< TFunctor1, TFunctor2, ReturnType > &  other )

inline

Assignement Operator

Parameters

other

object to copy

Definition at line 443 of file BasicFunctors.h.

    {
      if (this != &other)
        {
          myF1 = other.myF1;
          myF2 = other.myF2;
        }
    return *this;
    }

References DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::myF1, and DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::myF2.

Field Documentation

myF1

template<typename TFunctor1 , typename TFunctor2 , typename ReturnType >

const TFunctor1* DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::myF1

private

Aliasing pointer to the first functor.

Definition at line 479 of file BasicFunctors.h.

Referenced by DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::operator()(), and DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::operator=().

myF2

template<typename TFunctor1 , typename TFunctor2 , typename ReturnType >

const TFunctor2* DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::myF2

private

Aliasing pointer to the second functor.

Definition at line 483 of file BasicFunctors.h.

Referenced by DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::operator()(), and DGtal::functors::Composer< TFunctor1, TFunctor2, ReturnType >::operator=().

---

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

• BasicFunctors.h