CDPL::Math::Scalar1MatrixBinary< E1, E2, F > Class Template Reference

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

#include <MatrixExpression.hpp>

Inheritance diagram for CDPL::Math::Scalar1MatrixBinary< 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 E2::SizeType	SizeType
	The size type inherited from the wrapped matrix expression. More...
typedef E2::DifferenceType	DifferenceType
	The signed difference type inherited from the wrapped matrix expression. More...
Public Types inherited from CDPL::Math::MatrixExpression< Scalar1MatrixBinary< E1, E2, F > >
typedef Scalar1MatrixBinary< 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
	Scalar1MatrixBinary (const Expression1Type &e1, const Expression2Type &e2)
	Constructs the expression-template node combining the scalar e1 and the matrix expression e2. More...
SizeType	getSize1 () const
	Returns the wrapped matrix expression's first-dimension size (number of rows). More...
SizeType	getSize2 () const
	Returns the wrapped matrix expression's second-dimension size (number of columns). More...
ConstReference	operator() (SizeType i, SizeType j) const
	Applies the binary functor to the scalar and the element at (i, j) of the wrapped matrix expression and returns the result. More...
Public Member Functions inherited from CDPL::Math::MatrixExpression< Scalar1MatrixBinary< 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< Scalar1MatrixBinary< 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::Scalar1MatrixBinary< E1, E2, F >

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

Template Parameters

E1	The scalar type appearing on the left-hand side.
E2	The wrapped matrix expression type.
F	The binary functor type.

Member Typedef Documentation

ValueType

template<typename E1 , typename E2 , typename F >

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

Constant reference type to an element value.

Reference

template<typename E1 , typename E2 , typename F >

typedef const ValueType CDPL::Math::Scalar1MatrixBinary< 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::Scalar1MatrixBinary< 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::Scalar1MatrixBinary< 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::Scalar1MatrixBinary< E1, E2, F >::SizeType

The size type inherited from the wrapped matrix expression.

DifferenceType

template<typename E1 , typename E2 , typename F >

typedef E2::DifferenceType CDPL::Math::Scalar1MatrixBinary< E1, E2, F >::DifferenceType

The signed difference type inherited from the wrapped matrix expression.

Constructor & Destructor Documentation

Scalar1MatrixBinary()

template<typename E1 , typename E2 , typename F >

CDPL::Math::Scalar1MatrixBinary< E1, E2, F >::Scalar1MatrixBinary ( const Expression1Type &  e1, const Expression2Type &  e2  )

inline

Constructs the expression-template node combining the scalar e1 and the matrix expression e2.

Parameters

e1	The scalar value on the left-hand side.
e2	The matrix expression on the right-hand side.

Member Function Documentation

getSize1()

template<typename E1 , typename E2 , typename F >

SizeType CDPL::Math::Scalar1MatrixBinary< E1, E2, F >::getSize1 ( ) const

inline

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

Returns

The number of rows.

getSize2()

template<typename E1 , typename E2 , typename F >

SizeType CDPL::Math::Scalar1MatrixBinary< E1, E2, F >::getSize2 ( ) const

inline

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

Returns

The number of columns.

operator()()

template<typename E1 , typename E2 , typename F >

ConstReference CDPL::Math::Scalar1MatrixBinary< E1, E2, F >::operator() ( SizeType  i, SizeType  j  ) const

inline

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

Parameters

i	The zero-based row index.
j	The zero-based column index.

Returns

The element value as combined by the functor.

---

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

• MatrixExpression.hpp