All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TDVecSMatMultExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_TDVECSMATMULTEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_TDVECSMATMULTEXPR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <stdexcept>
52 #include <blaze/math/shims/Reset.h>
62 #include <blaze/util/Assert.h>
64 #include <blaze/util/DisableIf.h>
65 #include <blaze/util/EnableIf.h>
67 #include <blaze/util/SelectType.h>
68 #include <blaze/util/Types.h>
70 
71 
72 namespace blaze {
73 
74 //=================================================================================================
75 //
76 // CLASS TDVECSMATMULTEXPR
77 //
78 //=================================================================================================
79 
80 //*************************************************************************************************
87 template< typename VT // Type of the left-hand side dense vector
88  , typename MT > // Type of the right-hand side sparse matrix
89 class TDVecSMatMultExpr : public DenseVector< TDVecSMatMultExpr<VT,MT>, true >
90  , private TVecMatMultExpr
91  , private Computation
92 {
93  private:
94  //**Type definitions****************************************************************************
95  typedef typename VT::ResultType VRT;
96  typedef typename MT::ResultType MRT;
97  typedef typename VT::CompositeType VCT;
98  typedef typename MT::CompositeType MCT;
99  //**********************************************************************************************
100 
101  //**********************************************************************************************
103  enum { evaluateVector = IsComputation<VT>::value };
104  //**********************************************************************************************
105 
106  //**********************************************************************************************
108  enum { evaluateMatrix = RequiresEvaluation<MT>::value };
109  //**********************************************************************************************
110 
111  public:
112  //**Type definitions****************************************************************************
117  typedef const ElementType ReturnType;
118  typedef const ResultType CompositeType;
119 
121  typedef typename SelectType< IsExpression<VT>::value, const VT, const VT& >::Type LeftOperand;
122 
124  typedef typename SelectType< IsExpression<MT>::value, const MT, const MT& >::Type RightOperand;
125 
128 
130  typedef MCT RT;
131  //**********************************************************************************************
132 
133  //**Compilation flags***************************************************************************
135  enum { vectorizable = 0 };
136 
138  enum { smpAssignable = 0 };
139  //**********************************************************************************************
140 
141  //**Constructor*********************************************************************************
144  explicit inline TDVecSMatMultExpr( const VT& vec, const MT& mat )
145  : vec_( vec ) // Left-hand side dense vector of the multiplication expression
146  , mat_( mat ) // Right-hand side sparse matrix of the multiplication expression
147  {
148  BLAZE_INTERNAL_ASSERT( vec_.size() == mat.rows(), "Invalid vector and matrix sizes" );
149  }
150  //**********************************************************************************************
151 
152  //**Subscript operator**************************************************************************
158  inline ReturnType operator[]( size_t index ) const {
159  BLAZE_INTERNAL_ASSERT( index < mat_.columns(), "Invalid vector access index" );
160 
161  ElementType res;
162 
163  if( vec_.size() != 0UL ) {
164  res = vec_[0UL] * mat_(0UL,index);
165  for( size_t i=1UL; i<vec_.size(); ++i ) {
166  res += vec_[i] * mat_(i,index);
167  }
168  }
169  else {
170  reset( res );
171  }
172 
173  return res;
174  }
175  //**********************************************************************************************
176 
177  //**Size function*******************************************************************************
182  inline size_t size() const {
183  return mat_.columns();
184  }
185  //**********************************************************************************************
186 
187  //**Left operand access*************************************************************************
192  inline LeftOperand leftOperand() const {
193  return vec_;
194  }
195  //**********************************************************************************************
196 
197  //**Right operand access************************************************************************
202  inline RightOperand rightOperand() const {
203  return mat_;
204  }
205  //**********************************************************************************************
206 
207  //**********************************************************************************************
213  template< typename T >
214  inline bool canAlias( const T* alias ) const {
215  return ( vec_.isAliased( alias ) || mat_.isAliased( alias ) );
216  }
217  //**********************************************************************************************
218 
219  //**********************************************************************************************
225  template< typename T >
226  inline bool isAliased( const T* alias ) const {
227  return ( vec_.isAliased( alias ) || mat_.isAliased( alias ) );
228  }
229  //**********************************************************************************************
230 
231  private:
232  //**Member variables****************************************************************************
235  //**********************************************************************************************
236 
237  //**Default assignment to dense vectors*********************************************************
250  template< typename VT2 > // Type of the target dense vector
251  friend inline typename EnableIf< IsResizable<typename VT2::ElementType> >::Type
253  {
255 
256  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
257 
258  if( rhs.mat_.rows() == 0UL ) {
259  reset( ~lhs );
260  return;
261  }
262 
263  LT x( rhs.vec_ ); // Evaluation of the left-hand side dense vector operator
264  RT A( rhs.mat_ ); // Evaluation of the right-hand side sparse matrix operator
265 
266  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
267  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
268  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
269  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).size() , "Invalid vector size" );
270 
271  for( size_t i=0; i<(~lhs).size(); ++i ) {
272  (~lhs)[i] = x[0UL] * A(0UL,i);
273  for( size_t j=1UL; j<x.size(); ++j ) {
274  (~lhs)[i] += x[j] * A(j,i);
275  }
276  }
277  }
278  //**********************************************************************************************
279 
280  //**Optimized assignment to dense vectors*******************************************************
293  template< typename VT2 > // Type of the target dense vector
294  friend inline typename DisableIf< IsResizable<typename VT2::ElementType> >::Type
296  {
298 
299  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
300 
302 
303  if( rhs.mat_.rows() == 0UL ) {
304  reset( ~lhs );
305  return;
306  }
307 
308  LT x( rhs.vec_ ); // Evaluation of the left-hand side dense vector operator
309  RT A( rhs.mat_ ); // Evaluation of the right-hand side sparse matrix operator
310 
311  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
312  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
313  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
314  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).size() , "Invalid vector size" );
315 
316  reset( ~lhs );
317 
318  for( size_t i=0UL; i<x.size(); ++i ) {
319  const ConstIterator end( A.end(i) );
320  ConstIterator element( A.begin(i) );
321  for( ; element!=end; ++element ) {
322  (~lhs)[element->index()] += x[i] * element->value();
323  }
324  }
325  }
326  //**********************************************************************************************
327 
328  //**Assignment to sparse vectors****************************************************************
340  template< typename VT2 > // Type of the target sparse vector
341  friend inline void assign( SparseVector<VT2,true>& lhs, const TDVecSMatMultExpr& rhs )
342  {
344 
348 
349  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
350 
351  const ResultType tmp( rhs );
352  assign( ~lhs, tmp );
353  }
354  //**********************************************************************************************
355 
356  //**Addition assignment to dense vectors********************************************************
368  template< typename VT2 > // Type of the target dense vector
369  friend inline void addAssign( DenseVector<VT2,true>& lhs, const TDVecSMatMultExpr& rhs )
370  {
372 
373  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
374 
376 
377  if( rhs.mat_.rows() == 0UL ) {
378  return;
379  }
380 
381  LT x( rhs.vec_ ); // Evaluation of the left-hand side dense vector operator
382  RT A( rhs.mat_ ); // Evaluation of the right-hand side sparse matrix operator
383 
384  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
385  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
386  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
387  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).size() , "Invalid vector size" );
388 
389  for( size_t i=0UL; i<x.size(); ++i ) {
390  const ConstIterator end( A.end(i) );
391  ConstIterator element( A.begin(i) );
392  for( ; element!=end; ++element ) {
393  (~lhs)[element->index()] += x[i] * element->value();
394  }
395  }
396  }
397  //**********************************************************************************************
398 
399  //**Addition assignment to sparse vectors*******************************************************
400  // No special implementation for the addition assignment to sparse vectors.
401  //**********************************************************************************************
402 
403  //**Subtraction assignment to dense vectors*****************************************************
415  template< typename VT2 > // Type of the target dense vector
416  friend inline void subAssign( DenseVector<VT2,true>& lhs, const TDVecSMatMultExpr& rhs )
417  {
419 
420  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
421 
423 
424  if( rhs.mat_.rows() == 0UL ) {
425  return;
426  }
427 
428  LT x( rhs.vec_ ); // Evaluation of the left-hand side dense vector operator
429  RT A( rhs.mat_ ); // Evaluation of the right-hand side sparse matrix operator
430 
431  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
432  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
433  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
434  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).size() , "Invalid vector size" );
435 
436  for( size_t i=0UL; i<x.size(); ++i ) {
437  const ConstIterator end( A.end(i) );
438  ConstIterator element( A.begin(i) );
439  for( ; element!=end; ++element ) {
440  (~lhs)[element->index()] -= x[i] * element->value();
441  }
442  }
443  }
444  //**********************************************************************************************
445 
446  //**Subtraction assignment to sparse vectors****************************************************
447  // No special implementation for the subtraction assignment to sparse vectors.
448  //**********************************************************************************************
449 
450  //**Multiplication assignment to dense vectors**************************************************
462  template< typename VT2 > // Type of the target dense vector
463  friend inline void multAssign( DenseVector<VT2,true>& lhs, const TDVecSMatMultExpr& rhs )
464  {
466 
470 
471  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
472 
473  const ResultType tmp( rhs );
474  multAssign( ~lhs, tmp );
475  }
476  //**********************************************************************************************
477 
478  //**Multiplication assignment to sparse vectors*************************************************
479  // No special implementation for the multiplication assignment to sparse vectors.
480  //**********************************************************************************************
481 
482  //**Compile time checks*************************************************************************
489  //**********************************************************************************************
490 };
491 //*************************************************************************************************
492 
493 
494 
495 
496 //=================================================================================================
497 //
498 // GLOBAL BINARY ARITHMETIC OPERATORS
499 //
500 //=================================================================================================
501 
502 //*************************************************************************************************
533 template< typename T1 // Type of the left-hand side dense vector
534  , typename T2 > // Type of the right-hand side sparse matrix
535 inline const typename DisableIf< IsMatMatMultExpr<T2>, TDVecSMatMultExpr<T1,T2> >::Type
537 {
539 
540  if( (~vec).size() != (~mat).rows() )
541  throw std::invalid_argument( "Vector and matrix sizes do not match" );
542 
543  return TDVecSMatMultExpr<T1,T2>( ~vec, ~mat );
544 }
545 //*************************************************************************************************
546 
547 
548 
549 
550 //=================================================================================================
551 //
552 // GLOBAL RESTRUCTURING BINARY ARITHMETIC OPERATORS
553 //
554 //=================================================================================================
555 
556 //*************************************************************************************************
569 template< typename T1 // Type of the left-hand side dense vector
570  , typename T2 // Type of the right-hand side sparse matrix
571  , bool SO > // Storage order of the right-hand side sparse matrix
572 inline const typename EnableIf< IsMatMatMultExpr<T2>, MultExprTrait<T1,T2> >::Type::Type
574 {
576 
577  return ( vec * (~mat).leftOperand() ) * (~mat).rightOperand();
578 }
579 //*************************************************************************************************
580 
581 
582 
583 
584 //=================================================================================================
585 //
586 // EXPRESSION TRAIT SPECIALIZATIONS
587 //
588 //=================================================================================================
589 
590 //*************************************************************************************************
592 template< typename VT, typename MT >
593 struct SubvectorExprTrait< TDVecSMatMultExpr<VT,MT> >
594 {
595  public:
596  //**********************************************************************************************
597  typedef typename MultExprTrait< VT, typename SubmatrixExprTrait<const MT>::Type >::Type Type;
598  //**********************************************************************************************
599 };
601 //*************************************************************************************************
602 
603 } // namespace blaze
604 
605 #endif
MT::ResultType MRT
Result type of the right-hand side sparse matrix expression.
Definition: TDVecSMatMultExpr.h:96
LeftOperand leftOperand() const
Returns the left-hand side dense vector operand.
Definition: TDVecSMatMultExpr.h:192
Compile time check whether the given type is a computational expression template.This type trait clas...
Definition: IsComputation.h:89
void reset(DynamicMatrix< Type, SO > &m)
Resetting the given dense matrix.
Definition: DynamicMatrix.h:4512
const DMatDMatMultExpr< T1, T2 > operator*(const DenseMatrix< T1, false > &lhs, const DenseMatrix< T2, false > &rhs)
Multiplication operator for the multiplication of two row-major dense matrices ( ).
Definition: DMatDMatMultExpr.h:3703
Expression object for transpose dense vector-sparse matrix multiplications.The TDVecSMatMultExpr clas...
Definition: Forward.h:130
MCT RT
Composite type of the right-hand side sparse matrix expression.
Definition: TDVecSMatMultExpr.h:130
Efficient implementation of a compressed matrix.The CompressedMatrix class template is the represent...
Definition: CompressedMatrix.h:196
SelectType< IsExpression< VT >::value, const VT, const VT & >::Type LeftOperand
Composite type of the left-hand side dense vector expression.
Definition: TDVecSMatMultExpr.h:121
const This & CompositeType
Data type for composite expression templates.
Definition: CompressedMatrix.h:2375
Type ElementType
Type of the sparse matrix elements.
Definition: CompressedMatrix.h:248
Header file for the DenseVector base class.
RightOperand mat_
Right-hand side sparse matrix of the multiplication expression.
Definition: TDVecSMatMultExpr.h:234
Header file for the Computation base class.
ResultType::ElementType ElementType
Resulting element type.
Definition: TDVecSMatMultExpr.h:116
Header file for the RequiresEvaluation type trait.
SelectType< evaluateVector, const VRT, VCT >::Type LT
Composite type of the left-hand side dense vector expression.
Definition: TDVecSMatMultExpr.h:127
const ResultType CompositeType
Data type for composite expression templates.
Definition: TDVecSMatMultExpr.h:118
friend void assign(SparseVector< VT2, true > &lhs, const TDVecSMatMultExpr &rhs)
Assignment of a transpose dense vector-sparse matrix multiplication to a sparse vector ( )...
Definition: TDVecSMatMultExpr.h:341
Base class for sparse matrices.The SparseMatrix class is a base class for all sparse matrix classes...
Definition: Forward.h:104
Constraint on the data type.
Constraint on the data type.
Header file for the MultExprTrait class template.
Compile time check to query the requirement to evaluate an expression.Via this type trait it is possi...
Definition: RequiresEvaluation.h:90
Compile time type selection.The SelectType class template selects one of the two given types T1 and T...
Definition: SelectType.h:59
Header file for the DisableIf class template.
friend void subAssign(DenseVector< VT2, true > &lhs, const TDVecSMatMultExpr &rhs)
Subtraction assignment of a transpose dense vector-sparse matrix multiplication to a dense vector ( )...
Definition: TDVecSMatMultExpr.h:416
Header file for the multiplication trait.
ResultType::TransposeType TransposeType
Transpose type for expression template evaluations.
Definition: TDVecSMatMultExpr.h:115
TDVecSMatMultExpr< VT, MT > This
Type of this TDVecSMatMultExpr instance.
Definition: TDVecSMatMultExpr.h:113
friend void multAssign(DenseVector< VT2, true > &lhs, const TDVecSMatMultExpr &rhs)
Multiplication assignment of a transpose dense vector-sparse matrix multiplication to a dense vector ...
Definition: TDVecSMatMultExpr.h:463
const Element * ConstIterator
Iterator over constant elements.
Definition: CompressedMatrix.h:2379
Header file for the IsMatMatMultExpr type trait class.
VT::CompositeType VCT
Composite type of the left-hand side dense vector expression.
Definition: TDVecSMatMultExpr.h:97
Base class for N-dimensional dense vectors.The DenseVector class is a base class for all arbitrarily ...
Definition: DenseVector.h:70
Constraint on the data type.
TDVecSMatMultExpr(const VT &vec, const MT &mat)
Constructor for the TDVecSMatMultExpr class.
Definition: TDVecSMatMultExpr.h:144
#define BLAZE_CONSTRAINT_MUST_BE_REFERENCE_TYPE(T)
Constraint on the data type.In case the given data type T is not a reference type, a compilation error is created.
Definition: Reference.h:78
Constraints on the storage order of matrix types.
Constraint on the data type.
LeftOperand vec_
Left-hand side dense vector of the multiplication expression.
Definition: TDVecSMatMultExpr.h:233
Header file for the SelectType class template.
Header file for all forward declarations for expression class templates.
VT::ResultType VRT
Result type of the left-hand side dense vector expression.
Definition: TDVecSMatMultExpr.h:95
Header file for the EnableIf class template.
friend DisableIf< IsResizable< typename VT2::ElementType > >::Type assign(DenseVector< VT2, true > &lhs, const TDVecSMatMultExpr &rhs)
Optimized assignment of a transpose dense vector-sparse matrix multiplication to a dense vector ( )...
Definition: TDVecSMatMultExpr.h:295
ReturnType operator[](size_t index) const
Subscript operator for the direct access to the vector elements.
Definition: TDVecSMatMultExpr.h:158
const ElementType ReturnType
Return type for expression template evaluations.
Definition: TDVecSMatMultExpr.h:117
Header file for the SubmatrixExprTrait class template.
#define BLAZE_CONSTRAINT_MUST_BE_ROW_MAJOR_MATRIX_TYPE(T)
Constraint on the data type.In case the given data type T is not a row-major dense or sparse matrix t...
Definition: StorageOrder.h:81
Removal of reference modifiers.The RemoveCV type trait removes any reference modifiers from the given...
Definition: RemoveReference.h:69
Header file for run time assertion macros.
Base template for the MultTrait class.
Definition: MultTrait.h:141
MT::CompositeType MCT
Composite type of the right-hand side sparse matrix expression.
Definition: TDVecSMatMultExpr.h:98
Substitution Failure Is Not An Error (SFINAE) class.The EnableIf class template is an auxiliary tool ...
Definition: EnableIf.h:184
Header file for the reset shim.
Header file for the TVecMatMultExpr base class.
friend void addAssign(DenseVector< VT2, true > &lhs, const TDVecSMatMultExpr &rhs)
Addition assignment of a transpose dense vector-sparse matrix multiplication to a dense vector ( )...
Definition: TDVecSMatMultExpr.h:369
bool canAlias(const T *alias) const
Returns whether the expression can alias with the given address alias.
Definition: TDVecSMatMultExpr.h:214
bool isAliased(const T *alias) const
Returns whether the expression is aliased with the given address alias.
Definition: TDVecSMatMultExpr.h:226
MultTrait< VRT, MRT >::Type ResultType
Result type for expression template evaluations.
Definition: TDVecSMatMultExpr.h:114
Header file for the RemoveReference type trait.
Substitution Failure Is Not An Error (SFINAE) class.The DisableIf class template is an auxiliary tool...
Definition: DisableIf.h:184
#define BLAZE_CONSTRAINT_MUST_BE_DENSE_VECTOR_TYPE(T)
Constraint on the data type.In case the given data type T is not a dense, N-dimensional vector type...
Definition: DenseVector.h:79
Header file for the IsComputation type trait class.
Base class for sparse vectors.The SparseVector class is a base class for all arbitrarily sized (N-dim...
Definition: Forward.h:105
#define BLAZE_FUNCTION_TRACE
Function trace macro.This macro can be used to reliably trace function calls. In case function tracin...
Definition: FunctionTrace.h:157
RightOperand rightOperand() const
Returns the right-hand side sparse matrix operand.
Definition: TDVecSMatMultExpr.h:202
This ResultType
Result type for expression template evaluations.
Definition: CompressedMatrix.h:2370
Header file for basic type definitions.
#define BLAZE_CONSTRAINT_MUST_BE_ROW_VECTOR_TYPE(T)
Constraint on the data type.In case the given data type T is not a row dense or sparse vector type (i...
Definition: TransposeFlag.h:81
Header file for the SubvectorExprTrait class template.
Header file for the IsResizable type trait.
SelectType< IsExpression< MT >::value, const MT, const MT & >::Type RightOperand
Composite type of the right-hand side sparse matrix expression.
Definition: TDVecSMatMultExpr.h:124
size_t rows(const Matrix< MT, SO > &m)
Returns the current number of rows of the matrix.
Definition: Matrix.h:138
#define BLAZE_INTERNAL_ASSERT(expr, msg)
Run time assertion macro for internal checks.In case of an invalid run time expression, the program execution is terminated. The BLAZE_INTERNAL_ASSERT macro can be disabled by setting the BLAZE_USER_ASSERTION flag to zero or by defining NDEBUG during the compilation.
Definition: Assert.h:101
size_t size() const
Returns the current size/dimension of the vector.
Definition: TDVecSMatMultExpr.h:182
#define BLAZE_CONSTRAINT_MUST_BE_SPARSE_MATRIX_TYPE(T)
Constraint on the data type.In case the given data type T is not a sparse, N-dimensional matrix type...
Definition: SparseMatrix.h:79
Header file for the IsExpression type trait class.
Header file for the FunctionTrace class.
friend EnableIf< IsResizable< typename VT2::ElementType > >::Type assign(DenseVector< VT2, true > &lhs, const TDVecSMatMultExpr &rhs)
Default assignment of a transpose dense vector-sparse matrix multiplication to a dense vector ( )...
Definition: TDVecSMatMultExpr.h:252