All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TDVecTSMatMultExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_TDVECTSMATMULTEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_TDVECTSMATMULTEXPR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <stdexcept>
52 #include <blaze/math/shims/Reset.h>
61 #include <blaze/util/Assert.h>
63 #include <blaze/util/DisableIf.h>
64 #include <blaze/util/EnableIf.h>
66 #include <blaze/util/SelectType.h>
67 #include <blaze/util/Types.h>
69 
70 
71 namespace blaze {
72 
73 //=================================================================================================
74 //
75 // CLASS TDVECSMATMULTEXPR
76 //
77 //=================================================================================================
78 
79 //*************************************************************************************************
86 template< typename VT // Type of the left-hand side dense vector
87  , typename MT > // Type of the right-hand side sparse matrix
88 class TDVecTSMatMultExpr : public DenseVector< TDVecTSMatMultExpr<VT,MT>, true >
89  , private TVecMatMultExpr
90  , private Computation
91 {
92  private:
93  //**Type definitions****************************************************************************
94  typedef typename VT::ResultType VRT;
95  typedef typename MT::ResultType MRT;
96  typedef typename VT::CompositeType VCT;
97  typedef typename MT::CompositeType MCT;
98  //**********************************************************************************************
99 
100  //**********************************************************************************************
102 
108  enum { useAssign = ( IsComputation<VT>::value || RequiresEvaluation<MT>::value ) };
109  //**********************************************************************************************
110 
111  //**********************************************************************************************
113  template< typename VT2 >
115  struct UseAssign {
116  enum { value = useAssign };
117  };
119  //**********************************************************************************************
120 
121  public:
122  //**Type definitions****************************************************************************
127  typedef const ElementType ReturnType;
128 
131 
133  typedef typename SelectType< IsExpression<VT>::value, const VT, const VT& >::Type LeftOperand;
134 
136  typedef typename SelectType< IsExpression<MT>::value, const MT, const MT& >::Type RightOperand;
137 
139  typedef typename SelectType< IsComputation<VT>::value, const VRT, VCT >::Type LT;
140 
142  typedef MCT RT;
143  //**********************************************************************************************
144 
145  //**Compilation flags***************************************************************************
147  enum { vectorizable = 0 };
148 
150  enum { smpAssignable = 0 };
151  //**********************************************************************************************
152 
153  //**Constructor*********************************************************************************
156  explicit inline TDVecTSMatMultExpr( const VT& vec, const MT& mat )
157  : vec_( vec ) // Left-hand side dense vector of the multiplication expression
158  , mat_( mat ) // Right-hand side sparse matrix of the multiplication expression
159  {
160  BLAZE_INTERNAL_ASSERT( vec_.size() == mat.rows(), "Invalid vector and matrix sizes" );
161  }
162  //**********************************************************************************************
163 
164  //**Subscript operator**************************************************************************
170  inline ReturnType operator[]( size_t index ) const {
171  BLAZE_INTERNAL_ASSERT( index < mat_.columns(), "Invalid vector access index" );
172 
174 
175  VCT x( vec_ ); // Evaluation of the left-hand side sparse vector operand
176  MCT A( mat_ ); // Evaluation of the right-hand side sparse matrix operand
177 
178  BLAZE_INTERNAL_ASSERT( x.size() == vec_.size() , "Invalid vector size" );
179  BLAZE_INTERNAL_ASSERT( A.rows() == mat_.rows() , "Invalid number of rows" );
180  BLAZE_INTERNAL_ASSERT( A.columns() == mat_.columns(), "Invalid number of columns" );
181 
182  const ConstIterator end( A.end(index) );
183  ConstIterator element( A.begin(index) );
184  ElementType res;
185 
186  if( element != end ) {
187  res = x[element->index()] * element->value();
188  ++element;
189  for( ; element!=end; ++element )
190  res += x[element->index()] * element->value();
191  }
192  else {
193  reset( res );
194  }
195 
196  return res;
197  }
198  //**********************************************************************************************
199 
200  //**Size function*******************************************************************************
205  inline size_t size() const {
206  return mat_.columns();
207  }
208  //**********************************************************************************************
209 
210  //**Left operand access*************************************************************************
215  inline LeftOperand leftOperand() const {
216  return vec_;
217  }
218  //**********************************************************************************************
219 
220  //**Right operand access************************************************************************
225  inline RightOperand rightOperand() const {
226  return mat_;
227  }
228  //**********************************************************************************************
229 
230  //**********************************************************************************************
236  template< typename T >
237  inline bool canAlias( const T* alias ) const {
238  return ( vec_.isAliased( alias ) || mat_.isAliased( alias ) );
239  }
240  //**********************************************************************************************
241 
242  //**********************************************************************************************
248  template< typename T >
249  inline bool isAliased( const T* alias ) const {
250  return ( vec_.isAliased( alias ) || mat_.isAliased( alias ) );
251  }
252  //**********************************************************************************************
253 
254  private:
255  //**Member variables****************************************************************************
256  LeftOperand vec_;
257  RightOperand mat_;
258  //**********************************************************************************************
259 
260  //**Assignment to dense vectors*****************************************************************
275  template< typename VT2 > // Type of the target dense vector
276  friend inline typename EnableIf< UseAssign<VT2> >::Type
278  {
280 
281  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
282 
284 
285  if( rhs.mat_.rows() == 0UL ) {
286  reset( ~lhs );
287  return;
288  }
289 
290  LT x( rhs.vec_ ); // Evaluation of the left-hand side dense vector operator
291  RT A( rhs.mat_ ); // Evaluation of the right-hand side sparse matrix operator
292 
293  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
294  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
295  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
296  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).size() , "Invalid vector size" );
297 
298  for( size_t j=0UL; j<A.columns(); ++j )
299  {
300  const ConstIterator end( A.end(j) );
301  ConstIterator element( A.begin(j) );
302 
303  if( element == end ) {
304  reset( (~lhs)[j] );
305  continue;
306  }
307 
308  (~lhs)[j] = x[element->index()] * element->value();
309  ++element;
310  for( ; element!=end; ++element ) {
311  (~lhs)[j] += x[element->index()] * element->value();
312  }
313  }
314  }
315  //**********************************************************************************************
316 
317  //**Assignment to sparse vectors****************************************************************
332  template< typename VT2 > // Type of the target sparse vector
333  friend inline typename EnableIf< UseAssign<VT2> >::Type
335  {
337 
341 
342  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
343 
344  const ResultType tmp( rhs );
345  assign( ~lhs, tmp );
346  }
347  //**********************************************************************************************
348 
349  //**Addition assignment to dense vectors********************************************************
364  template< typename VT2 > // Type of the target dense vector
365  friend inline typename EnableIf< UseAssign<VT2> >::Type
367  {
369 
370  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
371 
373 
374  if( rhs.mat_.rows() == 0UL ) {
375  return;
376  }
377 
378  LT x( rhs.vec_ ); // Evaluation of the left-hand side dense vector operator
379  RT A( rhs.mat_ ); // Evaluation of the right-hand side sparse matrix operator
380 
381  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
382  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
383  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
384  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).size() , "Invalid vector size" );
385 
386  for( size_t j=0UL; j<A.columns(); ++j ) {
387  const ConstIterator end( A.end(j) );
388  ConstIterator element( A.begin(j) );
389 
390  for( ; element!=end; ++element ) {
391  (~lhs)[j] += x[element->index()] * element->value();
392  }
393  }
394  }
395  //**********************************************************************************************
396 
397  //**Addition assignment to sparse vectors*******************************************************
398  // No special implementation for the addition assignment to sparse vectors.
399  //**********************************************************************************************
400 
401  //**Subtraction assignment to dense vectors*****************************************************
416  template< typename VT2 > // Type of the target dense vector
417  friend inline typename EnableIf< UseAssign<VT2> >::Type
419  {
421 
422  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
423 
425 
426  if( rhs.mat_.rows() == 0UL ) {
427  return;
428  }
429 
430  LT x( rhs.vec_ ); // Evaluation of the left-hand side dense vector operator
431  RT A( rhs.mat_ ); // Evaluation of the right-hand side sparse matrix operator
432 
433  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
434  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
435  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
436  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).size() , "Invalid vector size" );
437 
438  for( size_t j=0UL; j<A.columns(); ++j ) {
439  const ConstIterator end( A.end(j) );
440  ConstIterator element( A.begin(j) );
441 
442  for( ; element!=end; ++element ) {
443  (~lhs)[j] -= x[element->index()] * element->value();
444  }
445  }
446  }
447  //**********************************************************************************************
448 
449  //**Subtraction assignment to sparse vectors****************************************************
450  // No special implementation for the subtraction assignment to sparse vectors.
451  //**********************************************************************************************
452 
453  //**Multiplication assignment to dense vectors**************************************************
468  template< typename VT2 > // Type of the target dense vector
469  friend inline typename EnableIf< UseAssign<VT2> >::Type
471  {
473 
477 
478  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
479 
480  const ResultType tmp( rhs );
481  multAssign( ~lhs, tmp );
482  }
483  //**********************************************************************************************
484 
485  //**Multiplication assignment to sparse vectors*************************************************
486  // No special implementation for the multiplication assignment to sparse vectors.
487  //**********************************************************************************************
488 
489  //**Compile time checks*************************************************************************
496  //**********************************************************************************************
497 };
498 //*************************************************************************************************
499 
500 
501 
502 
503 //=================================================================================================
504 //
505 // GLOBAL BINARY ARITHMETIC OPERATORS
506 //
507 //=================================================================================================
508 
509 //*************************************************************************************************
540 template< typename T1 // Type of the left-hand side dense vector
541  , typename T2 > // Type of the right-hand side sparse matrix
542 inline const typename DisableIf< IsMatMatMultExpr<T2>, TDVecTSMatMultExpr<T1,T2> >::Type
544 {
546 
547  if( (~vec).size() != (~mat).rows() )
548  throw std::invalid_argument( "Vector and matrix sizes do not match" );
549 
550  return TDVecTSMatMultExpr<T1,T2>( ~vec, ~mat );
551 }
552 //*************************************************************************************************
553 
554 
555 
556 
557 //=================================================================================================
558 //
559 // EXPRESSION TRAIT SPECIALIZATIONS
560 //
561 //=================================================================================================
562 
563 //*************************************************************************************************
565 template< typename VT, typename MT >
566 struct SubvectorExprTrait< TDVecTSMatMultExpr<VT,MT> >
567 {
568  public:
569  //**********************************************************************************************
570  typedef typename MultExprTrait< VT, typename SubmatrixExprTrait<const MT>::Type >::Type Type;
571  //**********************************************************************************************
572 };
574 //*************************************************************************************************
575 
576 } // namespace blaze
577 
578 #endif
LeftOperand vec_
Left-hand side dense vector of the multiplication expression.
Definition: TDVecTSMatMultExpr.h:256
LeftOperand leftOperand() const
Returns the left-hand side dense vector operand.
Definition: TDVecTSMatMultExpr.h:215
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
bool isAliased(const T *alias) const
Returns whether the expression is aliased with the given address alias.
Definition: TDVecTSMatMultExpr.h:249
VT::ResultType VRT
Result type of the left-hand side dense vector expression.
Definition: TDVecTSMatMultExpr.h:94
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
TDVecTSMatMultExpr(const VT &vec, const MT &mat)
Constructor for the TDVecTSMatMultExpr class.
Definition: TDVecTSMatMultExpr.h:156
Efficient implementation of a compressed matrix.The CompressedMatrix class template is the represent...
Definition: CompressedMatrix.h:196
ResultType::TransposeType TransposeType
Transpose type for expression template evaluations.
Definition: TDVecTSMatMultExpr.h:125
Expression object for transpose dense vector-transpose sparse matrix multiplications.The TDVecTSMatMultExpr class represents the compile time expression for multiplications between transpose dense vectors and column-major sparse matrices.
Definition: Forward.h:132
SelectType< useAssign, const ResultType, const TDVecTSMatMultExpr & >::Type CompositeType
Data type for composite expression templates.
Definition: TDVecTSMatMultExpr.h:130
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.
SelectType< IsComputation< VT >::value, const VRT, VCT >::Type LT
Composite type of the left-hand side dense vector expression.
Definition: TDVecTSMatMultExpr.h:139
Header file for the Computation base class.
Header file for the RequiresEvaluation type trait.
bool canAlias(const T *alias) const
Returns whether the expression can alias with the given address alias.
Definition: TDVecTSMatMultExpr.h:237
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.
SelectType< IsExpression< VT >::value, const VT, const VT & >::Type LeftOperand
Composite type of the left-hand side dense vector expression.
Definition: TDVecTSMatMultExpr.h:133
MCT RT
Composite type of the right-hand side sparse matrix expression.
Definition: TDVecTSMatMultExpr.h:142
friend EnableIf< UseAssign< VT2 > >::Type addAssign(DenseVector< VT2, true > &lhs, const TDVecTSMatMultExpr &rhs)
Addition assignment of a transpose dense vector-transpose sparse matrix multiplication to a dense vec...
Definition: TDVecTSMatMultExpr.h:366
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
SelectType< IsExpression< MT >::value, const MT, const MT & >::Type RightOperand
Composite type of the right-hand side sparse matrix expression.
Definition: TDVecTSMatMultExpr.h:136
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.
Header file for the multiplication trait.
#define BLAZE_CONSTRAINT_MUST_BE_COLUMN_MAJOR_MATRIX_TYPE(T)
Constraint on the data type.In case the given data type T is not a column-major dense or sparse matri...
Definition: StorageOrder.h:161
const Element * ConstIterator
Iterator over constant elements.
Definition: CompressedMatrix.h:2379
Header file for the IsMatMatMultExpr type trait class.
size_t size() const
Returns the current size/dimension of the vector.
Definition: TDVecTSMatMultExpr.h:205
friend EnableIf< UseAssign< VT2 > >::Type assign(DenseVector< VT2, true > &lhs, const TDVecTSMatMultExpr &rhs)
Assignment of a transpose dense vector-transpose sparse matrix multiplication to a dense vector ( )...
Definition: TDVecTSMatMultExpr.h:277
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.
#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.
Header file for the SelectType class template.
Header file for all forward declarations for expression class templates.
RightOperand mat_
Right-hand side sparse matrix of the multiplication expression.
Definition: TDVecTSMatMultExpr.h:257
Header file for the EnableIf class template.
MT::CompositeType MCT
Composite type of the right-hand side sparse matrix expression.
Definition: TDVecTSMatMultExpr.h:97
friend EnableIf< UseAssign< VT2 > >::Type assign(SparseVector< VT2, true > &lhs, const TDVecTSMatMultExpr &rhs)
Assignment of a transpose dense vector-transpose sparse matrix multiplication to a sparse vector ( )...
Definition: TDVecTSMatMultExpr.h:334
ReturnType operator[](size_t index) const
Subscript operator for the direct access to the vector elements.
Definition: TDVecTSMatMultExpr.h:170
Header file for the SubmatrixExprTrait class template.
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
friend EnableIf< UseAssign< VT2 > >::Type multAssign(DenseVector< VT2, true > &lhs, const TDVecTSMatMultExpr &rhs)
Multiplication assignment of a transpose dense vector-transpose sparse matrix multiplication to a den...
Definition: TDVecTSMatMultExpr.h:470
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.
VT::CompositeType VCT
Composite type of the left-hand side dense vector expression.
Definition: TDVecTSMatMultExpr.h:96
Header file for the TVecMatMultExpr base class.
MultTrait< VRT, MRT >::Type ResultType
Result type for expression template evaluations.
Definition: TDVecTSMatMultExpr.h:124
RightOperand rightOperand() const
Returns the right-hand side transpose sparse matrix operand.
Definition: TDVecTSMatMultExpr.h:225
Header file for the RemoveReference type trait.
ResultType::ElementType ElementType
Resulting element type.
Definition: TDVecTSMatMultExpr.h:126
#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
This ResultType
Result type for expression template evaluations.
Definition: CompressedMatrix.h:2370
MT::ResultType MRT
Result type of the right-hand side sparse matrix expression.
Definition: TDVecTSMatMultExpr.h:95
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.
TDVecTSMatMultExpr< VT, MT > This
Type of this TDVecTSMatMultExpr instance.
Definition: TDVecTSMatMultExpr.h:123
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
#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.
friend EnableIf< UseAssign< VT2 > >::Type subAssign(DenseVector< VT2, true > &lhs, const TDVecTSMatMultExpr &rhs)
Subtraction assignment of a transpose dense vector-transpose sparse matrix multiplication to a dense ...
Definition: TDVecTSMatMultExpr.h:418
const ElementType ReturnType
Return type for expression template evaluations.
Definition: TDVecTSMatMultExpr.h:127
Header file for the FunctionTrace class.