All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TDMatSMatAddExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_TDMATSMATADDEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_TDMATSMATADDEXPR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <stdexcept>
59 #include <blaze/util/Assert.h>
62 #include <blaze/util/SelectType.h>
63 #include <blaze/util/Types.h>
64 
65 
66 namespace blaze {
67 
68 //=================================================================================================
69 //
70 // CLASS TDMATSMATADDEXPR
71 //
72 //=================================================================================================
73 
74 //*************************************************************************************************
81 template< typename MT1 // Type of the left-hand side dense matrix
82  , typename MT2 > // Type of the right-hand side sparse matrix
83 class TDMatSMatAddExpr : public DenseMatrix< TDMatSMatAddExpr<MT1,MT2>, false >
84  , private MatMatAddExpr
85  , private Computation
86 {
87  private:
88  //**Type definitions****************************************************************************
89  typedef typename MT1::ResultType RT1;
90  typedef typename MT2::ResultType RT2;
91  typedef typename MT1::ReturnType RN1;
92  typedef typename MT2::ReturnType RN2;
93  //**********************************************************************************************
94 
95  //**Return type evaluation**********************************************************************
97 
102  enum { returnExpr = !IsTemporary<RN1>::value && !IsTemporary<RN2>::value };
103 
106  //**********************************************************************************************
107 
108  public:
109  //**Type definitions****************************************************************************
115 
118 
120  typedef const ResultType CompositeType;
121 
123  typedef typename SelectType< IsExpression<MT1>::value, const MT1, const MT1& >::Type LeftOperand;
124 
126  typedef typename SelectType< IsExpression<MT2>::value, const MT2, const MT2& >::Type RightOperand;
127  //**********************************************************************************************
128 
129  //**Compilation flags***************************************************************************
131  enum { vectorizable = 0 };
132  //**********************************************************************************************
133 
134  //**Constructor*********************************************************************************
140  explicit inline TDMatSMatAddExpr( const MT1& lhs, const MT2& rhs )
141  : lhs_( lhs ) // Left-hand side dense matrix of the addition expression
142  , rhs_( rhs ) // Right-hand side sparse matrix of the addition expression
143  {
144  BLAZE_INTERNAL_ASSERT( lhs.rows() == rhs.rows() , "Invalid number of rows" );
145  BLAZE_INTERNAL_ASSERT( lhs.columns() == rhs.columns(), "Invalid number of columns" );
146  }
147  //**********************************************************************************************
148 
149  //**Access operator*****************************************************************************
156  inline ReturnType operator()( size_t i, size_t j ) const {
157  BLAZE_INTERNAL_ASSERT( i < lhs_.rows() , "Invalid row access index" );
158  BLAZE_INTERNAL_ASSERT( j < lhs_.columns(), "Invalid column access index" );
159  return lhs_(i,j) + rhs_(i,j);
160  }
161  //**********************************************************************************************
162 
163  //**Rows function*******************************************************************************
168  inline size_t rows() const {
169  return lhs_.rows();
170  }
171  //**********************************************************************************************
172 
173  //**Columns function****************************************************************************
178  inline size_t columns() const {
179  return lhs_.columns();
180  }
181  //**********************************************************************************************
182 
183  //**Left operand access*************************************************************************
188  inline LeftOperand leftOperand() const {
189  return lhs_;
190  }
191  //**********************************************************************************************
192 
193  //**Right operand access************************************************************************
198  inline RightOperand rightOperand() const {
199  return rhs_;
200  }
201  //**********************************************************************************************
202 
203  //**********************************************************************************************
209  template< typename T >
210  inline bool canAlias( const T* alias ) const {
211  return ( IsExpression<MT1>::value && lhs_.canAlias( alias ) ) ||
212  ( rhs_.canAlias( alias ) );
213  }
214  //**********************************************************************************************
215 
216  //**********************************************************************************************
222  template< typename T >
223  inline bool isAliased( const T* alias ) const {
224  return ( lhs_.isAliased( alias ) || rhs_.isAliased( alias ) );
225  }
226  //**********************************************************************************************
227 
228  private:
229  //**Member variables****************************************************************************
232  //**********************************************************************************************
233 
234  //**Assignment to dense matrices****************************************************************
246  template< typename MT // Type of the target dense matrix
247  , bool SO2 > // Storage order of the target dense matrix
248  friend inline void assign( DenseMatrix<MT,SO2>& lhs, const TDMatSMatAddExpr& rhs )
249  {
251 
252  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
253  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
254 
255  if( !IsExpression<MT1>::value && (~lhs).isAliased( &rhs.lhs_ ) ) {
256  addAssign( ~lhs, rhs.rhs_ );
257  }
258  else {
259  assign ( ~lhs, rhs.lhs_ );
260  addAssign( ~lhs, rhs.rhs_ );
261  }
262  }
264  //**********************************************************************************************
265 
266  //**Assignment to sparse matrices***************************************************************
278  template< typename MT // Type of the target sparse matrix
279  , bool SO2 > // Storage order of the target sparse matrix
280  friend inline void assign( SparseMatrix<MT,SO2>& lhs, const TDMatSMatAddExpr& rhs )
281  {
283 
284  typedef typename SelectType< SO2, OppositeType, ResultType >::Type TmpType;
285 
292 
293  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
294  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
295 
296  const TmpType tmp( rhs );
297  assign( ~lhs, tmp );
298  }
300  //**********************************************************************************************
301 
302  //**Addition assignment to dense matrices*******************************************************
315  template< typename MT // Type of the target dense matrix
316  , bool SO2 > // Storage order of the target dense matrix
317  friend inline void addAssign( DenseMatrix<MT,SO2>& lhs, const TDMatSMatAddExpr& rhs )
318  {
320 
321  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
322  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
323 
324  addAssign( ~lhs, rhs.lhs_ );
325  addAssign( ~lhs, rhs.rhs_ );
326  }
328  //**********************************************************************************************
329 
330  //**Addition assignment to sparse matrices******************************************************
331  // No special implementation for the addition assignment to sparse matrices.
332  //**********************************************************************************************
333 
334  //**Subtraction assignment to dense matrices****************************************************
347  template< typename MT // Type of the target dense matrix
348  , bool SO2 > // Storage order of the target dense matrix
349  friend inline void subAssign( DenseMatrix<MT,SO2>& lhs, const TDMatSMatAddExpr& rhs )
350  {
352 
353  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
354  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
355 
356  subAssign( ~lhs, rhs.lhs_ );
357  subAssign( ~lhs, rhs.rhs_ );
358  }
360  //**********************************************************************************************
361 
362  //**Subtraction assignment to sparse matrices***************************************************
363  // No special implementation for the subtraction assignment to sparse matrices.
364  //**********************************************************************************************
365 
366  //**Multiplication assignment to dense matrices*************************************************
367  // No special implementation for the multiplication assignment to dense matrices.
368  //**********************************************************************************************
369 
370  //**Multiplication assignment to sparse matrices************************************************
371  // No special implementation for the multiplication assignment to sparse matrices.
372  //**********************************************************************************************
373 
374  //**Compile time checks*************************************************************************
381  //**********************************************************************************************
382 };
383 //*************************************************************************************************
384 
385 
386 
387 
388 //=================================================================================================
389 //
390 // GLOBAL BINARY ARITHMETIC OPERATORS
391 //
392 //=================================================================================================
393 
394 //*************************************************************************************************
425 template< typename T1 // Type of the left-hand side dense matrix
426  , typename T2 > // Type of the right-hand side sparse matrix
427 const TDMatSMatAddExpr<T1,T2>
429 {
431 
432  if( (~lhs).rows() != (~rhs).rows() || (~lhs).columns() != (~rhs).columns() )
433  throw std::invalid_argument( "Matrix sizes do not match" );
434 
435  return TDMatSMatAddExpr<T1,T2>( ~lhs, ~rhs );
436 }
437 //*************************************************************************************************
438 
439 
440 //*************************************************************************************************
471 template< typename T1 // Type of the left-hand side dense matrix
472  , typename T2 > // Type of the right-hand side sparse matrix
473 const TDMatSMatAddExpr<T1,T2>
475 {
477 
478  if( (~lhs).rows() != (~rhs).rows() || (~lhs).columns() != (~rhs).columns() )
479  throw std::invalid_argument( "Matrix sizes do not match" );
480 
481  return TDMatSMatAddExpr<T1,T2>( ~rhs, ~lhs );
482 }
483 //*************************************************************************************************
484 
485 
486 
487 
488 //=================================================================================================
489 //
490 // GLOBAL RESTRUCTURING BINARY ARITHMETIC OPERATORS
491 //
492 //=================================================================================================
493 
494 //*************************************************************************************************
507 template< typename T1 // Type of the dense matrix of the left-hand side expression
508  , typename T2 // Type of the sparse matrix of the left-hand side expression
509  , typename T3 // Type of the right-hand side dense matrix
510  , bool SO > // Storage order of the right-hand side dense matrix
511 inline const typename AddExprTrait< TDMatSMatAddExpr<T1,T2>, T3 >::Type
512  operator+( const TDMatSMatAddExpr<T1,T2>& lhs, const DenseMatrix<T3,SO>& rhs )
513 {
515 
516  return ( lhs.leftOperand() + (~rhs) ) + lhs.rightOperand();
517 }
519 //*************************************************************************************************
520 
521 
522 //*************************************************************************************************
535 template< typename T1 // Type of the dense matrix of the left-hand side expression
536  , typename T2 // Type of the sparse matrix of the left-hand side expression
537  , typename T3 // Type of the right-hand side dense matrix
538  , bool SO > // Storage order of the right-hand side dense matrix
539 inline const typename SubExprTrait< TDMatSMatAddExpr<T1,T2>, T3 >::Type
540  operator-( const TDMatSMatAddExpr<T1,T2>& lhs, const DenseMatrix<T3,SO>& rhs )
541 {
543 
544  return ( lhs.leftOperand() - (~rhs) ) + lhs.rightOperand();
545 }
547 //*************************************************************************************************
548 
549 
550 
551 
552 //=================================================================================================
553 //
554 // EXPRESSION TRAIT SPECIALIZATIONS
555 //
556 //=================================================================================================
557 
558 //*************************************************************************************************
560 template< typename MT1, typename MT2, typename MT3 >
561 struct DMatDMatAddExprTrait< TDMatSMatAddExpr<MT1,MT2>, MT3 >
562 {
563  public:
564  //**********************************************************************************************
566  typedef typename SelectType< IsDenseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
567  IsSparseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
568  IsDenseMatrix<MT3>::value && IsRowMajorMatrix<MT3>::value
569  , typename DMatSMatAddExprTrait< typename TDMatDMatAddExprTrait<MT1,MT3>::Type, MT2 >::Type
570  , INVALID_TYPE >::Type Type;
572  //**********************************************************************************************
573 };
575 //*************************************************************************************************
576 
577 
578 //*************************************************************************************************
580 template< typename MT1, typename MT2, typename MT3 >
581 struct DMatTDMatAddExprTrait< TDMatSMatAddExpr<MT1,MT2>, MT3 >
582 {
583  public:
584  //**********************************************************************************************
586  typedef typename SelectType< IsDenseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
587  IsSparseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
588  IsDenseMatrix<MT3>::value && IsColumnMajorMatrix<MT3>::value
589  , typename TDMatSMatAddExprTrait< typename TDMatTDMatAddExprTrait<MT1,MT3>::Type, MT2 >::Type
590  , INVALID_TYPE >::Type Type;
592  //**********************************************************************************************
593 };
595 //*************************************************************************************************
596 
597 
598 //*************************************************************************************************
600 template< typename MT1, typename MT2, typename MT3 >
601 struct DMatDMatSubExprTrait< TDMatSMatAddExpr<MT1,MT2>, MT3 >
602 {
603  public:
604  //**********************************************************************************************
606  typedef typename SelectType< IsDenseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
607  IsSparseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
608  IsDenseMatrix<MT3>::value && IsRowMajorMatrix<MT3>::value
609  , typename DMatSMatAddExprTrait< typename TDMatDMatSubExprTrait<MT1,MT3>::Type, MT2 >::Type
610  , INVALID_TYPE >::Type Type;
612  //**********************************************************************************************
613 };
615 //*************************************************************************************************
616 
617 
618 //*************************************************************************************************
620 template< typename MT1, typename MT2, typename MT3 >
621 struct DMatTDMatSubExprTrait< TDMatSMatAddExpr<MT1,MT2>, MT3 >
622 {
623  public:
624  //**********************************************************************************************
626  typedef typename SelectType< IsDenseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
627  IsSparseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
628  IsDenseMatrix<MT3>::value && IsColumnMajorMatrix<MT3>::value
629  , typename TDMatSMatAddExprTrait< typename TDMatTDMatSubExprTrait<MT1,MT3>::Type, MT2 >::Type
630  , INVALID_TYPE >::Type Type;
632  //**********************************************************************************************
633 };
635 //*************************************************************************************************
636 
637 
638 //*************************************************************************************************
640 template< typename MT1, typename MT2 >
641 struct SubmatrixExprTrait< TDMatSMatAddExpr<MT1,MT2> >
642 {
643  public:
644  //**********************************************************************************************
645  typedef typename AddExprTrait< typename SubmatrixExprTrait<const MT1>::Type
646  , typename SubmatrixExprTrait<const MT2>::Type >::Type Type;
647  //**********************************************************************************************
648 };
650 //*************************************************************************************************
651 
652 
653 //*************************************************************************************************
655 template< typename MT1, typename MT2 >
656 struct RowExprTrait< TDMatSMatAddExpr<MT1,MT2> >
657 {
658  public:
659  //**********************************************************************************************
660  typedef typename AddExprTrait< typename RowExprTrait<const MT1>::Type
661  , typename RowExprTrait<const MT2>::Type >::Type Type;
662  //**********************************************************************************************
663 };
665 //*************************************************************************************************
666 
667 
668 //*************************************************************************************************
670 template< typename MT1, typename MT2 >
671 struct ColumnExprTrait< TDMatSMatAddExpr<MT1,MT2> >
672 {
673  public:
674  //**********************************************************************************************
675  typedef typename AddExprTrait< typename ColumnExprTrait<const MT1>::Type
676  , typename ColumnExprTrait<const MT2>::Type >::Type Type;
677  //**********************************************************************************************
678 };
680 //*************************************************************************************************
681 
682 } // namespace blaze
683 
684 #endif
Evaluation of the return type of an addition expression.Via this type trait it is possible to evaluat...
Definition: AddExprTrait.h:103
Compile time check whether the given type is a temporary vector or matrix type.This type trait class ...
Definition: IsTemporary.h:87
MT2::ResultType RT2
Result type of the right-hand side sparse matrix expression.
Definition: TDMatSMatAddExpr.h:90
size_t columns() const
Returns the current number of columns of the matrix.
Definition: TDMatSMatAddExpr.h:178
MT1::ReturnType RN1
Return type of the left-hand side dense matrix expression.
Definition: TDMatSMatAddExpr.h:91
LeftOperand leftOperand() const
Returns the left-hand side transpose dense matrix operand.
Definition: TDMatSMatAddExpr.h:188
Efficient implementation of a compressed matrix.The CompressedMatrix class template is the represent...
Definition: CompressedMatrix.h:196
#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
Header file for the ColumnExprTrait class template.
bool isAliased(const T *alias) const
Returns whether the expression is aliased with the given address alias.
Definition: TDMatSMatAddExpr.h:223
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 AddExprTrait class template.
LeftOperand lhs_
Left-hand side dense matrix of the addition expression.
Definition: TDMatSMatAddExpr.h:230
Header file for the Computation base class.
RightOperand rhs_
Right-hand side sparse matrix of the addition expression.
Definition: TDMatSMatAddExpr.h:231
ReturnType operator()(size_t i, size_t j) const
2D-access to the matrix elements.
Definition: TDMatSMatAddExpr.h:156
TDMatSMatAddExpr(const MT1 &lhs, const MT2 &rhs)
Constructor for the TDMatSMatAddExpr class.
Definition: TDMatSMatAddExpr.h:140
Base class for dense matrices.The DenseMatrix class is a base class for all dense matrix classes...
Definition: DenseMatrix.h:70
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.
ResultType::OppositeType OppositeType
Result type with opposite storage order for expression template evaluations.
Definition: TDMatSMatAddExpr.h:112
SelectType< IsExpression< MT2 >::value, const MT2, const MT2 & >::Type RightOperand
Composite type of the right-hand side sparse matrix expression.
Definition: TDMatSMatAddExpr.h:126
Constraint on the data type.
Constraint on the data type.
MT1::ResultType RT1
Result type of the left-hand side dense matrix expression.
Definition: TDMatSMatAddExpr.h:89
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 IsTemporary type trait class.
#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 SelectType< returnExpr, ExprReturnType, ElementType >::Type ReturnType
Return type for expression template evaluations.
Definition: TDMatSMatAddExpr.h:117
Header file for the DenseMatrix base 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
const DenseIterator< Type > operator+(const DenseIterator< Type > &it, ptrdiff_t inc)
Addition between a DenseIterator and an integral value.
Definition: DenseIterator.h:556
#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.
Header file for the SelectType class template.
Header file for the RowExprTrait class template.
Header file for all forward declarations for expression class templates.
AddTrait< RT1, RT2 >::Type ResultType
Result type for expression template evaluations.
Definition: TDMatSMatAddExpr.h:111
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
const Type & ReturnType
Return type for expression template evaluations.
Definition: CompressedMatrix.h:2374
Header file for run time assertion macros.
Base template for the AddTrait class.
Definition: AddTrait.h:141
Header file for the addition trait.
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
AddExprTrait< RN1, RN2 >::Type ExprReturnType
Expression return type for the subscript operator.
Definition: TDMatSMatAddExpr.h:105
const DenseIterator< Type > operator-(const DenseIterator< Type > &it, ptrdiff_t inc)
Subtraction between a DenseIterator and an integral value.
Definition: DenseIterator.h:585
const ResultType CompositeType
Data type for composite expression templates.
Definition: TDMatSMatAddExpr.h:120
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
Header file for the MatMatAddExpr base class.
#define BLAZE_CONSTRAINT_MATRICES_MUST_HAVE_SAME_STORAGE_ORDER(T1, T2)
Constraint on the data type.In case either of the two given data types T1 or T2 is not a matrix type ...
Definition: StorageOrder.h:283
ResultType::TransposeType TransposeType
Transpose type for expression template evaluations.
Definition: TDMatSMatAddExpr.h:113
size_t rows() const
Returns the current number of rows of the matrix.
Definition: TDMatSMatAddExpr.h:168
bool canAlias(const T *alias) const
Returns whether the expression can alias with the given address alias.
Definition: TDMatSMatAddExpr.h:210
RightOperand rightOperand() const
Returns the right-hand side sparse matrix operand.
Definition: TDMatSMatAddExpr.h:198
Expression object for dense matrix-sparse matrix additions.The TDMatSMatAddExpr class represents the ...
Definition: Forward.h:123
#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
TDMatSMatAddExpr< MT1, MT2 > This
Type of this TDMatSMatAddExpr instance.
Definition: TDMatSMatAddExpr.h:110
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.
SelectType< IsExpression< MT1 >::value, const MT1, const MT1 & >::Type LeftOperand
Composite type of the left-hand side dense matrix expression.
Definition: TDMatSMatAddExpr.h:123
MT2::ReturnType RN2
Return type of the right-hand side sparse matrix expression.
Definition: TDMatSMatAddExpr.h:92
Header file for the SubExprTrait class template.
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
Compile time check whether the given type is an expression template.This type trait class tests wheth...
Definition: IsExpression.h:87
ResultType::ElementType ElementType
Resulting element type.
Definition: TDMatSMatAddExpr.h:114
Header file for the IsExpression type trait class.
Header file for the FunctionTrace class.