dlr::common::BinaryComposeFunctor< Functor0, Functor1, Functor2 > Class Template Reference

Functor template for composing one binary function, functor0(x, y), and two unary functions functor1(x) and functor2(x) so that the result is functor0(functor1(x), functor2(y)). More...

#include <functional.h>

List of all members.

Public Member Functions

 BinaryComposeFunctor (const Functor0 &functor0, const Functor1 &functor1, const Functor2 &functor2)
 The constructor accepts instances of the three functor types to be composed, and makes local copies of them for use in operator()(.
Functor0::result_type operator() (const typename Functor1::argument_type &argument0, const typename Functor2::argument_type &argument1)
 This operator passes its first argument to the operator()(.

Protected Attributes

Functor0 m_functor0
 This protected member stores a copy of functor0.
Functor1 m_functor1
 This protected member stores a copy of functor1.
Functor1 m_functor2
 This protected member stores a copy of functor2.


Detailed Description

template<class Functor0, class Functor1, class Functor2>
class dlr::common::BinaryComposeFunctor< Functor0, Functor1, Functor2 >

Functor template for composing one binary function, functor0(x, y), and two unary functions functor1(x) and functor2(x) so that the result is functor0(functor1(x), functor2(y)).

Definition at line 33 of file functional.h.


Constructor & Destructor Documentation

template<class Functor0, class Functor1, class Functor2>
dlr::common::BinaryComposeFunctor< Functor0, Functor1, Functor2 >::BinaryComposeFunctor ( const Functor0 &  functor0,
const Functor1 &  functor1,
const Functor2 &  functor2 
) [inline]

The constructor accepts instances of the three functor types to be composed, and makes local copies of them for use in operator()(.

..).

Parameters:
functor0 During evaluation of operator()(...), the return value of a copy of functor1 will be passed as the first argument to this functor (or rather, a copy of this functor), the return value of a copy of functor2 will be passed as the second argument, and the return value of the copy of this functor will be passed to the calling context.
functor1 During evaluation of operator()(...), the return value of this functor (or rather, a copy of this functor) will be passed as the first argument to a copy of functor0, and the return value of the functor0 copy will be passed to the calling context.
functor2 During evaluation of operator()(...), the return value of this functor (or rather, a copy of this functor) will be passed as the second argument to a copy of functor0, and the return value of the functor0 copy will be passed to the calling context.

Definition at line 63 of file functional.h.


Member Function Documentation

template<class Functor0, class Functor1, class Functor2>
Functor0::result_type dlr::common::BinaryComposeFunctor< Functor0, Functor1, Functor2 >::operator() ( const typename Functor1::argument_type &  argument0,
const typename Functor2::argument_type &  argument1 
) [inline]

This operator passes its first argument to the operator()(.

..) method of a copy of constructor argument functor1, passes its second argument to the operator()(...) method of a copy of constructor argument functor2, and then passes the result of these calls as the first and second arguments of the operator()(...) method of functor0, and returns the result.

Parameters:
argument0 This argument will be passed as input to the functor1 copy.
argument1 This argument will be passed as input to the functor2 copy.
Returns:
The result of processing the argument with the three composed functors: returnValue = functor0(functor1(argument0), functor2(argument1)).

Definition at line 86 of file functional.h.

References dlr::common::BinaryComposeFunctor< Functor0, Functor1, Functor2 >::m_functor0, dlr::common::BinaryComposeFunctor< Functor0, Functor1, Functor2 >::m_functor1, and dlr::common::BinaryComposeFunctor< Functor0, Functor1, Functor2 >::m_functor2.


Member Data Documentation

template<class Functor0, class Functor1, class Functor2>
Functor0 dlr::common::BinaryComposeFunctor< Functor0, Functor1, Functor2 >::m_functor0 [protected]

This protected member stores a copy of functor0.

Definition at line 94 of file functional.h.

Referenced by dlr::common::BinaryComposeFunctor< Functor0, Functor1, Functor2 >::operator()().

template<class Functor0, class Functor1, class Functor2>
Functor1 dlr::common::BinaryComposeFunctor< Functor0, Functor1, Functor2 >::m_functor1 [protected]

This protected member stores a copy of functor1.

Definition at line 97 of file functional.h.

Referenced by dlr::common::BinaryComposeFunctor< Functor0, Functor1, Functor2 >::operator()().

template<class Functor0, class Functor1, class Functor2>
Functor1 dlr::common::BinaryComposeFunctor< Functor0, Functor1, Functor2 >::m_functor2 [protected]

This protected member stores a copy of functor2.

Definition at line 100 of file functional.h.

Referenced by dlr::common::BinaryComposeFunctor< Functor0, Functor1, Functor2 >::operator()().


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

Generated on Tue Nov 24 23:57:56 2009 for dlrCommon Utility Library by  doxygen 1.5.8