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

Expression template node combining a scalar E1 (lhs) and a grid expression E2 (rhs) element-wise via the binary functor F. More...

#include <GridExpression.hpp>

+ Inheritance diagram for CDPL::Math::Scalar1GridBinary< 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 element reference type. More...
 
typedef const ValueType Reference
 Mutable element 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 E2::SizeType SizeType
 The size type inherited from the wrapped grid expression. More...
 
typedef E2::DifferenceType DifferenceType
 The signed difference type inherited from the wrapped grid expression. More...
 
- Public Types inherited from CDPL::Math::GridExpression< Scalar1GridBinary< E1, E2, F > >
typedef Scalar1GridBinary< E1, E2, F > ExpressionType
 The derived grid expression type. More...
 
- Public Types inherited from CDPL::Math::Expression< E >
typedef E ExpressionType
 The derived expression type. More...
 

Public Member Functions

 Scalar1GridBinary (const Expression1Type &e1, const Expression2Type &e2)
 Constructs the expression template node combining the scalar e1 and the grid expression e2. More...
 
SizeType getSize1 () const
 Returns the size of the wrapped grid expression along the first dimension. More...
 
SizeType getSize2 () const
 Returns the size of the wrapped grid expression along the second dimension. More...
 
SizeType getSize3 () const
 Returns the size of the wrapped grid expression along the third dimension. More...
 
ConstReference operator() (SizeType i, SizeType j, SizeType k) const
 Applies the binary functor to the scalar and the element at (i, j, k) of the wrapped grid expression and returns the result. More...
 
- Public Member Functions inherited from CDPL::Math::GridExpression< Scalar1GridBinary< E1, E2, F > >
const ExpressionType & operator() () const
 Returns a const reference to the derived grid expression class instance. More...
 
ExpressionType & operator() ()
 Returns a reference to the derived grid expression class instance. More...
 

Additional Inherited Members

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

Detailed Description

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

Expression template node combining a scalar E1 (lhs) and a grid expression E2 (rhs) element-wise via the binary functor F.

Template Parameters
E1The scalar type appearing on the left-hand side.
E2The wrapped grid expression type.
FThe binary functor type.

Member Typedef Documentation

◆ ValueType

template<typename E1 , typename E2 , typename F >
typedef F::ResultType CDPL::Math::Scalar1GridBinary< 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::Scalar1GridBinary< E1, E2, F >::ConstReference

Constant element reference type.

◆ Reference

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

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

◆ ConstClosureType

template<typename E1 , typename E2 , typename F >
typedef const SelfType CDPL::Math::Scalar1GridBinary< 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::Scalar1GridBinary< E1, E2, F >::ClosureType

Closure type used when this expression appears inside another expression.

◆ SizeType

template<typename E1 , typename E2 , typename F >
typedef E2::SizeType CDPL::Math::Scalar1GridBinary< E1, E2, F >::SizeType

The size type inherited from the wrapped grid expression.

◆ DifferenceType

template<typename E1 , typename E2 , typename F >
typedef E2::DifferenceType CDPL::Math::Scalar1GridBinary< E1, E2, F >::DifferenceType

The signed difference type inherited from the wrapped grid expression.

Constructor & Destructor Documentation

◆ Scalar1GridBinary()

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

Constructs the expression template node combining the scalar e1 and the grid expression e2.

Parameters
e1The scalar value on the left-hand side.
e2The grid expression on the right-hand side.

Member Function Documentation

◆ getSize1()

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

Returns the size of the wrapped grid expression along the first dimension.

Returns
The wrapped expression's size in the first dimension.

◆ getSize2()

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

Returns the size of the wrapped grid expression along the second dimension.

Returns
The wrapped expression's size in the second dimension.

◆ getSize3()

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

Returns the size of the wrapped grid expression along the third dimension.

Returns
The wrapped expression's size in the third dimension.

◆ operator()()

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

Applies the binary functor to the scalar and the element at (i, j, k) of the wrapped grid expression and returns the result.

Parameters
iThe zero-based first dimension index.
jThe zero-based second dimension index.
kThe zero-based third dimension index.
Returns
The element value as combined by the functor.
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1