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

Expression-template node combining two vector expressions E1 and E2 via a binary functor F invoked with both expressions plus the element index i. More...

#include <VectorExpression.hpp>

Inheritance diagram for CDPL::Math::VectorBinary2< 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::VectorExpression< VectorBinary2< E1, E2, F > >
typedef VectorBinary2< 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
	VectorBinary2 (const Expression1Type &e1, const Expression2Type &e2)
	Constructs the expression-template node wrapping e1 and e2. More...
SizeType	getSize () const
	Returns the element count after verifying that both wrapped expressions agree on it. More...
ConstReference	operator() (SizeType i) const
	Invokes the functor with both wrapped expressions and the index i and returns the result. More...
ConstReference	operator[] (SizeType i) const
	Alias for operator() — invokes the functor with both wrapped expressions and the index i. More...
Public Member Functions inherited from CDPL::Math::VectorExpression< VectorBinary2< 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< VectorBinary2< 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::VectorBinary2< E1, E2, F >

Expression-template node combining two vector expressions E1 and E2 via a binary functor F invoked with both expressions plus the element index i.

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

Template Parameters

E1	The first wrapped vector expression type.
E2	The second wrapped vector expression type.
F	The binary functor type.

Member Typedef Documentation

ValueType

template<typename E1 , typename E2 , typename F >

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

Constant reference type to an element value.

Reference

template<typename E1 , typename E2 , typename F >

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

The common signed difference type of the two wrapped expressions.

Constructor & Destructor Documentation

VectorBinary2()

template<typename E1 , typename E2 , typename F >

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

inline

Constructs the expression-template node wrapping e1 and e2.

Parameters

e1	The first vector expression.
e2	The second vector expression.

Member Function Documentation

getSize()

template<typename E1 , typename E2 , typename F >

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

inline

Returns the element count after verifying that both wrapped expressions agree on it.

Returns

The element count.

Exceptions

Base::SizeError

if the two wrapped expressions report different sizes.

operator()()

template<typename E1 , typename E2 , typename F >

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

inline

Invokes the functor with both wrapped expressions and the index i and returns 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::VectorBinary2< E1, E2, F >::operator[] ( SizeType  i ) const

inline

Alias for operator() — invokes the functor with both wrapped expressions 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:

• VectorExpression.hpp