Chemical Data Processing Library C++ API - Version 1.4.0
Public Types | Static Public Member Functions | List of all members
CDPL::Math::ScalarConjugation< T > Struct Template Reference

Scalar complex-conjugation functor: apply(v) returns \( \overline{v} \) (identity for real types). More...

#include <Functional.hpp>

+ Inheritance diagram for CDPL::Math::ScalarConjugation< T >:

Public Types

typedef ScalarUnaryFunctor< T >::ValueType ValueType
 
typedef ScalarUnaryFunctor< T >::ArgumentType ArgumentType
 
typedef ScalarUnaryFunctor< T >::ResultType ResultType
 
- Public Types inherited from CDPL::Math::ScalarUnaryFunctor< T >
typedef T ValueType
 The scalar value type. More...
 
typedef const T & ArgumentType
 The argument type (a const reference to ValueType). More...
 
typedef ValueType ResultType
 The result type of apply(). More...
 

Static Public Member Functions

static ResultType apply (ArgumentType v)
 Returns the complex conjugate of v. More...
 

Detailed Description

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

Scalar complex-conjugation functor: apply(v) returns \( \overline{v} \) (identity for real types).

Template Parameters
TThe scalar value type.

Member Typedef Documentation

◆ ValueType

template<typename T >
typedef ScalarUnaryFunctor<T>::ValueType CDPL::Math::ScalarConjugation< T >::ValueType

◆ ArgumentType

◆ ResultType

template<typename T >
typedef ScalarUnaryFunctor<T>::ResultType CDPL::Math::ScalarConjugation< T >::ResultType

Member Function Documentation

◆ apply()

template<typename T >
static ResultType CDPL::Math::ScalarConjugation< T >::apply ( ArgumentType  v)
inlinestatic

Returns the complex conjugate of v.

Parameters
vThe scalar argument.
Returns
The complex conjugate \( \overline{v} \).

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