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

Per-component functor returning the unreal (pure-quaternion) part of a quaternion expression (zeros C1, keeps C2/C3/C4). More...

#include <Functional.hpp>

+ Inheritance diagram for CDPL::Math::QuaternionUnreal< Q >:

Public Types

typedef QuaternionUnaryFunctor< Q >::ResultType ResultType
 
- Public Types inherited from CDPL::Math::QuaternionUnaryFunctor< Q >
typedef Q::ValueType ResultType
 The component result type (the quaternion's element value type). More...
 

Static Public Member Functions

template<typename E >
static ResultType applyC1 (const QuaternionExpression< E > &e)
 Returns the C1 component of the unreal part (always zero). More...
 
template<typename E >
static ResultType applyC2 (const QuaternionExpression< E > &e)
 Returns the C2 component of the unreal part (equals e.getC2()). More...
 
template<typename E >
static ResultType applyC3 (const QuaternionExpression< E > &e)
 Returns the C3 component of the unreal part (equals e.getC3()). More...
 
template<typename E >
static ResultType applyC4 (const QuaternionExpression< E > &e)
 Returns the C4 component of the unreal part (equals e.getC4()). More...
 

Detailed Description

template<typename Q>
struct CDPL::Math::QuaternionUnreal< Q >

Per-component functor returning the unreal (pure-quaternion) part of a quaternion expression (zeros C1, keeps C2/C3/C4).

Template Parameters
QThe quaternion expression type.

Member Typedef Documentation

◆ ResultType

Member Function Documentation

◆ applyC1()

template<typename Q >
template<typename E >
static ResultType CDPL::Math::QuaternionUnreal< Q >::applyC1 ( const QuaternionExpression< E > &  e)
inlinestatic

Returns the C1 component of the unreal part (always zero).

Template Parameters
EThe quaternion expression type.
Parameters
eThe quaternion expression.
Returns
Zero.

◆ applyC2()

template<typename Q >
template<typename E >
static ResultType CDPL::Math::QuaternionUnreal< Q >::applyC2 ( const QuaternionExpression< E > &  e)
inlinestatic

Returns the C2 component of the unreal part (equals e.getC2()).

Template Parameters
EThe quaternion expression type.
Parameters
eThe quaternion expression.
Returns
e.getC2().

◆ applyC3()

template<typename Q >
template<typename E >
static ResultType CDPL::Math::QuaternionUnreal< Q >::applyC3 ( const QuaternionExpression< E > &  e)
inlinestatic

Returns the C3 component of the unreal part (equals e.getC3()).

Template Parameters
EThe quaternion expression type.
Parameters
eThe quaternion expression.
Returns
e.getC3().

◆ applyC4()

template<typename Q >
template<typename E >
static ResultType CDPL::Math::QuaternionUnreal< Q >::applyC4 ( const QuaternionExpression< E > &  e)
inlinestatic

Returns the C4 component of the unreal part (equals e.getC4()).

Template Parameters
EThe quaternion expression type.
Parameters
eThe quaternion expression.
Returns
e.getC4().

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