All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
blaze::DVecTSVecMultExpr< VT1, VT2 > Class Template Reference

Expression object for dense vector-sparse vector outer products.The DVecTSVecMultExpr class represents the compile time expression for dense vector-sparse vector outer products. More...

#include <DVecTSVecMultExpr.h>

Inherits blaze::SparseMatrix< DVecTSVecMultExpr< VT1, VT2 >, false >, blaze::Expression, and blaze::Computation.

Classes

class  ConstIterator
 Iterator over the elements of the dense vector-sparse vector outer product expression. More...
 

Public Types

enum  { canAlias = !IsComputation<VT1>::value || !IsComputation<VT2>::value }
 Compilation flag for the detection of aliasing effects.
 
typedef DVecTSVecMultExpr< VT1,
VT2 > 
This
 Type of this DVecTSVecMultExpr instance.
 
typedef MultTrait< RT1, RT2 >::Type ResultType
 Result type for expression template evaluations.
 
typedef ResultType::OppositeType OppositeType
 Result type with opposite storage order 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 SelectType< useAssign,
const ResultType, const
DVecTSVecMultExpr & >::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 sparse vector expression.
 
typedef SelectType
< IsComputation< VT1 >::value,
const RT1, CT1 >::Type 
LT
 Type for the assignment of the left-hand side dense vector operand.
 
typedef SelectType
< IsComputation< VT2 >::value,
const RT2, CT2 >::Type 
RT
 Type for the assignment of the right-hand side dense vector operand.
 
typedef MT MatrixType
 Type of the matrix.
 

Public Member Functions

 DVecTSVecMultExpr (const VT1 &lhs, const VT2 &rhs)
 Constructor for the DVecTSVecMultExpr class.
 
ReturnType operator() (size_t i, size_t j) const
 2D-access to the matrix elements.
 
ConstIterator begin (size_t i) const
 Returns an iterator to the first non-zero element of row i.
 
ConstIterator end (size_t i) const
 Returns an iterator just past the last non-zero element of row i.
 
size_t rows () const
 Returns the current number of rows of the matrix.
 
size_t columns () const
 Returns the current number of columns of the matrix.
 
size_t nonZeros () const
 Returns the number of non-zero elements in the sparse matrix.
 
size_t nonZeros (size_t i) const
 Returns the number of non-zero elements in the specified row.
 
LeftOperand leftOperand () const
 Returns the left-hand side dense vector operand.
 
RightOperand rightOperand () const
 Returns the right-hand side sparse vector operand.
 
template<typename T >
bool isAliased (const T *alias) const
 Returns whether the expression is aliased with the given address alias.
 
MatrixTypeoperator~ ()
 Conversion operator for non-constant matrices.
 
const MatrixTypeoperator~ () const
 Conversion operator for constant matrices.
 

Private Types

enum  { returnExpr = !IsTemporary<RN1>::value && !IsTemporary<RN2>::value }
 Compilation switch for the selection of the subscript operator return type. More...
 
enum  { useAssign }
 Compilation switch for the evaluation strategy of the multiplication expression. More...
 
typedef VT1::ResultType RT1
 Result type of the left-hand side dense vector expression.
 
typedef VT2::ResultType RT2
 Result type of the right-hand side sparse 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 sparse 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 sparse 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 sparse vector expression.
 
typedef MultExprTrait< RN1,
RN2 >::Type 
ExprReturnType
 Expression return type for the subscript operator.
 

Private Attributes

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

Detailed Description

template<typename VT1, typename VT2>
class blaze::DVecTSVecMultExpr< VT1, VT2 >

Expression object for dense vector-sparse vector outer products.

The DVecTSVecMultExpr class represents the compile time expression for dense vector-sparse vector outer products.

Member Enumeration Documentation

template<typename VT1, typename VT2>
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.

template<typename VT1, typename VT2>
anonymous enum
private

Compilation switch for the evaluation strategy of the multiplication expression.

The useAssign compile time constant expression represents a compilation switch for the evaluation strategy of the multiplication expression. In case either the dense or the sparse vector operand is a computational expression or if any of two involved element types is not a numeric data type, useAssign will be set to true and the multiplication expression will be evaluated via the assign function family. Otherwise useAssign will be set to false and the expression will be evaluated via the subscript operator.

Constructor & Destructor Documentation

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

Constructor for the DVecTSVecMultExpr class.

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

Member Function Documentation

template<typename VT1, typename VT2>
ConstIterator blaze::DVecTSVecMultExpr< VT1, VT2 >::begin ( size_t  i) const
inline

Returns an iterator to the first non-zero element of row i.

Parameters
iThe row index.
Returns
Iterator to the first non-zero element of row i.
template<typename VT1, typename VT2>
size_t blaze::DVecTSVecMultExpr< VT1, VT2 >::columns ( ) const
inline

Returns the current number of columns of the matrix.

Returns
The number of columns of the matrix.
template<typename VT1, typename VT2>
ConstIterator blaze::DVecTSVecMultExpr< VT1, VT2 >::end ( size_t  i) const
inline

Returns an iterator just past the last non-zero element of row i.

Parameters
iThe row index.
Returns
Iterator just past the last non-zero element of row i.
template<typename VT1, typename VT2>
template<typename T >
bool blaze::DVecTSVecMultExpr< VT1, VT2 >::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>
LeftOperand blaze::DVecTSVecMultExpr< VT1, VT2 >::leftOperand ( ) const
inline

Returns the left-hand side dense vector operand.

Returns
The left-hand side dense vector operand.
template<typename VT1, typename VT2>
size_t blaze::DVecTSVecMultExpr< VT1, VT2 >::nonZeros ( ) const
inline

Returns the number of non-zero elements in the sparse matrix.

Returns
The number of non-zero elements in the sparse matrix.
template<typename VT1, typename VT2>
size_t blaze::DVecTSVecMultExpr< VT1, VT2 >::nonZeros ( size_t  i) const
inline

Returns the number of non-zero elements in the specified row.

Parameters
iThe index of the row.
Returns
The number of non-zero elements of row i.
template<typename VT1, typename VT2>
ReturnType blaze::DVecTSVecMultExpr< VT1, VT2 >::operator() ( size_t  i,
size_t  j 
) const
inline

2D-access to the matrix elements.

Parameters
iAccess index for the row. The index has to be in the range $[0..M-1]$.
jAccess index for the column. The index has to be in the range $[0..N-1]$.
Returns
The resulting value.
template<typename MT, bool SO>
MatrixType& blaze::Matrix< MT, SO >::operator~ ( )
inlineinherited

Conversion operator for non-constant matrices.

Returns
Reference of the actual type of the matrix.
template<typename MT, bool SO>
const MatrixType& blaze::Matrix< MT, SO >::operator~ ( ) const
inlineinherited

Conversion operator for constant matrices.

Returns
Constant reference of the actual type of the matrix.
template<typename VT1, typename VT2>
RightOperand blaze::DVecTSVecMultExpr< VT1, VT2 >::rightOperand ( ) const
inline

Returns the right-hand side sparse vector operand.

Returns
The right-hand side sparse vector operand.
template<typename VT1, typename VT2>
size_t blaze::DVecTSVecMultExpr< VT1, VT2 >::rows ( ) const
inline

Returns the current number of rows of the matrix.

Returns
The number of rows of the matrix.

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