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

Functor checking cell-wise equality of two grid expressions. More...

#include <Functional.hpp>

+ Inheritance diagram for CDPL::Math::GridEquality< G1, G2 >:

Public Types

typedef GridBooleanBinaryFunctor< G1, G2 >::SizeType SizeType
 
typedef GridBooleanBinaryFunctor< G1, G2 >::ValueType ValueType
 
typedef GridBooleanBinaryFunctor< G1, G2 >::ResultType ResultType
 
- Public Types inherited from CDPL::Math::GridBooleanBinaryFunctor< G1, G2 >
typedef bool ResultType
 The boolean result type. More...
 
typedef CommonType< typename G1::SizeType, typename G2::SizeType >::Type SizeType
 The unsigned size type (common type of the two grid size types). More...
 
typedef CommonType< typename G1::ValueType, typename G2::ValueType >::Type ValueType
 The cell value type (common type of the two grid cell types). More...
 

Static Public Member Functions

static ResultType apply (const GridExpression< G1 > &e1, const GridExpression< G2 > &e2)
 Tells whether e1 and e2 have the same dimensions and equal cell values. More...
 

Detailed Description

template<typename G1, typename G2>
struct CDPL::Math::GridEquality< G1, G2 >

Functor checking cell-wise equality of two grid expressions.

Template Parameters
G1The first grid expression type.
G2The second grid expression type.

Member Typedef Documentation

◆ SizeType

template<typename G1 , typename G2 >
typedef GridBooleanBinaryFunctor<G1, G2>::SizeType CDPL::Math::GridEquality< G1, G2 >::SizeType

◆ ValueType

template<typename G1 , typename G2 >
typedef GridBooleanBinaryFunctor<G1, G2>::ValueType CDPL::Math::GridEquality< G1, G2 >::ValueType

◆ ResultType

template<typename G1 , typename G2 >
typedef GridBooleanBinaryFunctor<G1, G2>::ResultType CDPL::Math::GridEquality< G1, G2 >::ResultType

Member Function Documentation

◆ apply()

template<typename G1 , typename G2 >
static ResultType CDPL::Math::GridEquality< G1, G2 >::apply ( const GridExpression< G1 > &  e1,
const GridExpression< G2 > &  e2 
)
inlinestatic

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

Parameters
e1The first grid expression.
e2The second grid expression.
Returns
true if the grids agree in dimensions and cell-wise values, and false otherwise.

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