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

Functor checking element-wise equality of two matrix expressions. More...

#include <Functional.hpp>

+ Inheritance diagram for CDPL::Math::MatrixEquality< M1, M2 >:

Public Types

typedef MatrixBooleanBinaryFunctor< M1, M2 >::SizeType SizeType
 
typedef MatrixBooleanBinaryFunctor< M1, M2 >::ValueType ValueType
 
typedef MatrixBooleanBinaryFunctor< M1, M2 >::ResultType ResultType
 
- Public Types inherited from CDPL::Math::MatrixBooleanBinaryFunctor< M1, M2 >
typedef bool ResultType
 The boolean result 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)
 Tells whether e1 and e2 have the same dimensions and equal element values. More...
 

Detailed Description

template<typename M1, typename M2>
struct CDPL::Math::MatrixEquality< M1, M2 >

Functor checking element-wise equality of two matrix expressions.

Template Parameters
M1The first matrix expression type.
M2The second matrix expression type.

Member Typedef Documentation

◆ SizeType

template<typename M1 , typename M2 >
typedef MatrixBooleanBinaryFunctor<M1, M2>::SizeType CDPL::Math::MatrixEquality< M1, M2 >::SizeType

◆ ValueType

template<typename M1 , typename M2 >
typedef MatrixBooleanBinaryFunctor<M1, M2>::ValueType CDPL::Math::MatrixEquality< M1, M2 >::ValueType

◆ ResultType

template<typename M1 , typename M2 >
typedef MatrixBooleanBinaryFunctor<M1, M2>::ResultType CDPL::Math::MatrixEquality< M1, M2 >::ResultType

Member Function Documentation

◆ apply()

template<typename M1 , typename M2 >
static ResultType CDPL::Math::MatrixEquality< M1, M2 >::apply ( const MatrixExpression< M1 > &  e1,
const MatrixExpression< M2 > &  e2 
)
inlinestatic

Tells whether e1 and e2 have the same dimensions and equal element values.

Parameters
e1The first matrix expression.
e2The second matrix expression.
Returns
true if the matrices agree in dimensions and element-wise values, and false otherwise.

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