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

Expression-template node interpreting a binary combination of a matrix expression E1 and a vector expression E2 as a vector (e.g. matrix-vector product), via the per-element functor F invoked with both expressions and the index. More...

#include <MatrixExpression.hpp>

Inheritance diagram for CDPL::Math::Matrix1VectorBinary< 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 wrapped matrix and vector expressions. More...
typedef CommonType< typename E1::DifferenceType, typename E2::DifferenceType >::Type	DifferenceType
	The common signed difference type of the wrapped matrix and vector expressions. More...
Public Types inherited from CDPL::Math::VectorExpression< Matrix1VectorBinary< E1, E2, F > >
typedef Matrix1VectorBinary< E1, E2, F >	ExpressionType
	The derived vector 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
	Matrix1VectorBinary (const Expression1Type &e1, const Expression2Type &e2)
	Constructs the expression-template node wrapping the matrix expression e1 and the vector expression e2. More...
SizeType	getSize () const
	Returns the wrapped matrix expression's first-dimension size (number of rows = size of the result vector). More...
ConstReference	operator() (SizeType i) const
	Invokes the functor with the matrix expression, the vector expression, and the index i to compute element i of the result. More...
ConstReference	operator[] (SizeType i) const
	Alias for operator() — invokes the functor with the matrix expression, the vector expression, and the index i. More...
Public Member Functions inherited from CDPL::Math::VectorExpression< Matrix1VectorBinary< E1, E2, F > >
const ExpressionType &	operator() () const
	Returns a const reference to the derived vector expression. More...
ExpressionType &	operator() ()
	Returns a reference to the derived vector expression. More...

Additional Inherited Members
Protected Member Functions inherited from CDPL::Math::VectorExpression< Matrix1VectorBinary< E1, E2, F > >
	VectorExpression ()
	~VectorExpression ()
Protected Member Functions inherited from CDPL::Math::Expression< E >
	Expression ()
	~Expression ()

Detailed Description

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

Expression-template node interpreting a binary combination of a matrix expression E1 and a vector expression E2 as a vector (e.g. matrix-vector product), via the per-element functor F invoked with both expressions and the index.

The resulting vector has size e1.getSize1() (i.e. the matrix expression's number of rows).

Template Parameters

E1	The matrix expression type.
E2	The vector expression type.
F	The per-element functor type.

Member Typedef Documentation

ValueType

template<typename E1 , typename E2 , typename F >

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

Constant reference type to an element value.

Reference

template<typename E1 , typename E2 , typename F >

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

The common size type of the wrapped matrix and vector expressions.

DifferenceType

template<typename E1 , typename E2 , typename F >

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

The common signed difference type of the wrapped matrix and vector expressions.

Constructor & Destructor Documentation

Matrix1VectorBinary()

template<typename E1 , typename E2 , typename F >

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

inline

Constructs the expression-template node wrapping the matrix expression e1 and the vector expression e2.

Parameters

e1	The matrix expression.
e2	The vector expression.

Member Function Documentation

getSize()

template<typename E1 , typename E2 , typename F >

SizeType CDPL::Math::Matrix1VectorBinary< E1, E2, F >::getSize ( ) const

inline

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

Returns

The result vector size.

operator()()

template<typename E1 , typename E2 , typename F >

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

inline

Invokes the functor with the matrix expression, the vector expression, and the index i to compute element i of the result.

Parameters

i	The zero-based element index.

Returns

The computed element value.

operator[]()

template<typename E1 , typename E2 , typename F >

ConstReference CDPL::Math::Matrix1VectorBinary< E1, E2, F >::operator[] ( SizeType  i ) const

inline

Alias for operator() — invokes the functor with the matrix expression, the vector expression, and the index i.

Parameters

i	The zero-based element index.

Returns

The computed element value.

---

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

• MatrixExpression.hpp