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

Expression object for sparse vector-dense vector subtractions.The SVecDVecSubExpr class represents the compile time expression for subtractions between a sparse vector and a dense vector. More...

#include <SVecDVecSubExpr.h>

Inherits blaze::DenseVector< SVecDVecSubExpr< VT1, VT2, TF >, TF >, blaze::VecVecSubExpr, and blaze::Computation.

Public Types

enum  { vectorizable = 0 }
 Compilation switch for the expression template evaluation strategy.
 
enum  { smpAssignable = 0 }
 Compilation switch for the expression template assignment strategy.
 
typedef SVecDVecSubExpr< VT1, VT2, TF > This
 Type of this SVecDVecSubExpr instance.
 
typedef SubTrait< RT1, RT2 >::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 const SelectType< returnExpr, ExprReturnType, ElementType >::Type ReturnType
 Return type for expression template evaluations.
 
typedef const ResultType 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 sparse 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

 SVecDVecSubExpr (const VT1 &lhs, const VT2 &rhs)
 Constructor for the SVecDVecSubExpr 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...
 
size_t size () const
 Returns the current size/dimension of the vector. More...
 
LeftOperand leftOperand () const
 Returns the left-hand side sparse 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...
 
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...
 
typedef VT1::ResultType RT1
 Result type of the left-hand side sparse vector expression.
 
typedef VT2::ResultType RT2
 Result type of the right-hand side dense vector expression.
 
typedef VT1::ReturnType RN1
 Return type of the left-hand side sparse 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 sparse vector expression.
 
typedef VT2::CompositeType CT2
 Composite type of the right-hand side dense vector expression.
 
typedef VT1::TransposeType TT1
 Transpose type of the left-hand side sparse vector expression.
 
typedef VT2::TransposeType TT2
 Transpose type of the right-hand side dense vector expression.
 
typedef SubExprTrait< RN1, RN2 >::Type ExprReturnType
 Expression return type for the subscript operator.
 

Private Attributes

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

Detailed Description

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

Expression object for sparse vector-dense vector subtractions.

The SVecDVecSubExpr class represents the compile time expression for subtractions between a sparse vector and a dense vector.

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 false and the subscript operator will return it's result by value. Otherwise returnExpr will be set to true and the subscript operator may return it's result as an expression.

Constructor & Destructor Documentation

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

Constructor for the SVecDVecSubExpr class.

Parameters
lhsThe left-hand side sparse vector operand of the subtraction expression.
rhsThe right-hand side dense vector operand of the subtraction expression.

Member Function Documentation

template<typename VT1 , typename VT2 , bool TF>
ReturnType blaze::SVecDVecSubExpr< 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>
template<typename T >
bool blaze::SVecDVecSubExpr< 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>
template<typename T >
bool blaze::SVecDVecSubExpr< 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>
LeftOperand blaze::SVecDVecSubExpr< VT1, VT2, TF >::leftOperand ( ) const
inline

Returns the left-hand side sparse vector operand.

Returns
The left-hand side sparse vector operand.
template<typename VT1 , typename VT2 , bool TF>
ReturnType blaze::SVecDVecSubExpr< 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::SVecDVecSubExpr< 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::SVecDVecSubExpr< 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 files: