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

Expression-template node combining two matrix expressions E1 and E2 via a binary functor F that is invoked with both expressions plus the (i, j) cell indices. More...

#include <MatrixExpression.hpp>

+ Inheritance diagram for CDPL::Math::MatrixBinary2< E1, E2, 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 an element 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...
 
typedef CommonType< typename E1::SizeType, typename E2::SizeType >::Type SizeType
 The common size type of the two wrapped expressions. More...
 
typedef CommonType< typename E1::DifferenceType, typename E2::DifferenceType >::Type DifferenceType
 The common signed difference type of the two wrapped expressions. More...
 
- Public Types inherited from CDPL::Math::MatrixExpression< MatrixBinary2< E1, E2, F > >
typedef MatrixBinary2< E1, E2, F > ExpressionType
 The derived matrix 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

 MatrixBinary2 (const Expression1Type &e1, const Expression2Type &e2)
 Constructs the expression-template node wrapping e1 and e2. More...
 
SizeType getSize1 () const
 Returns the first wrapped expression's first-dimension size (number of rows of the result). More...
 
SizeType getSize2 () const
 Returns the second wrapped expression's second-dimension size (number of columns of the result). More...
 
ConstReference operator() (SizeType i, SizeType j) const
 Invokes the functor with both wrapped expressions and the indices (i, j) and returns the result. More...
 
- Public Member Functions inherited from CDPL::Math::MatrixExpression< MatrixBinary2< E1, E2, F > >
const ExpressionType & operator() () const
 Returns a const reference to the derived matrix expression. More...
 
ExpressionType & operator() ()
 Returns a reference to the derived matrix expression. More...
 

Additional Inherited Members

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

Detailed Description

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

Expression-template node combining two matrix expressions E1 and E2 via a binary functor F that is invoked with both expressions plus the (i, j) cell indices.

Unlike Math::MatrixBinary1 (which is element-wise), the functor here receives both expressions verbatim along with the cell coordinates — used for matrix products and similar non-element-wise combinations.

Template Parameters
E1The first wrapped matrix expression type.
E2The second wrapped matrix expression type.
FThe binary functor type.

Member Typedef Documentation

◆ ValueType

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

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

◆ ConstReference

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

Constant reference type to an element value.

◆ Reference

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

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

◆ ConstClosureType

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

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

◆ ClosureType

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

Closure type used when this expression appears inside another expression.

◆ SizeType

template<typename E1 , typename E2 , typename F >
typedef CommonType<typename E1::SizeType, typename E2::SizeType>::Type CDPL::Math::MatrixBinary2< E1, E2, F >::SizeType

The common size type of the two wrapped expressions.

◆ DifferenceType

template<typename E1 , typename E2 , typename F >
typedef CommonType<typename E1::DifferenceType, typename E2::DifferenceType>::Type CDPL::Math::MatrixBinary2< E1, E2, F >::DifferenceType

The common signed difference type of the two wrapped expressions.

Constructor & Destructor Documentation

◆ MatrixBinary2()

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

Constructs the expression-template node wrapping e1 and e2.

Parameters
e1The first matrix expression.
e2The second matrix expression.

Member Function Documentation

◆ getSize1()

template<typename E1 , typename E2 , typename F >
SizeType CDPL::Math::MatrixBinary2< E1, E2, F >::getSize1 ( ) const
inline

Returns the first wrapped expression's first-dimension size (number of rows of the result).

Returns
The number of rows.

◆ getSize2()

template<typename E1 , typename E2 , typename F >
SizeType CDPL::Math::MatrixBinary2< E1, E2, F >::getSize2 ( ) const
inline

Returns the second wrapped expression's second-dimension size (number of columns of the result).

Returns
The number of columns.

◆ operator()()

template<typename E1 , typename E2 , typename F >
ConstReference CDPL::Math::MatrixBinary2< E1, E2, F >::operator() ( SizeType  i,
SizeType  j 
) const
inline

Invokes the functor with both wrapped expressions and the indices (i, j) and returns the result.

Parameters
iThe zero-based row index.
jThe zero-based column index.
Returns
The computed element value.
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1