All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
DMatSVecMultExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_DMATSVECMULTEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_DMATSVECMULTEXPR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <stdexcept>
53 #include <blaze/math/shims/Reset.h>
65 #include <blaze/util/Assert.h>
67 #include <blaze/util/DisableIf.h>
68 #include <blaze/util/EnableIf.h>
70 #include <blaze/util/SelectType.h>
71 #include <blaze/util/Types.h>
73 
74 
75 namespace blaze {
76 
77 //=================================================================================================
78 //
79 // CLASS DMATSVECMULTEXPR
80 //
81 //=================================================================================================
82 
83 //*************************************************************************************************
90 template< typename MT // Type of the left-hand side dense matrix
91  , typename VT > // Type of the right-hand side sparse vector
92 class DMatSVecMultExpr : public DenseVector< DMatSVecMultExpr<MT,VT>, false >
93  , private MatVecMultExpr
94  , private Computation
95 {
96  private:
97  //**Type definitions****************************************************************************
98  typedef typename MT::ResultType MRT;
99  typedef typename VT::ResultType VRT;
100  typedef typename MT::CompositeType MCT;
101  typedef typename VT::CompositeType VCT;
102  //**********************************************************************************************
103 
104  //**********************************************************************************************
106 
113  //**********************************************************************************************
114 
115  //**********************************************************************************************
117  template< typename VT2 >
119  struct UseAssign {
120  enum { value = useAssign };
121  };
123  //**********************************************************************************************
124 
125  public:
126  //**Type definitions****************************************************************************
131  typedef const ElementType ReturnType;
132 
135 
137  typedef typename SelectType< IsExpression<MT>::value, const MT, const MT& >::Type LeftOperand;
138 
140  typedef typename SelectType< IsExpression<VT>::value, const VT, const VT& >::Type RightOperand;
141 
143  typedef MCT LT;
144 
146  typedef typename SelectType< IsComputation<VT>::value, const VRT, VCT >::Type RT;
147  //**********************************************************************************************
148 
149  //**Compilation flags***************************************************************************
151  enum { vectorizable = 0 };
152 
154  enum { smpAssignable = !useAssign };
155  //**********************************************************************************************
156 
157  //**Constructor*********************************************************************************
163  explicit inline DMatSVecMultExpr( const MT& mat, const VT& vec )
164  : mat_( mat ) // Left-hand side dense matrix of the multiplication expression
165  , vec_( vec ) // Right-hand side sparse vector of the multiplication expression
166  {
167  BLAZE_INTERNAL_ASSERT( mat_.columns() == vec_.size(), "Invalid matrix and vector sizes" );
168  }
169  //**********************************************************************************************
170 
171  //**Subscript operator**************************************************************************
177  inline ReturnType operator[]( size_t index ) const {
178  BLAZE_INTERNAL_ASSERT( index < mat_.rows(), "Invalid vector access index" );
179 
181 
182  VCT x( vec_ ); // Evaluation of the right-hand side sparse vector operand
183 
184  BLAZE_INTERNAL_ASSERT( x.size() == vec_.size(), "Invalid vector size" );
185 
186  ConstIterator element( x.begin() );
187  ElementType res;
188 
189  if( element != x.end() ) {
190  res = mat_( index, element->index() ) * element->value();
191  ++element;
192  for( ; element!=x.end(); ++element )
193  res += mat_( index, 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_.rows();
210  }
211  //**********************************************************************************************
212 
213  //**Left operand access*************************************************************************
218  inline LeftOperand leftOperand() const {
219  return mat_;
220  }
221  //**********************************************************************************************
222 
223  //**Right operand access************************************************************************
228  inline RightOperand rightOperand() const {
229  return vec_;
230  }
231  //**********************************************************************************************
232 
233  //**********************************************************************************************
239  template< typename T >
240  inline bool canAlias( const T* alias ) const {
241  return mat_.isAliased( alias ) || vec_.isAliased( alias );
242  }
243  //**********************************************************************************************
244 
245  //**********************************************************************************************
251  template< typename T >
252  inline bool isAliased( const T* alias ) const {
253  return mat_.isAliased( alias ) || vec_.isAliased( alias );
254  }
255  //**********************************************************************************************
256 
257  //**********************************************************************************************
262  inline bool isAligned() const {
263  return mat_.isAligned();
264  }
265  //**********************************************************************************************
266 
267  //**********************************************************************************************
272  inline bool canSMPAssign() const {
273  return ( size() > SMP_DMATSVECMULT_THRESHOLD );
274  }
275  //**********************************************************************************************
276 
277  private:
278  //**Member variables****************************************************************************
281  //**********************************************************************************************
282 
283  //**Assignment to dense vectors*****************************************************************
299  template< typename VT1 > // Type of the target dense vector
300  friend inline typename EnableIf< UseAssign<VT1> >::Type
302  {
304 
305  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
306 
308 
309  // Evaluation of the right-hand side sparse vector operand
310  RT x( rhs.vec_ );
311  if( x.nonZeros() == 0UL ) {
312  reset( ~lhs );
313  return;
314  }
315 
316  // Evaluation of the left-hand side dense matrix operand
317  LT A( rhs.mat_ );
318 
319  // Checking the evaluated operands
320  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
321  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
322  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
323  BLAZE_INTERNAL_ASSERT( A.rows() == (~lhs).size() , "Invalid vector size" );
324 
325  // Performing the dense matrix-sparse vector multiplication
326  smpAssign( ~lhs, A * x );
327  }
329  //**********************************************************************************************
330 
331  //**Assignment to sparse vectors****************************************************************
347  template< typename VT1 > // Type of the target sparse vector
348  friend inline typename EnableIf< UseAssign<VT1> >::Type
350  {
352 
356 
357  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
358 
359  const ResultType tmp( rhs );
360  smpAssign( ~lhs, tmp );
361  }
363  //**********************************************************************************************
364 
365  //**Addition assignment to dense vectors********************************************************
381  template< typename VT1 > // Type of the target dense vector
382  friend inline typename EnableIf< UseAssign<VT1> >::Type
383  addAssign( DenseVector<VT1,false>& lhs, const DMatSVecMultExpr& rhs )
384  {
386 
387  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
388 
390 
391  // Evaluation of the right-hand side sparse vector operand
392  RT x( rhs.vec_ );
393  if( x.nonZeros() == 0UL ) return;
394 
395  // Evaluation of the left-hand side dense matrix operand
396  LT A( rhs.mat_ );
397 
398  // Checking the evaluated operands
399  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
400  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
401  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
402  BLAZE_INTERNAL_ASSERT( A.rows() == (~lhs).size() , "Invalid vector size" );
403 
404  // Performing the dense matrix-sparse vector multiplication
405  smpAddAssign( ~lhs, A * x );
406  }
408  //**********************************************************************************************
409 
410  //**Addition assignment to sparse vectors*******************************************************
411  // No special implementation for the addition assignment to sparse vectors.
412  //**********************************************************************************************
413 
414  //**Subtraction assignment to dense vectors*****************************************************
430  template< typename VT1 > // Type of the target dense vector
431  friend inline typename EnableIf< UseAssign<VT1> >::Type
432  subAssign( DenseVector<VT1,false>& lhs, const DMatSVecMultExpr& rhs )
433  {
435 
436  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
437 
439 
440  // Evaluation of the right-hand side sparse vector operand
441  RT x( rhs.vec_ );
442  if( x.nonZeros() == 0UL ) return;
443 
444  // Evaluation of the left-hand side dense matrix operand
445  LT A( rhs.mat_ );
446 
447  // Checking the evaluated operands
448  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
449  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
450  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
451  BLAZE_INTERNAL_ASSERT( A.rows() == (~lhs).size() , "Invalid vector size" );
452 
453  // Performing the dense matrix-sparse vector multiplication
454  smpSubAssign( ~lhs, A * x );
455  }
457  //**********************************************************************************************
458 
459  //**Subtraction assignment to sparse vectors****************************************************
460  // No special implementation for the subtraction assignment to sparse vectors.
461  //**********************************************************************************************
462 
463  //**Multiplication assignment to dense vectors**************************************************
479  template< typename VT1 > // Type of the target dense vector
480  friend inline typename EnableIf< UseAssign<VT1> >::Type
481  multAssign( DenseVector<VT1,false>& lhs, const DMatSVecMultExpr& rhs )
482  {
484 
488 
489  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
490 
491  const ResultType tmp( rhs );
492  smpMultAssign( ~lhs, tmp );
493  }
495  //**********************************************************************************************
496 
497  //**Addition assignment to sparse vectors*******************************************************
498  // No special implementation for the multiplication assignment to sparse vectors.
499  //**********************************************************************************************
500 
501  //**Compile time checks*************************************************************************
508  //**********************************************************************************************
509 };
510 //*************************************************************************************************
511 
512 
513 
514 
515 //=================================================================================================
516 //
517 // GLOBAL BINARY ARITHMETIC OPERATORS
518 //
519 //=================================================================================================
520 
521 //*************************************************************************************************
553 template< typename T1 // Type of the left-hand side dense matrix
554  , typename T2 > // Type of the right-hand side sparse vector
555 inline const typename DisableIf< IsMatMatMultExpr<T1>, DMatSVecMultExpr<T1,T2> >::Type
557 {
559 
560  if( (~mat).columns() != (~vec).size() )
561  throw std::invalid_argument( "Matrix and vector sizes do not match" );
562 
563  return DMatSVecMultExpr<T1,T2>( ~mat, ~vec );
564 }
565 //*************************************************************************************************
566 
567 
568 
569 
570 //=================================================================================================
571 //
572 // GLOBAL RESTRUCTURING BINARY ARITHMETIC OPERATORS
573 //
574 //=================================================================================================
575 
576 //*************************************************************************************************
589 template< typename T1 // Type of the left-hand side dense matrix
590  , bool SO // Storage order of the left-hand side dense matrix
591  , typename T2 > // Type of the right-hand side sparse vector
592 inline const typename EnableIf< IsMatMatMultExpr<T1>, MultExprTrait<T1,T2> >::Type::Type
594 {
596 
597  return (~mat).leftOperand() * ( (~mat).rightOperand() * vec );
598 }
599 //*************************************************************************************************
600 
601 
602 
603 
604 //=================================================================================================
605 //
606 // EXPRESSION TRAIT SPECIALIZATIONS
607 //
608 //=================================================================================================
609 
610 //*************************************************************************************************
612 template< typename MT, typename VT, bool AF >
613 struct SubvectorExprTrait< DMatSVecMultExpr<MT,VT>, AF >
614 {
615  public:
616  //**********************************************************************************************
617  typedef typename MultExprTrait< typename SubmatrixExprTrait<const MT,AF>::Type, VT >::Type Type;
618  //**********************************************************************************************
619 };
621 //*************************************************************************************************
622 
623 } // namespace blaze
624 
625 #endif
bool isAligned() const
Returns whether the operands of the expression are properly aligned in memory.
Definition: DMatSVecMultExpr.h:262
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
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
DMatSVecMultExpr< MT, VT > This
Type of this DMatSVecMultExpr instance.
Definition: DMatSVecMultExpr.h:127
LeftOperand leftOperand() const
Returns the left-hand side dense matrix operand.
Definition: DMatSVecMultExpr.h:218
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
#define BLAZE_CONSTRAINT_MUST_BE_COLUMN_VECTOR_TYPE(T)
Constraint on the data type.In case the given data type T is not a column dense or sparse vector type...
Definition: TransposeFlag.h:159
Efficient implementation of a compressed matrix.The CompressedMatrix class template is the represent...
Definition: CompressedMatrix.h:197
#define BLAZE_CONSTRAINT_MUST_BE_DENSE_MATRIX_TYPE(T)
Constraint on the data type.In case the given data type T is not a dense, N-dimensional matrix type...
Definition: DenseMatrix.h:79
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
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
MultTrait< MRT, VRT >::Type ResultType
Result type for expression template evaluations.
Definition: DMatSVecMultExpr.h:128
Header file for the DenseVector base class.
Header file for the Computation base class.
Header file for the RequiresEvaluation type trait.
LeftOperand mat_
Left-hand side dense matrix of the multiplication expression.
Definition: DMatSVecMultExpr.h:279
VT::ResultType VRT
Result type of the right-hand side sparse vector expression.
Definition: DMatSVecMultExpr.h:99
Base class for dense matrices.The DenseMatrix class is a base class for all dense matrix classes...
Definition: DenseMatrix.h:70
Constraint on the data type.
ResultType::TransposeType TransposeType
Transpose type for expression template evaluations.
Definition: DMatSVecMultExpr.h:129
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
const This & CompositeType
Data type for composite expression templates.
Definition: CompressedMatrix.h:251
MCT LT
Type for the assignment of the left-hand side dense matrix operand.
Definition: DMatSVecMultExpr.h:143
Expression object for dense matrix-sparse vector multiplications.The DMatSVecMultExpr class represent...
Definition: DMatSVecMultExpr.h:92
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.
const Element * ConstIterator
Iterator over constant elements.
Definition: CompressedMatrix.h:2388
Header file for the IsMatMatMultExpr type trait class.
void assign(Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the assignment of a matrix to a matrix.
Definition: Matrix.h:179
RightOperand vec_
Right-hand side sparse vector of the multiplication expression.
Definition: DMatSVecMultExpr.h:280
Base class for N-dimensional dense vectors.The DenseVector class is a base class for all arbitrarily ...
Definition: DenseVector.h:70
#define BLAZE_CONSTRAINT_MUST_BE_SPARSE_VECTOR_TYPE(T)
Constraint on the data type.In case the given data type T is not a sparse, N-dimensional vector type...
Definition: SparseVector.h:79
SelectType< IsExpression< VT >::value, const VT, const VT & >::Type RightOperand
Composite type of the right-hand side dense vector expression.
Definition: DMatSVecMultExpr.h:140
Constraint on the data type.
Base class for all matrix/vector multiplication expression templates.The MatVecMultExpr class serves ...
Definition: MatVecMultExpr.h:66
RightOperand rightOperand() const
Returns the right-hand side sparse vector operand.
Definition: DMatSVecMultExpr.h:228
#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.
void multAssign(Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the multiplication assignment of a matrix to a matrix.
Definition: Matrix.h:269
Header file for the SelectType class template.
Header file for all forward declarations for expression class templates.
Constraint on the data type.
Header file for the EnableIf class template.
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
MT::CompositeType MCT
Composite type of the left-hand side dense matrix expression.
Definition: DMatSVecMultExpr.h:100
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
const size_t SMP_DMATSVECMULT_THRESHOLD
SMP row-major dense matrix/sparse vector multiplication threshold.This threshold represents the syste...
Definition: Thresholds.h:191
size_t size() const
Returns the current size/dimension of the vector.
Definition: DMatSVecMultExpr.h:208
Header file for run time assertion macros.
Base template for the MultTrait class.
Definition: MultTrait.h:141
void addAssign(Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the addition assignment of a matrix to a matrix.
Definition: Matrix.h:209
SelectType< IsExpression< MT >::value, const MT, const MT & >::Type LeftOperand
Composite type of the left-hand side dense matrix expression.
Definition: DMatSVecMultExpr.h:137
Substitution Failure Is Not An Error (SFINAE) class.The EnableIf class template is an auxiliary tool ...
Definition: EnableIf.h:184
ResultType::ElementType ElementType
Resulting element type.
Definition: DMatSVecMultExpr.h:130
Header file for the reset shim.
void subAssign(Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the subtraction assignment of a matrix to matrix.
Definition: Matrix.h:239
bool canAlias(const T *alias) const
Returns whether the expression can alias with the given address alias.
Definition: DMatSVecMultExpr.h:240
Header file for the RemoveReference type trait.
#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
const ElementType ReturnType
Return type for expression template evaluations.
Definition: DMatSVecMultExpr.h:131
Header file for the IsComputation type trait class.
bool isAliased(const T *alias) const
Returns whether the expression is aliased with the given address alias.
Definition: DMatSVecMultExpr.h:252
Base class for all compute expression templates.The Computation class serves as a tag for all computa...
Definition: Computation.h:59
Header file for the sparse vector SMP implementation.
SelectType< IsComputation< VT >::value, const VRT, VCT >::Type RT
Type for the assignment of the right-hand side dense matrix operand.
Definition: DMatSVecMultExpr.h:146
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
size_t columns(const Matrix< MT, SO > &m)
Returns the current number of columns of the matrix.
Definition: Matrix.h:154
Header file for basic type definitions.
Header file for the SubvectorExprTrait class template.
ReturnType operator[](size_t index) const
Subscript operator for the direct access to the vector elements.
Definition: DMatSVecMultExpr.h:177
Header file for the MatVecMultExpr base class.
SelectType< useAssign, const ResultType, const DMatSVecMultExpr & >::Type CompositeType
Data type for composite expression templates.
Definition: DMatSVecMultExpr.h:134
DMatSVecMultExpr(const MT &mat, const VT &vec)
Constructor for the DMatSVecMultExpr class.
Definition: DMatSVecMultExpr.h:163
MT::ResultType MRT
Result type of the left-hand side dense matrix expression.
Definition: DMatSVecMultExpr.h:98
VT::CompositeType VCT
Composite type of the right-hand side sparse vector expression.
Definition: DMatSVecMultExpr.h:101
bool canSMPAssign() const
Returns whether the expression can be used in SMP assignments.
Definition: DMatSVecMultExpr.h:272
Header file for the thresholds for matrix/vector and matrix/matrix multiplications.
#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
Header file for the IsExpression type trait class.
Header file for the FunctionTrace class.