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

Functor checking component-wise approximate equality of two quaternion expressions within an absolute tolerance. More...

#include <Functional.hpp>

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

Public Types

typedef Scalar3QuaternionBooleanTernaryFunctor< Q1, Q2, T >::ValueType ValueType
 
typedef Scalar3QuaternionBooleanTernaryFunctor< Q1, Q2, T >::ResultType ResultType
 
typedef Scalar3QuaternionBooleanTernaryFunctor< Q1, Q2, T >::Argument3Type Argument3Type
 
- Public Types inherited from CDPL::Math::Scalar3QuaternionBooleanTernaryFunctor< Q1, Q2, T >
typedef bool ResultType
 The boolean result type. More...
 
typedef const T & Argument3Type
 The third (scalar) argument type. More...
 
typedef CommonType< typename Q1::ValueType, typename Q2::ValueType >::Type ValueType
 The component value type (common type of the two quaternion element types). More...
 

Static Public Member Functions

static ResultType apply (const QuaternionExpression< Q1 > &e1, const QuaternionExpression< Q2 > &e2, Argument3Type epsilon)
 Tells whether e1 and e2 agree component-wise within the absolute tolerance epsilon. More...
 

Detailed Description

template<typename Q1, typename Q2, typename T>
struct CDPL::Math::QuaternionToleranceEquality< Q1, Q2, T >

Functor checking component-wise approximate equality of two quaternion expressions within an absolute tolerance.

Template Parameters
Q1The first quaternion expression type.
Q2The second quaternion expression type.
TThe tolerance scalar type.

Member Typedef Documentation

◆ ValueType

template<typename Q1 , typename Q2 , typename T >
typedef Scalar3QuaternionBooleanTernaryFunctor<Q1, Q2, T>::ValueType CDPL::Math::QuaternionToleranceEquality< Q1, Q2, T >::ValueType

◆ ResultType

template<typename Q1 , typename Q2 , typename T >
typedef Scalar3QuaternionBooleanTernaryFunctor<Q1, Q2, T>::ResultType CDPL::Math::QuaternionToleranceEquality< Q1, Q2, T >::ResultType

◆ Argument3Type

template<typename Q1 , typename Q2 , typename T >
typedef Scalar3QuaternionBooleanTernaryFunctor<Q1, Q2, T>::Argument3Type CDPL::Math::QuaternionToleranceEquality< Q1, Q2, T >::Argument3Type

Member Function Documentation

◆ apply()

template<typename Q1 , typename Q2 , typename T >
static ResultType CDPL::Math::QuaternionToleranceEquality< Q1, Q2, T >::apply ( const QuaternionExpression< Q1 > &  e1,
const QuaternionExpression< Q2 > &  e2,
Argument3Type  epsilon 
)
inlinestatic

Tells whether e1 and e2 agree component-wise within the absolute tolerance epsilon.

Parameters
e1The first quaternion expression.
e2The second quaternion expression.
epsilonThe non-negative absolute tolerance.
Returns
true if all four components agree within epsilon, and false otherwise.

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