CDPL::Math::ScalarImaginary< T > Struct Template Reference

Scalar imaginary-part functor: apply(v) returns \( \mathrm{Im}(v) \) (zero for real types). More...

#include <Functional.hpp>

Inheritance diagram for CDPL::Math::ScalarImaginary< T >:

Public Types
typedef ScalarUnaryFunctor< T >::ValueType	ValueType
typedef ScalarUnaryFunctor< T >::ArgumentType	ArgumentType
typedef ScalarUnaryFunctor< T >::ResultType	ResultType
Public Types inherited from CDPL::Math::ScalarRealUnaryFunctor< T >
typedef T	ValueType
	The scalar value type. More...
typedef const T &	ArgumentType
	The argument type (a const reference to ValueType). More...
typedef TypeTraits< T >::RealType	ResultType
	The real-valued result type derived from ValueType via Math::TypeTraits. More...

Static Public Member Functions
static ResultType	apply (ArgumentType v)
	Returns the imaginary part of v. More...

Detailed Description

template<typename T>
struct CDPL::Math::ScalarImaginary< T >

Scalar imaginary-part functor: apply(v) returns \( \mathrm{Im}(v) \) (zero for real types).

Template Parameters

T	The scalar value type.

Member Typedef Documentation

ValueType

template<typename T >

typedef ScalarUnaryFunctor<T>::ValueType CDPL::Math::ScalarImaginary< T >::ValueType

ArgumentType

template<typename T >

typedef ScalarUnaryFunctor<T>::ArgumentType CDPL::Math::ScalarImaginary< T >::ArgumentType

ResultType

template<typename T >

typedef ScalarUnaryFunctor<T>::ResultType CDPL::Math::ScalarImaginary< T >::ResultType

Member Function Documentation

apply()

template<typename T >

static ResultType CDPL::Math::ScalarImaginary< T >::apply ( ArgumentType  v )

inlinestatic

Returns the imaginary part of v.

Parameters

v	The scalar argument.

Returns

\( \mathrm{Im}(v) \).

---

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

• Functional.hpp