All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TSVecTDMatMultExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_TSVECTDMATMULTEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_TSVECTDMATMULTEXPR_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 TSVECDMATMULTEXPR
80 //
81 //=================================================================================================
82 
83 //*************************************************************************************************
90 template< typename VT // Type of the left-hand side sparse vector
91  , typename MT > // Type of the right-hand side dense matrix
92 class TSVecTDMatMultExpr : public DenseVector< TSVecTDMatMultExpr<VT,MT>, true >
93  , private TVecMatMultExpr
94  , private Computation
95 {
96  private:
97  //**Type definitions****************************************************************************
98  typedef typename VT::ResultType VRT;
99  typedef typename MT::ResultType MRT;
100  typedef typename VT::CompositeType VCT;
101  typedef typename MT::CompositeType MCT;
102  //**********************************************************************************************
103 
104  //**********************************************************************************************
106 
112  enum { useAssign = ( IsComputation<VT>::value || RequiresEvaluation<MT>::value ) };
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<VT>::value, const VT, const VT& >::Type LeftOperand;
138 
140  typedef typename SelectType< IsExpression<MT>::value, const MT, const MT& >::Type RightOperand;
141 
143  typedef typename SelectType< IsComputation<VT>::value, const VRT, VCT >::Type LT;
144 
146  typedef MCT RT;
147  //**********************************************************************************************
148 
149  //**Compilation flags***************************************************************************
151  enum { vectorizable = 0 };
152 
154  enum { smpAssignable = !useAssign };
155  //**********************************************************************************************
156 
157  //**Constructor*********************************************************************************
163  explicit inline TSVecTDMatMultExpr( const VT& vec, const MT& mat )
164  : vec_( vec ) // Left-hand side sparse vector of the multiplication expression
165  , mat_( mat ) // Right-hand side dense matrix of the multiplication expression
166  {
167  BLAZE_INTERNAL_ASSERT( vec_.size() == mat_.rows(), "Invalid vector and matrix sizes" );
168  }
169  //**********************************************************************************************
170 
171  //**Subscript operator**************************************************************************
177  inline ReturnType operator[]( size_t index ) const {
178  BLAZE_INTERNAL_ASSERT( index < mat_.columns(), "Invalid vector access index" );
179 
181 
182  VCT x( vec_ ); // Evaluation of the left-hand side sparse vector operand
183 
184  BLAZE_INTERNAL_ASSERT( x.size() == vec_.size(), "Invalid vector size" );
185 
186  const ConstIterator end( x.end() );
187  ConstIterator element( x.begin() );
188  ElementType res;
189 
190  if( element != end ) {
191  res = element->value() * mat_( element->index(), index );
192  ++element;
193  for( ; element!=end; ++element )
194  res += element->value() * mat_( element->index(), index );
195  }
196  else {
197  reset( res );
198  }
199 
200  return res;
201  }
202  //**********************************************************************************************
203 
204  //**Size function*******************************************************************************
209  inline size_t size() const {
210  return mat_.columns();
211  }
212  //**********************************************************************************************
213 
214  //**Left operand access*************************************************************************
219  inline LeftOperand leftOperand() const {
220  return vec_;
221  }
222  //**********************************************************************************************
223 
224  //**Right operand access************************************************************************
229  inline RightOperand rightOperand() const {
230  return mat_;
231  }
232  //**********************************************************************************************
233 
234  //**********************************************************************************************
240  template< typename T >
241  inline bool canAlias( const T* alias ) const {
242  return vec_.isAliased( alias ) || mat_.isAliased( alias );
243  }
244  //**********************************************************************************************
245 
246  //**********************************************************************************************
252  template< typename T >
253  inline bool isAliased( const T* alias ) const {
254  return vec_.isAliased( alias ) || mat_.isAliased( alias );
255  }
256  //**********************************************************************************************
257 
258  //**********************************************************************************************
263  inline bool isAligned() const {
264  return mat_.isAligned();
265  }
266  //**********************************************************************************************
267 
268  //**********************************************************************************************
273  inline bool canSMPAssign() const {
274  return ( size() > SMP_TSVECTDMATMULT_THRESHOLD );
275  }
276  //**********************************************************************************************
277 
278  private:
279  //**Member variables****************************************************************************
280  LeftOperand vec_;
281  RightOperand mat_;
282  //**********************************************************************************************
283 
284  //**Assignment to dense vectors*****************************************************************
300  template< typename VT2 > // Type of the target dense vector
301  friend inline typename EnableIf< UseAssign<VT2> >::Type
303  {
305 
306  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
307 
309 
310  // Evaluation of the left-hand side sparse vector operand
311  LT x( rhs.vec_ );
312  if( x.nonZeros() == 0UL ) {
313  reset( ~lhs );
314  return;
315  }
316 
317  // Evaluation of the right-hand side dense matrix operand
318  RT A( rhs.mat_ );
319 
320  // Checking the evaluated operands
321  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
322  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
323  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
324  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).size() , "Invalid vector size" );
325 
326  // Performing the sparse vector-dense matrix multiplication
327  smpAssign( ~lhs, x * A );
328  }
330  //**********************************************************************************************
331 
332  //**Assignment to sparse vectors****************************************************************
345  template< typename VT2 > // Type of the target sparse vector
346  friend inline typename EnableIf< UseAssign<VT2> >::Type
348  {
350 
354 
355  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
356 
357  const ResultType tmp( rhs );
358  smpAssign( ~lhs, tmp );
359  }
361  //**********************************************************************************************
362 
363  //**Addition assignment to dense vectors********************************************************
375  template< typename VT2 > // Type of the target dense vector
376  friend inline typename EnableIf< UseAssign<VT2> >::Type
378  {
380 
381  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
382 
384 
385  // Evaluation of the left-hand side sparse vector operand
386  LT x( rhs.vec_ );
387  if( x.nonZeros() == 0UL ) return;
388 
389  // Evaluation of the right-hand side dense matrix operand
390  RT A( rhs.mat_ );
391 
392  // Checking the evaluated operands
393  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
394  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
395  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
396  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).size() , "Invalid vector size" );
397 
398  // Performing the sparse vector-dense matrix multiplication
399  smpAddAssign( ~lhs, x * A );
400  }
401  //**********************************************************************************************
402 
403  //**Addition assignment to sparse vectors*******************************************************
404  // No special implementation for the addition assignment to sparse vectors.
405  //**********************************************************************************************
406 
407  //**Subtraction assignment to dense vectors*****************************************************
419  template< typename VT2 > // Type of the target dense vector
420  friend inline typename EnableIf< UseAssign<VT2> >::Type
422  {
424 
425  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
426 
428 
429  // Evaluation of the left-hand side sparse vector operand
430  LT x( rhs.vec_ );
431  if( x.nonZeros() == 0UL ) return;
432 
433  // Evaluation of the right-hand side dense matrix operand
434  RT A( rhs.mat_ );
435 
436  // Checking the evaluated operands
437  BLAZE_INTERNAL_ASSERT( x.size() == rhs.vec_.size() , "Invalid vector size" );
438  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.mat_.rows() , "Invalid number of rows" );
439  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.mat_.columns(), "Invalid number of columns" );
440  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).size() , "Invalid vector size" );
441 
442  // Performing the sparse vector-dense matrix multiplication
443  smpSubAssign( ~lhs, x * A );
444  }
445  //**********************************************************************************************
446 
447  //**Subtraction assignment to sparse vectors****************************************************
448  // No special implementation for the subtraction assignment to sparse vectors.
449  //**********************************************************************************************
450 
451  //**Multiplication assignment to dense vectors**************************************************
463  template< typename VT2 > // Type of the target dense vector
464  friend inline typename EnableIf< UseAssign<VT2> >::Type
466  {
468 
472 
473  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
474 
475  const ResultType tmp( rhs );
476  smpMultAssign( ~lhs, tmp );
477  }
478  //**********************************************************************************************
479 
480  //**Multiplication assignment to sparse vectors*************************************************
481  // No special implementation for the multiplication assignment to sparse vectors.
482  //**********************************************************************************************
483 
484  //**Compile time checks*************************************************************************
491  //**********************************************************************************************
492 };
493 //*************************************************************************************************
494 
495 
496 
497 
498 //=================================================================================================
499 //
500 // GLOBAL BINARY ARITHMETIC OPERATORS
501 //
502 //=================================================================================================
503 
504 //*************************************************************************************************
535 template< typename T1, typename T2 >
536 inline const typename DisableIf< IsMatMatMultExpr<T2>, TSVecTDMatMultExpr<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 TSVecTDMatMultExpr<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< TSVecTDMatMultExpr<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
Compile time check whether the given type is a computational expression template.This type trait clas...
Definition: IsComputation.h:89
bool isAligned() const
Returns whether the operands of the expression are properly aligned in memory.
Definition: TSVecTDMatMultExpr.h:263
void reset(DynamicMatrix< Type, SO > &m)
Resetting the given dense matrix.
Definition: DynamicMatrix.h:4579
bool canAlias(const T *alias) const
Returns whether the expression can alias with the given address alias.
Definition: TSVecTDMatMultExpr.h:241
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
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
#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
SelectType< IsExpression< MT >::value, const MT, const MT & >::Type RightOperand
Composite type of the right-hand side sparse matrix expression.
Definition: TSVecTDMatMultExpr.h:140
MT::ResultType MRT
Result type of the right-hand side dense matrix expression.
Definition: TSVecTDMatMultExpr.h:99
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.
ResultType::ElementType ElementType
Resulting element type.
Definition: TSVecTDMatMultExpr.h:130
Header file for the Computation base class.
Header file for the RequiresEvaluation type trait.
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.
VT::ResultType VRT
Result type of the left-hand side sparse vector expression.
Definition: TSVecTDMatMultExpr.h:98
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
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.
RightOperand rightOperand() const
Returns the right-hand side transpose dense matrix operand.
Definition: TSVecTDMatMultExpr.h:229
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
VT::CompositeType VCT
Composite type of the left-hand side sparse vector expression.
Definition: TSVecTDMatMultExpr.h:100
const Element * ConstIterator
Iterator over constant elements.
Definition: CompressedMatrix.h:2388
MultTrait< VRT, MRT >::Type ResultType
Result type for expression template evaluations.
Definition: TSVecTDMatMultExpr.h:128
friend EnableIf< UseAssign< VT2 > >::Type multAssign(DenseVector< VT2, true > &lhs, const TSVecTDMatMultExpr &rhs)
Multiplication assignment of a transpose sparse vector-transpose dense matrix multiplication to a den...
Definition: TSVecTDMatMultExpr.h:465
Header file for the IsMatMatMultExpr type trait class.
LeftOperand vec_
Left-hand side sparse vector of the multiplication expression.
Definition: TSVecTDMatMultExpr.h:280
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
LeftOperand leftOperand() const
Returns the left-hand side sparse vector operand.
Definition: TSVecTDMatMultExpr.h:219
SelectType< useAssign, const ResultType, const TSVecTDMatMultExpr & >::Type CompositeType
Data type for composite expression templates.
Definition: TSVecTDMatMultExpr.h:134
const ElementType ReturnType
Return type for expression template evaluations.
Definition: TSVecTDMatMultExpr.h:131
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< IsComputation< VT >::value, const VRT, VCT >::Type LT
Type for the assignment of the left-hand side sparse vector operand.
Definition: TSVecTDMatMultExpr.h:143
bool isAliased(const T *alias) const
Returns whether the expression is aliased with the given address alias.
Definition: TSVecTDMatMultExpr.h:253
Constraint on the data type.
const size_t SMP_TSVECTDMATMULT_THRESHOLD
SMP sparse vector/column-major dense matrix multiplication threshold.This threshold represents the sy...
Definition: Thresholds.h:230
#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.
ResultType::TransposeType TransposeType
Transpose type for expression template evaluations.
Definition: TSVecTDMatMultExpr.h:129
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.
RightOperand mat_
Right-hand side dense matrix of the multiplication expression.
Definition: TSVecTDMatMultExpr.h:281
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
SelectType< IsExpression< VT >::value, const VT, const VT & >::Type LeftOperand
Composite type of the left-hand side sparse vector expression.
Definition: TSVecTDMatMultExpr.h:137
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.
friend EnableIf< UseAssign< VT2 > >::Type subAssign(DenseVector< VT2, true > &lhs, const TSVecTDMatMultExpr &rhs)
Subtraction assignment of a transpose sparse vector-transpose dense matrix multiplication to a dense ...
Definition: TSVecTDMatMultExpr.h:421
friend EnableIf< UseAssign< VT2 > >::Type addAssign(DenseVector< VT2, true > &lhs, const TSVecTDMatMultExpr &rhs)
Addition assignment of a transpose sparse vector-transpose dense matrix multiplication to a dense vec...
Definition: TSVecTDMatMultExpr.h:377
Base template for the MultTrait class.
Definition: MultTrait.h:141
MT::CompositeType MCT
Composite type of the right-hand side dense matrix expression.
Definition: TSVecTDMatMultExpr.h:101
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.
TSVecTDMatMultExpr(const VT &vec, const MT &mat)
Constructor for the TSVecTDMatMultExpr class.
Definition: TSVecTDMatMultExpr.h:163
bool canSMPAssign() const
Returns whether the expression can be used in SMP assignments.
Definition: TSVecTDMatMultExpr.h:273
Header file for the RemoveReference type trait.
MCT RT
Type for the assignment of the left-hand side dense matrix operand.
Definition: TSVecTDMatMultExpr.h:146
Expression object for transpose sparse vector-transpose dense matrix multiplications.The TSVecTDMatMultExpr class represents the compile time expression for multiplications between transpose sparse vectors and column-major dense matrices.
Definition: Forward.h:145
#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
TSVecTDMatMultExpr< VT, MT > This
Type of this TSVecTDMatMultExpr instance.
Definition: TSVecTDMatMultExpr.h:127
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
size_t size() const
Returns the current size/dimension of the vector.
Definition: TSVecTDMatMultExpr.h:209
ReturnType operator[](size_t index) const
Subscript operator for the direct access to the vector elements.
Definition: TSVecTDMatMultExpr.h:177
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 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
Header file for the IsExpression type trait class.
Header file for the FunctionTrace class.