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>
64 #include <blaze/util/Assert.h>
66 #include <blaze/util/DisableIf.h>
67 #include <blaze/util/EnableIf.h>
69 #include <blaze/util/SelectType.h>
70 #include <blaze/util/Types.h>
72 
73 
74 namespace blaze {
75 
76 //=================================================================================================
77 //
78 // CLASS TDVECSMATMULTEXPR
79 //
80 //=================================================================================================
81 
82 //*************************************************************************************************
89 template< typename VT // Type of the left-hand side dense vector
90  , typename MT > // Type of the right-hand side sparse matrix
91 class TDVecTSMatMultExpr : public DenseVector< TDVecTSMatMultExpr<VT,MT>, true >
92  , private TVecMatMultExpr
93  , private Computation
94 {
95  private:
96  //**Type definitions****************************************************************************
97  typedef typename VT::ResultType VRT;
98  typedef typename MT::ResultType MRT;
99  typedef typename VT::CompositeType VCT;
100  typedef typename MT::CompositeType MCT;
101  //**********************************************************************************************
102 
103  //**********************************************************************************************
105 
111  enum { useAssign = ( IsComputation<VT>::value || RequiresEvaluation<MT>::value ) };
112  //**********************************************************************************************
113 
114  //**********************************************************************************************
116  template< typename VT2 >
118  struct UseAssign {
119  enum { value = useAssign };
120  };
122  //**********************************************************************************************
123 
124  public:
125  //**Type definitions****************************************************************************
130  typedef const ElementType ReturnType;
131 
134 
136  typedef typename SelectType< IsExpression<VT>::value, const VT, const VT& >::Type LeftOperand;
137 
139  typedef typename SelectType< IsExpression<MT>::value, const MT, const MT& >::Type RightOperand;
140 
142  typedef typename SelectType< IsComputation<VT>::value, const VRT, VCT >::Type LT;
143 
145  typedef MCT RT;
146  //**********************************************************************************************
147 
148  //**Compilation flags***************************************************************************
150  enum { vectorizable = 0 };
151 
153  enum { smpAssignable = !useAssign };
154  //**********************************************************************************************
155 
156  //**Constructor*********************************************************************************
159  explicit inline TDVecTSMatMultExpr( const VT& vec, const MT& mat )
160  : vec_( vec ) // Left-hand side dense vector of the multiplication expression
161  , mat_( mat ) // Right-hand side sparse matrix of the multiplication expression
162  {
163  BLAZE_INTERNAL_ASSERT( vec_.size() == mat.rows(), "Invalid vector and matrix sizes" );
164  }
165  //**********************************************************************************************
166 
167  //**Subscript operator**************************************************************************
173  inline ReturnType operator[]( size_t index ) const {
174  BLAZE_INTERNAL_ASSERT( index < mat_.columns(), "Invalid vector access index" );
175 
177 
178  VCT x( vec_ ); // Evaluation of the left-hand side sparse vector operand
179  MCT A( mat_ ); // Evaluation of the right-hand side sparse matrix operand
180 
181  BLAZE_INTERNAL_ASSERT( x.size() == vec_.size() , "Invalid vector size" );
182  BLAZE_INTERNAL_ASSERT( A.rows() == mat_.rows() , "Invalid number of rows" );
183  BLAZE_INTERNAL_ASSERT( A.columns() == mat_.columns(), "Invalid number of columns" );
184 
185  const ConstIterator end( A.end(index) );
186  ConstIterator element( A.begin(index) );
187  ElementType res;
188 
189  if( element != end ) {
190  res = x[element->index()] * element->value();
191  ++element;
192  for( ; element!=end; ++element )
193  res += x[element->index()] * element->value();
194  }
195  else {
196  reset( res );
197  }
198 
199  return res;
200  }
201  //**********************************************************************************************
202 
203  //**Size function*******************************************************************************
208  inline size_t size() const {
209  return mat_.columns();
210  }
211  //**********************************************************************************************
212 
213  //**Left operand access*************************************************************************
218  inline LeftOperand leftOperand() const {
219  return vec_;
220  }
221  //**********************************************************************************************
222 
223  //**Right operand access************************************************************************
228  inline RightOperand rightOperand() const {
229  return mat_;
230  }
231  //**********************************************************************************************
232 
233  //**********************************************************************************************
239  template< typename T >
240  inline bool canAlias( const T* alias ) const {
241  return ( vec_.isAliased( alias ) || mat_.isAliased( alias ) );
242  }
243  //**********************************************************************************************
244 
245  //**********************************************************************************************
251  template< typename T >
252  inline bool isAliased( const T* alias ) const {
253  return ( vec_.isAliased( alias ) || mat_.isAliased( alias ) );
254  }
255  //**********************************************************************************************
256 
257  //**********************************************************************************************
262  inline bool isAligned() const {
263  return vec_.isAligned();
264  }
265  //**********************************************************************************************
266 
267  //**********************************************************************************************
272  inline bool canSMPAssign() const {
273  return ( size() > SMP_TDVECTSMATMULT_THRESHOLD );
274  }
275  //**********************************************************************************************
276 
277  private:
278  //**Member variables****************************************************************************
279  LeftOperand vec_;
280  RightOperand mat_;
281  //**********************************************************************************************
282 
283  //**Assignment to dense vectors*****************************************************************
298  template< typename VT2 > // Type of the target dense vector
299  friend inline typename EnableIf< UseAssign<VT2> >::Type
301  {
303 
304  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
305 
307 
308  if( rhs.mat_.rows() == 0UL ) {
309  reset( ~lhs );
310  return;
311  }
312 
313  LT x( rhs.vec_ ); // Evaluation of the left-hand side dense vector operator
314  RT A( rhs.mat_ ); // Evaluation of the right-hand side sparse matrix operator
315 
316  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
317  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
318  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
319  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).size() , "Invalid vector size" );
320 
321  smpAssign( ~lhs, x * A );
322  }
323  //**********************************************************************************************
324 
325  //**Assignment to sparse vectors****************************************************************
340  template< typename VT2 > // Type of the target sparse vector
341  friend inline typename EnableIf< UseAssign<VT2> >::Type
343  {
345 
349 
350  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
351 
352  const ResultType tmp( rhs );
353  smpAssign( ~lhs, tmp );
354  }
355  //**********************************************************************************************
356 
357  //**Addition assignment to dense vectors********************************************************
372  template< typename VT2 > // Type of the target dense vector
373  friend inline typename EnableIf< UseAssign<VT2> >::Type
375  {
377 
378  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
379 
381 
382  if( rhs.mat_.rows() == 0UL ) {
383  return;
384  }
385 
386  LT x( rhs.vec_ ); // Evaluation of the left-hand side dense vector operator
387  RT A( rhs.mat_ ); // Evaluation of the right-hand side sparse matrix operator
388 
389  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
390  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
391  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
392  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).size() , "Invalid vector size" );
393 
394  smpAddAssign( ~lhs, x * A );
395  }
396  //**********************************************************************************************
397 
398  //**Addition assignment to sparse vectors*******************************************************
399  // No special implementation for the addition assignment to sparse vectors.
400  //**********************************************************************************************
401 
402  //**Subtraction assignment to dense vectors*****************************************************
417  template< typename VT2 > // Type of the target dense vector
418  friend inline typename EnableIf< UseAssign<VT2> >::Type
420  {
422 
423  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
424 
426 
427  if( rhs.mat_.rows() == 0UL ) {
428  return;
429  }
430 
431  LT x( rhs.vec_ ); // Evaluation of the left-hand side dense vector operator
432  RT A( rhs.mat_ ); // Evaluation of the right-hand side sparse matrix operator
433 
434  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
435  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
436  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
437  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).size() , "Invalid vector size" );
438 
439  smpSubAssign( ~lhs, x * A );
440  }
441  //**********************************************************************************************
442 
443  //**Subtraction assignment to sparse vectors****************************************************
444  // No special implementation for the subtraction assignment to sparse vectors.
445  //**********************************************************************************************
446 
447  //**Multiplication assignment to dense vectors**************************************************
462  template< typename VT2 > // Type of the target dense vector
463  friend inline typename EnableIf< UseAssign<VT2> >::Type
465  {
467 
471 
472  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
473 
474  const ResultType tmp( rhs );
475  smpMultAssign( ~lhs, tmp );
476  }
477  //**********************************************************************************************
478 
479  //**Multiplication assignment to sparse vectors*************************************************
480  // No special implementation for the multiplication assignment to sparse vectors.
481  //**********************************************************************************************
482 
483  //**Compile time checks*************************************************************************
490  //**********************************************************************************************
491 };
492 //*************************************************************************************************
493 
494 
495 
496 
497 //=================================================================================================
498 //
499 // GLOBAL BINARY ARITHMETIC OPERATORS
500 //
501 //=================================================================================================
502 
503 //*************************************************************************************************
534 template< typename T1 // Type of the left-hand side dense vector
535  , typename T2 > // Type of the right-hand side sparse matrix
536 inline const typename DisableIf< IsMatMatMultExpr<T2>, TDVecTSMatMultExpr<T1,T2> >::Type
538 {
540 
541  if( (~vec).size() != (~mat).rows() )
542  throw std::invalid_argument( "Vector and matrix sizes do not match" );
543 
544  return TDVecTSMatMultExpr<T1,T2>( ~vec, ~mat );
545 }
546 //*************************************************************************************************
547 
548 
549 
550 
551 //=================================================================================================
552 //
553 // EXPRESSION TRAIT SPECIALIZATIONS
554 //
555 //=================================================================================================
556 
557 //*************************************************************************************************
559 template< typename VT, typename MT, bool AF >
560 struct SubvectorExprTrait< TDVecTSMatMultExpr<VT,MT>, AF >
561 {
562  public:
563  //**********************************************************************************************
564  typedef typename MultExprTrait< VT, typename SubmatrixExprTrait<const MT,AF>::Type >::Type Type;
565  //**********************************************************************************************
566 };
568 //*************************************************************************************************
569 
570 } // namespace blaze
571 
572 #endif
LeftOperand vec_
Left-hand side dense vector of the multiplication expression.
Definition: TDVecTSMatMultExpr.h:279
LeftOperand leftOperand() const
Returns the left-hand side dense vector operand.
Definition: TDVecTSMatMultExpr.h:218
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:4579
bool isAliased(const T *alias) const
Returns whether the expression is aliased with the given address alias.
Definition: TDVecTSMatMultExpr.h:252
VT::ResultType VRT
Result type of the left-hand side dense vector expression.
Definition: TDVecTSMatMultExpr.h:97
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:4075
TDVecTSMatMultExpr(const VT &vec, const MT &mat)
Constructor for the TDVecTSMatMultExpr class.
Definition: TDVecTSMatMultExpr.h:159
void smpSubAssign(DenseMatrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the SMP subtraction assignment of a matrix to dense matrix.
Definition: DenseMatrix.h:151
Efficient implementation of a compressed matrix.The CompressedMatrix class template is the represent...
Definition: CompressedMatrix.h:197
void smpMultAssign(DenseVector< VT1, TF1 > &lhs, const Vector< VT2, TF2 > &rhs)
Default implementation of the SMP multiplication assignment of a vector to a dense vector...
Definition: DenseVector.h:178
ResultType::TransposeType TransposeType
Transpose type for expression template evaluations.
Definition: TDVecTSMatMultExpr.h:128
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:133
const This & CompositeType
Data type for composite expression templates.
Definition: CompressedMatrix.h:2384
Type ElementType
Type of the sparse matrix elements.
Definition: CompressedMatrix.h:249
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:142
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:240
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:136
MCT RT
Composite type of the right-hand side sparse matrix expression.
Definition: TDVecTSMatMultExpr.h:145
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:374
Constraint on the data type.
Header file for the MultExprTrait class template.
void smpAddAssign(DenseMatrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the SMP addition assignment of a matrix to a dense matrix.
Definition: DenseMatrix.h:121
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:139
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.
Header file for the dense vector SMP implementation.
#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:2388
Header file for the IsMatMatMultExpr type trait class.
size_t size() const
Returns the current size/dimension of the vector.
Definition: TDVecTSMatMultExpr.h:208
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:300
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:280
Header file for the EnableIf class template.
MT::CompositeType MCT
Composite type of the right-hand side sparse matrix expression.
Definition: TDVecTSMatMultExpr.h:100
void smpAssign(DenseMatrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the SMP assignment of a matrix to a dense matrix.
Definition: DenseMatrix.h:91
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:342
ReturnType operator[](size_t index) const
Subscript operator for the direct access to the vector elements.
Definition: TDVecTSMatMultExpr.h:173
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
bool canSMPAssign() const
Returns whether the expression can be used in SMP assignments.
Definition: TDVecTSMatMultExpr.h:272
Header file for run time assertion macros.
Base template for the MultTrait class.
Definition: MultTrait.h:141
const size_t SMP_TDVECTSMATMULT_THRESHOLD
SMP dense vector/column-major sparse matrix multiplication threshold.This threshold represents the sy...
Definition: Thresholds.h:282
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:464
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:99
Header file for the TVecMatMultExpr base class.
MultTrait< VRT, MRT >::Type ResultType
Result type for expression template evaluations.
Definition: TDVecTSMatMultExpr.h:127
RightOperand rightOperand() const
Returns the right-hand side transpose sparse matrix operand.
Definition: TDVecTSMatMultExpr.h:228
Header file for the RemoveReference type trait.
ResultType::ElementType ElementType
Resulting element type.
Definition: TDVecTSMatMultExpr.h:129
#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.
Header file for the sparse vector SMP implementation.
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:2379
MT::ResultType MRT
Result type of the right-hand side sparse matrix expression.
Definition: TDVecTSMatMultExpr.h:98
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:126
Header file for the thresholds for matrix/vector and matrix/matrix multiplications.
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
bool isAligned() const
Returns whether the operands of the expression are properly aligned in memory.
Definition: TDVecTSMatMultExpr.h:262
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:419
const ElementType ReturnType
Return type for expression template evaluations.
Definition: TDVecTSMatMultExpr.h:130
Header file for the FunctionTrace class.