Classes | Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
blaze::DVecDVecAddExpr< VT1, VT2, TF > Class Template Reference

Expression object for dense vector-dense vector additions.The DVecDVecAddExpr class represents the compile time expression for additions between dense vectors. More...

#include <DVecDVecAddExpr.h>

Inherits blaze::DenseVector< DVecDVecAddExpr< VT1, VT2, TF >, TF >, blaze::VecVecAddExpr, and blaze::Computation.

Classes

class  ConstIterator
 Iterator over the elements of the dense vector. More...
 

Public Types

enum  { vectorizable }
 Compilation switch for the expression template evaluation strategy.
 
enum  { smpAssignable = VT1::smpAssignable && VT2::smpAssignable }
 Compilation switch for the expression template assignment strategy.
 
typedef DVecDVecAddExpr< VT1, VT2, TF > This
 Type of this DVecDVecAddExpr instance.
 
typedef AddTrait< RE1, RE2 >::Type ResultType
 Result type for expression template evaluations.
 
typedef ResultType::TransposeType TransposeType
 Transpose type for expression template evaluations.
 
typedef ResultType::ElementType ElementType
 Resulting element type.
 
typedef IntrinsicTrait< ElementType >::Type IntrinsicType
 Resulting intrinsic element type.
 
typedef const SelectType< returnExpr, ExprReturnType, ElementType >::Type ReturnType
 Return type for expression template evaluations.
 
typedef SelectType< useAssign, const ResultType, const DVecDVecAddExpr & >::Type CompositeType
 Data type for composite expression templates.
 
typedef SelectType< IsExpression< VT1 >::value, const VT1, const VT1 & >::Type LeftOperand
 Composite type of the left-hand side dense vector expression.
 
typedef SelectType< IsExpression< VT2 >::value, const VT2, const VT2 & >::Type RightOperand
 Composite type of the right-hand side dense vector expression.
 
typedef VT VectorType
 Type of the vector.
 

Public Member Functions

 DVecDVecAddExpr (const VT1 &lhs, const VT2 &rhs)
 Constructor for the DVecDVecAddExpr class. More...
 
ReturnType operator[] (size_t index) const
 Subscript operator for the direct access to the vector elements. More...
 
ReturnType at (size_t index) const
 Checked access to the vector elements. More...
 
BLAZE_ALWAYS_INLINE IntrinsicType load (size_t index) const
 Access to the intrinsic elements of the vector. More...
 
ConstIterator begin () const
 Returns an iterator to the first non-zero element of the dense vector. More...
 
ConstIterator end () const
 Returns an iterator just past the last non-zero element of the dense vector. More...
 
size_t size () const
 Returns the current size/dimension of the vector. More...
 
LeftOperand leftOperand () const
 Returns the left-hand side dense vector operand. More...
 
RightOperand rightOperand () const
 Returns the right-hand side dense vector operand. More...
 
template<typename T >
bool canAlias (const T *alias) const
 Returns whether the expression can alias with the given address alias. More...
 
template<typename T >
bool isAliased (const T *alias) const
 Returns whether the expression is aliased with the given address alias. More...
 
bool isAligned () const
 Returns whether the operands of the expression are properly aligned in memory. More...
 
bool canSMPAssign () const
 Returns whether the expression can be used in SMP assignments. More...
 
BLAZE_ALWAYS_INLINE VectorTypeoperator~ ()
 Conversion operator for non-constant vectors. More...
 
BLAZE_ALWAYS_INLINE const VectorTypeoperator~ () const
 Conversion operator for constant vectors. More...
 

Private Types

enum  { returnExpr = !IsTemporary<RN1>::value && !IsTemporary<RN2>::value }
 Compilation switch for the selection of the subscript operator return type. More...
 
enum  { useAssign = ( RequiresEvaluation<VT1>::value || RequiresEvaluation<VT2>::value || !returnExpr ) }
 Compilation switch for the serial evaluation strategy of the addition expression. More...
 
typedef VT1::ResultType RE1
 Result type of the left-hand side dense vector expression.
 
typedef VT2::ResultType RE2
 Result type of the right-hand side dense vector expression.
 
typedef VT1::ReturnType RN1
 Return type of the left-hand side dense vector expression.
 
typedef VT2::ReturnType RN2
 Return type of the right-hand side dense vector expression.
 
typedef VT1::CompositeType CT1
 Composite type of the left-hand side dense vector expression.
 
typedef VT2::CompositeType CT2
 Composite type of the right-hand side dense vector expression.
 
typedef VT1::ElementType ET1
 Element type of the left-hand side dense vector expression.
 
typedef VT2::ElementType ET2
 Element type of the right-hand side dense vector expression.
 
typedef AddExprTrait< RN1, RN2 >::Type ExprReturnType
 Expression return type for the subscript operator.
 

Private Attributes

LeftOperand lhs_
 Left-hand side dense vector of the addition expression.
 
RightOperand rhs_
 Right-hand side dense vector of the addition expression.
 

Detailed Description

template<typename VT1, typename VT2, bool TF>
class blaze::DVecDVecAddExpr< VT1, VT2, TF >

Expression object for dense vector-dense vector additions.

The DVecDVecAddExpr class represents the compile time expression for additions between dense vectors.

Member Enumeration Documentation

template<typename VT1, typename VT2, bool TF>
anonymous enum
private

Compilation switch for the selection of the subscript operator return type.

The returnExpr compile time constant expression is a compilation switch for the selection of the ReturnType. If either vector operand returns a temporary vector or matrix, returnExpr will be set to 0 and the subscript operator will return it's result by value. Otherwise returnExpr will be set to 1 and the subscript operator may return it's result as an expression.

template<typename VT1, typename VT2, bool TF>
anonymous enum
private

Compilation switch for the serial evaluation strategy of the addition expression.

The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the addition expression. In case either of the two dense vector operands requires an intermediate evaluation or the subscript operator can only return by value, useAssign will be set to 1 and the addition expression will be evaluated via the assign function family. Otherwise useAssign will be set to 0 and the expression will be evaluated via the subscript operator.

Constructor & Destructor Documentation

template<typename VT1, typename VT2, bool TF>
blaze::DVecDVecAddExpr< VT1, VT2, TF >::DVecDVecAddExpr ( const VT1 &  lhs,
const VT2 &  rhs 
)
inlineexplicit

Constructor for the DVecDVecAddExpr class.

Parameters
lhsThe left-hand side operand of the addition expression.
rhsThe right-hand side operand of the addition expression.

Member Function Documentation

template<typename VT1, typename VT2, bool TF>
ReturnType blaze::DVecDVecAddExpr< VT1, VT2, TF >::at ( size_t  index) const
inline

Checked access to the vector elements.

Parameters
indexAccess index. The index has to be in the range $[0..N-1]$.
Returns
The resulting value.
Exceptions
std::out_of_rangeInvalid vector access index.
template<typename VT1, typename VT2, bool TF>
ConstIterator blaze::DVecDVecAddExpr< VT1, VT2, TF >::begin ( ) const
inline

Returns an iterator to the first non-zero element of the dense vector.

Returns
Iterator to the first non-zero element of the dense vector.
template<typename VT1, typename VT2, bool TF>
template<typename T >
bool blaze::DVecDVecAddExpr< VT1, VT2, TF >::canAlias ( const T *  alias) const
inline

Returns whether the expression can alias with the given address alias.

Parameters
aliasThe alias to be checked.
Returns
true in case the expression can alias, false otherwise.
template<typename VT1, typename VT2, bool TF>
bool blaze::DVecDVecAddExpr< VT1, VT2, TF >::canSMPAssign ( ) const
inline

Returns whether the expression can be used in SMP assignments.

Returns
true in case the expression can be used in SMP assignments, false if not.
template<typename VT1, typename VT2, bool TF>
ConstIterator blaze::DVecDVecAddExpr< VT1, VT2, TF >::end ( ) const
inline

Returns an iterator just past the last non-zero element of the dense vector.

Returns
Iterator just past the last non-zero element of the dense vector.
template<typename VT1, typename VT2, bool TF>
template<typename T >
bool blaze::DVecDVecAddExpr< VT1, VT2, TF >::isAliased ( const T *  alias) const
inline

Returns whether the expression is aliased with the given address alias.

Parameters
aliasThe alias to be checked.
Returns
true in case an alias effect is detected, false otherwise.
template<typename VT1, typename VT2, bool TF>
bool blaze::DVecDVecAddExpr< VT1, VT2, TF >::isAligned ( ) const
inline

Returns whether the operands of the expression are properly aligned in memory.

Returns
true in case the operands are aligned, false if not.
template<typename VT1, typename VT2, bool TF>
LeftOperand blaze::DVecDVecAddExpr< VT1, VT2, TF >::leftOperand ( ) const
inline

Returns the left-hand side dense vector operand.

Returns
The left-hand side dense vector operand.
template<typename VT1, typename VT2, bool TF>
BLAZE_ALWAYS_INLINE IntrinsicType blaze::DVecDVecAddExpr< VT1, VT2, TF >::load ( size_t  index) const
inline

Access to the intrinsic elements of the vector.

Parameters
indexAccess index. The index has to be in the range $[0..N-1]$.
Returns
Reference to the accessed values.
template<typename VT1, typename VT2, bool TF>
ReturnType blaze::DVecDVecAddExpr< VT1, VT2, TF >::operator[] ( size_t  index) const
inline

Subscript operator for the direct access to the vector elements.

Parameters
indexAccess index. The index has to be in the range $[0..N-1]$.
Returns
The resulting value.
template<typename VT, bool TF>
BLAZE_ALWAYS_INLINE VectorType& blaze::Vector< VT, TF >::operator~ ( )
inlineinherited

Conversion operator for non-constant vectors.

Returns
Reference of the actual type of the vector.
template<typename VT, bool TF>
BLAZE_ALWAYS_INLINE const VectorType& blaze::Vector< VT, TF >::operator~ ( ) const
inlineinherited

Conversion operator for constant vectors.

Returns
Const reference of the actual type of the vector.
template<typename VT1, typename VT2, bool TF>
RightOperand blaze::DVecDVecAddExpr< VT1, VT2, TF >::rightOperand ( ) const
inline

Returns the right-hand side dense vector operand.

Returns
The right-hand side dense vector operand.
template<typename VT1, typename VT2, bool TF>
size_t blaze::DVecDVecAddExpr< VT1, VT2, TF >::size ( ) const
inline

Returns the current size/dimension of the vector.

Returns
The size of the vector.

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