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

Per-component functor returning the Hamilton product \( e_1 \cdot e_2 \) of two quaternion expressions. More...

#include <Functional.hpp>

+ Inheritance diagram for CDPL::Math::QuaternionProduct< Q1, Q2 >:

Public Types

typedef QuaternionBinaryFunctor< Q1, Q2 >::ResultType ResultType
 
- Public Types inherited from CDPL::Math::QuaternionBinaryFunctor< Q1, Q2 >
typedef CommonType< typename Q1::ValueType, typename Q2::ValueType >::Type ResultType
 The component result type (common type of the two quaternion element types). More...
 

Static Public Member Functions

template<typename E1 , typename E2 >
static ResultType applyC1 (const QuaternionExpression< E1 > &e1, const QuaternionExpression< E2 > &e2)
 Returns the C1 component of the Hamilton product \( e_1 \cdot e_2 \). More...
 
template<typename E1 , typename E2 >
static ResultType applyC2 (const QuaternionExpression< E1 > &e1, const QuaternionExpression< E2 > &e2)
 Returns the C2 component of the Hamilton product \( e_1 \cdot e_2 \). More...
 
template<typename E1 , typename E2 >
static ResultType applyC3 (const QuaternionExpression< E1 > &e1, const QuaternionExpression< E2 > &e2)
 Returns the C3 component of the Hamilton product \( e_1 \cdot e_2 \). More...
 
template<typename E1 , typename E2 >
static ResultType applyC4 (const QuaternionExpression< E1 > &e1, const QuaternionExpression< E2 > &e2)
 Returns the C4 component of the Hamilton product \( e_1 \cdot e_2 \). More...
 

Detailed Description

template<typename Q1, typename Q2>
struct CDPL::Math::QuaternionProduct< Q1, Q2 >

Per-component functor returning the Hamilton product \( e_1 \cdot e_2 \) of two quaternion expressions.

Template Parameters
Q1The first quaternion expression type.
Q2The second quaternion expression type.

Member Typedef Documentation

◆ ResultType

template<typename Q1 , typename Q2 >
typedef QuaternionBinaryFunctor<Q1, Q2>::ResultType CDPL::Math::QuaternionProduct< Q1, Q2 >::ResultType

Member Function Documentation

◆ applyC1()

template<typename Q1 , typename Q2 >
template<typename E1 , typename E2 >
static ResultType CDPL::Math::QuaternionProduct< Q1, Q2 >::applyC1 ( const QuaternionExpression< E1 > &  e1,
const QuaternionExpression< E2 > &  e2 
)
inlinestatic

Returns the C1 component of the Hamilton product \( e_1 \cdot e_2 \).

Template Parameters
E1The first quaternion expression type.
E2The second quaternion expression type.
Parameters
e1The first quaternion expression.
e2The second quaternion expression.
Returns
The C1 component of the Hamilton product.

◆ applyC2()

template<typename Q1 , typename Q2 >
template<typename E1 , typename E2 >
static ResultType CDPL::Math::QuaternionProduct< Q1, Q2 >::applyC2 ( const QuaternionExpression< E1 > &  e1,
const QuaternionExpression< E2 > &  e2 
)
inlinestatic

Returns the C2 component of the Hamilton product \( e_1 \cdot e_2 \).

Template Parameters
E1The first quaternion expression type.
E2The second quaternion expression type.
Parameters
e1The first quaternion expression.
e2The second quaternion expression.
Returns
The C2 component of the Hamilton product.

◆ applyC3()

template<typename Q1 , typename Q2 >
template<typename E1 , typename E2 >
static ResultType CDPL::Math::QuaternionProduct< Q1, Q2 >::applyC3 ( const QuaternionExpression< E1 > &  e1,
const QuaternionExpression< E2 > &  e2 
)
inlinestatic

Returns the C3 component of the Hamilton product \( e_1 \cdot e_2 \).

Template Parameters
E1The first quaternion expression type.
E2The second quaternion expression type.
Parameters
e1The first quaternion expression.
e2The second quaternion expression.
Returns
The C3 component of the Hamilton product.

◆ applyC4()

template<typename Q1 , typename Q2 >
template<typename E1 , typename E2 >
static ResultType CDPL::Math::QuaternionProduct< Q1, Q2 >::applyC4 ( const QuaternionExpression< E1 > &  e1,
const QuaternionExpression< E2 > &  e2 
)
inlinestatic

Returns the C4 component of the Hamilton product \( e_1 \cdot e_2 \).

Template Parameters
E1The first quaternion expression type.
E2The second quaternion expression type.
Parameters
e1The first quaternion expression.
e2The second quaternion expression.
Returns
The C4 component of the Hamilton product.

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