CDPL::Math::MatrixToleranceEquality< M1, M2, T > Struct Template Reference

Functor checking element-wise approximate equality of two matrix expressions within an absolute tolerance. More...

#include <Functional.hpp>

Inheritance diagram for CDPL::Math::MatrixToleranceEquality< M1, M2, T >:

Public Types
typedef Scalar3MatrixBooleanTernaryFunctor< M1, M2, T >::SizeType	SizeType
typedef Scalar3MatrixBooleanTernaryFunctor< M1, M2, T >::ValueType	ValueType
typedef Scalar3MatrixBooleanTernaryFunctor< M1, M2, T >::ResultType	ResultType
typedef Scalar3MatrixBooleanTernaryFunctor< M1, M2, T >::Argument3Type	Argument3Type
Public Types inherited from CDPL::Math::Scalar3MatrixBooleanTernaryFunctor< M1, M2, T >
typedef bool	ResultType
	The boolean result type. More...
typedef const T &	Argument3Type
	The third (scalar) argument type. More...
typedef CommonType< typename M1::SizeType, typename M2::SizeType >::Type	SizeType
	The unsigned size type (common type of the two matrix size types). More...
typedef CommonType< typename M1::ValueType, typename M2::ValueType >::Type	ValueType
	The element value type (common type of the two matrix element types). More...

Static Public Member Functions
static ResultType	apply (const MatrixExpression< M1 > &e1, const MatrixExpression< M2 > &e2, Argument3Type epsilon)
	Tells whether e1 and e2 agree element-wise within the absolute tolerance epsilon. More...

Detailed Description

template<typename M1, typename M2, typename T>
struct CDPL::Math::MatrixToleranceEquality< M1, M2, T >

Functor checking element-wise approximate equality of two matrix expressions within an absolute tolerance.

Template Parameters

M1	The first matrix expression type.
M2	The second matrix expression type.
T	The tolerance scalar type.

Member Typedef Documentation

SizeType

template<typename M1 , typename M2 , typename T >

typedef Scalar3MatrixBooleanTernaryFunctor<M1, M2, T>::SizeType CDPL::Math::MatrixToleranceEquality< M1, M2, T >::SizeType

ValueType

template<typename M1 , typename M2 , typename T >

typedef Scalar3MatrixBooleanTernaryFunctor<M1, M2, T>::ValueType CDPL::Math::MatrixToleranceEquality< M1, M2, T >::ValueType

ResultType

template<typename M1 , typename M2 , typename T >

typedef Scalar3MatrixBooleanTernaryFunctor<M1, M2, T>::ResultType CDPL::Math::MatrixToleranceEquality< M1, M2, T >::ResultType

Argument3Type

template<typename M1 , typename M2 , typename T >

typedef Scalar3MatrixBooleanTernaryFunctor<M1, M2, T>::Argument3Type CDPL::Math::MatrixToleranceEquality< M1, M2, T >::Argument3Type

Member Function Documentation

apply()

template<typename M1 , typename M2 , typename T >

static ResultType CDPL::Math::MatrixToleranceEquality< M1, M2, T >::apply ( const MatrixExpression< M1 > &  e1, const MatrixExpression< M2 > &  e2, Argument3Type  epsilon  )

inlinestatic

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

Parameters

e1	The first matrix expression.
e2	The second matrix expression.
epsilon	The non-negative absolute tolerance.

Returns

true if the matrices have equal dimensions and all elements agree within epsilon, and false otherwise.

---

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

• Functional.hpp