DGtal::concepts::CUnaryFunctor< X, A, R > Struct Template Reference

Aim: Defines a unary functor, which associates arguments to results. More...

#include <DGtal/base/CUnaryFunctor.h>

Inheritance diagram for DGtal::concepts::CUnaryFunctor< X, A, R >:

Public Member Functions
	BOOST_CONCEPT_USAGE (CUnaryFunctor)

Private Attributes
X	x
A	a
R	r

Detailed Description

template<typename X, typename A, typename R>
struct DGtal::concepts::CUnaryFunctor< X, A, R >

Aim: Defines a unary functor, which associates arguments to results.

Description of concept 'CUnaryFunctor'

Refinement of

• boost::Assignable

Associated types

Notation

• X : a type that is a model of CUnaryFunctor
• x : Object of type X
• A : argument type
• a : Object of type A
• R : result type
• r : Object of type R

Definitions

Valid expressions and semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	Complexity
Apply function	r = x(a)		R		returns the value of the function x on argument a

Invariants

Models

Notes

Definition at line 89 of file CUnaryFunctor.h.

Member Function Documentation

BOOST_CONCEPT_USAGE()

template<typename X , typename A , typename R >

DGtal::concepts::CUnaryFunctor< X, A, R >::BOOST_CONCEPT_USAGE ( CUnaryFunctor< X, A, R >  )

inline

Definition at line 95 of file CUnaryFunctor.h.

    {
      // x( a ) returns r.
      ConceptUtils::sameType( r, x.operator() ( a ) );
    }

References DGtal::concepts::ConceptUtils::sameType().

Field Documentation

a

template<typename X , typename A , typename R >

A DGtal::concepts::CUnaryFunctor< X, A, R >::a

private

Definition at line 103 of file CUnaryFunctor.h.

r

template<typename X , typename A , typename R >

R DGtal::concepts::CUnaryFunctor< X, A, R >::r

private

Definition at line 104 of file CUnaryFunctor.h.

x

template<typename X , typename A , typename R >

X DGtal::concepts::CUnaryFunctor< X, A, R >::x

private

Definition at line 102 of file CUnaryFunctor.h.

---

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

• CUnaryFunctor.h