Chemical Data Processing Library C++ API - Version 1.4.0
Public Types | Public Member Functions | List of all members
CDPL::Math::Scalar13QuaternionTernary< E1, E2, E3, F > Class Template Reference

Expression-template node combining a scalar E1 (lhs), a quaternion expression E2 (middle), and a scalar E3 (rhs) via the per-component ternary functor F. More...

#include <QuaternionExpression.hpp>

+ Inheritance diagram for CDPL::Math::Scalar13QuaternionTernary< E1, E2, E3, F >:

Public Types

typedef F::ResultType ValueType
 The element value type of the expression (the functor's result type). More...
 
typedef const ValueType ConstReference
 Constant reference type to a component value. More...
 
typedef const ValueType Reference
 Mutable reference type (degrades to const for expression-template results). More...
 
typedef const SelfType ConstClosureType
 Constant closure type used when this expression appears inside another expression. More...
 
typedef SelfType ClosureType
 Closure type used when this expression appears inside another expression. More...
 
- Public Types inherited from CDPL::Math::QuaternionExpression< Scalar13QuaternionTernary< E1, E2, E3, F > >
typedef Scalar13QuaternionTernary< E1, E2, E3, F > ExpressionType
 The derived quaternion expression type. More...
 
- Public Types inherited from CDPL::Math::Expression< E >
typedef E ExpressionType
 The derived expression type (made available to expression-template machinery). More...
 

Public Member Functions

 Scalar13QuaternionTernary (const Expression1Type &e1, const Expression2Type &e2, const Expression3Type &e3)
 Constructs the expression-template node combining the two scalars and the wrapped quaternion expression. More...
 
ConstReference getC1 () const
 Returns the result of applying the functor's applyC1 method to the two scalars and the wrapped expression. More...
 
ConstReference getC2 () const
 Returns the result of applying the functor's applyC2 method to the two scalars and the wrapped expression. More...
 
ConstReference getC3 () const
 Returns the result of applying the functor's applyC3 method to the two scalars and the wrapped expression. More...
 
ConstReference getC4 () const
 Returns the result of applying the functor's applyC4 method to the two scalars and the wrapped expression. More...
 
- Public Member Functions inherited from CDPL::Math::QuaternionExpression< Scalar13QuaternionTernary< E1, E2, E3, F > >
const ExpressionType & operator() () const
 Returns a const reference to the derived quaternion expression. More...
 
ExpressionType & operator() ()
 Returns a reference to the derived quaternion expression. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CDPL::Math::QuaternionExpression< Scalar13QuaternionTernary< E1, E2, E3, F > >
 QuaternionExpression ()
 
 ~QuaternionExpression ()
 
- Protected Member Functions inherited from CDPL::Math::Expression< E >
 Expression ()
 
 ~Expression ()
 

Detailed Description

template<typename E1, typename E2, typename E3, typename F>
class CDPL::Math::Scalar13QuaternionTernary< E1, E2, E3, F >

Expression-template node combining a scalar E1 (lhs), a quaternion expression E2 (middle), and a scalar E3 (rhs) via the per-component ternary functor F.

Template Parameters
E1The scalar type appearing on the left-hand side.
E2The wrapped quaternion expression type.
E3The scalar type appearing on the right-hand side.
FThe per-component ternary functor type.

Member Typedef Documentation

◆ ValueType

template<typename E1 , typename E2 , typename E3 , typename F >
typedef F::ResultType CDPL::Math::Scalar13QuaternionTernary< E1, E2, E3, F >::ValueType

The element value type of the expression (the functor's result type).

◆ ConstReference

template<typename E1 , typename E2 , typename E3 , typename F >
typedef const ValueType CDPL::Math::Scalar13QuaternionTernary< E1, E2, E3, F >::ConstReference

Constant reference type to a component value.

◆ Reference

template<typename E1 , typename E2 , typename E3 , typename F >
typedef const ValueType CDPL::Math::Scalar13QuaternionTernary< E1, E2, E3, F >::Reference

Mutable reference type (degrades to const for expression-template results).

◆ ConstClosureType

template<typename E1 , typename E2 , typename E3 , typename F >
typedef const SelfType CDPL::Math::Scalar13QuaternionTernary< E1, E2, E3, F >::ConstClosureType

Constant closure type used when this expression appears inside another expression.

◆ ClosureType

template<typename E1 , typename E2 , typename E3 , typename F >
typedef SelfType CDPL::Math::Scalar13QuaternionTernary< E1, E2, E3, F >::ClosureType

Closure type used when this expression appears inside another expression.

Constructor & Destructor Documentation

◆ Scalar13QuaternionTernary()

template<typename E1 , typename E2 , typename E3 , typename F >
CDPL::Math::Scalar13QuaternionTernary< E1, E2, E3, F >::Scalar13QuaternionTernary ( const Expression1Type &  e1,
const Expression2Type &  e2,
const Expression3Type &  e3 
)
inline

Constructs the expression-template node combining the two scalars and the wrapped quaternion expression.

Parameters
e1The scalar value on the left-hand side.
e2The wrapped quaternion expression.
e3The scalar value on the right-hand side.

Member Function Documentation

◆ getC1()

template<typename E1 , typename E2 , typename E3 , typename F >
ConstReference CDPL::Math::Scalar13QuaternionTernary< E1, E2, E3, F >::getC1 ( ) const
inline

Returns the result of applying the functor's applyC1 method to the two scalars and the wrapped expression.

Returns
The computed C1 component.

◆ getC2()

template<typename E1 , typename E2 , typename E3 , typename F >
ConstReference CDPL::Math::Scalar13QuaternionTernary< E1, E2, E3, F >::getC2 ( ) const
inline

Returns the result of applying the functor's applyC2 method to the two scalars and the wrapped expression.

Returns
The computed C2 component.

◆ getC3()

template<typename E1 , typename E2 , typename E3 , typename F >
ConstReference CDPL::Math::Scalar13QuaternionTernary< E1, E2, E3, F >::getC3 ( ) const
inline

Returns the result of applying the functor's applyC3 method to the two scalars and the wrapped expression.

Returns
The computed C3 component.

◆ getC4()

template<typename E1 , typename E2 , typename E3 , typename F >
ConstReference CDPL::Math::Scalar13QuaternionTernary< E1, E2, E3, F >::getC4 ( ) const
inline

Returns the result of applying the functor's applyC4 method to the two scalars and the wrapped expression.

Returns
The computed C4 component.
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1