All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
DMatTSMatSubExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_DMATTSMATSUBEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_DMATTSMATSUBEXPR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <stdexcept>
63 #include <blaze/util/Assert.h>
66 #include <blaze/util/SelectType.h>
67 #include <blaze/util/Types.h>
68 
69 
70 namespace blaze {
71 
72 //=================================================================================================
73 //
74 // CLASS DMATTSMATSUBEXPR
75 //
76 //=================================================================================================
77 
78 //*************************************************************************************************
85 template< typename MT1 // Type of the left-hand side dense matrix
86  , typename MT2 > // Type of the right-hand side sparse matrix
87 class DMatTSMatSubExpr : public DenseMatrix< DMatTSMatSubExpr<MT1,MT2>, false >
88  , private MatMatSubExpr
89  , private Computation
90 {
91  private:
92  //**Type definitions****************************************************************************
93  typedef typename MT1::ResultType RT1;
94  typedef typename MT2::ResultType RT2;
95  typedef typename MT1::ReturnType RN1;
96  typedef typename MT2::ReturnType RN2;
97  //**********************************************************************************************
98 
99  //**Return type evaluation**********************************************************************
101 
106  enum { returnExpr = !IsTemporary<RN1>::value && !IsTemporary<RN2>::value };
107 
110  //**********************************************************************************************
111 
112  public:
113  //**Type definitions****************************************************************************
119 
122 
124  typedef const ResultType CompositeType;
125 
127  typedef typename SelectType< IsExpression<MT1>::value, const MT1, const MT1& >::Type LeftOperand;
128 
130  typedef typename SelectType< IsExpression<MT2>::value, const MT2, const MT2& >::Type RightOperand;
131  //**********************************************************************************************
132 
133  //**Compilation flags***************************************************************************
135  enum { vectorizable = 0 };
136  //**********************************************************************************************
137 
138  //**Constructor*********************************************************************************
144  explicit inline DMatTSMatSubExpr( const MT1& lhs, const MT2& rhs )
145  : lhs_( lhs ) // Left-hand side dense matrix of the subtraction expression
146  , rhs_( rhs ) // Right-hand side sparse matrix of the subtraction expression
147  {
148  BLAZE_INTERNAL_ASSERT( lhs.rows() == rhs.rows() , "Invalid number of rows" );
149  BLAZE_INTERNAL_ASSERT( lhs.columns() == rhs.columns(), "Invalid number of columns" );
150  }
151  //**********************************************************************************************
152 
153  //**Access operator*****************************************************************************
160  inline ReturnType operator()( size_t i, size_t j ) const {
161  BLAZE_INTERNAL_ASSERT( i < lhs_.rows() , "Invalid row access index" );
162  BLAZE_INTERNAL_ASSERT( j < lhs_.columns(), "Invalid column access index" );
163  return lhs_(i,j) - rhs_(i,j);
164  }
165  //**********************************************************************************************
166 
167  //**Rows function*******************************************************************************
172  inline size_t rows() const {
173  return lhs_.rows();
174  }
175  //**********************************************************************************************
176 
177  //**Columns function****************************************************************************
182  inline size_t columns() const {
183  return lhs_.columns();
184  }
185  //**********************************************************************************************
186 
187  //**Left operand access*************************************************************************
192  inline LeftOperand leftOperand() const {
193  return lhs_;
194  }
195  //**********************************************************************************************
196 
197  //**Right operand access************************************************************************
202  inline RightOperand rightOperand() const {
203  return rhs_;
204  }
205  //**********************************************************************************************
206 
207  //**********************************************************************************************
213  template< typename T >
214  inline bool canAlias( const T* alias ) const {
215  return ( IsExpression<MT1>::value && lhs_.canAlias( alias ) ) ||
216  ( rhs_.canAlias( alias ) );
217  }
218  //**********************************************************************************************
219 
220  //**********************************************************************************************
226  template< typename T >
227  inline bool isAliased( const T* alias ) const {
228  return ( lhs_.isAliased( alias ) || rhs_.isAliased( alias ) );
229  }
230  //**********************************************************************************************
231 
232  private:
233  //**Member variables****************************************************************************
236  //**********************************************************************************************
237 
238  //**Assignment to dense matrices****************************************************************
250  template< typename MT // Type of the target dense matrix
251  , bool SO2 > // Storage order of the target dense matrix
252  friend inline void assign( DenseMatrix<MT,SO2>& lhs, const DMatTSMatSubExpr& rhs )
253  {
255 
256  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
257  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
258 
259  if( !IsExpression<MT1>::value && (~lhs).isAliased( &rhs.lhs_ ) ) {
260  subAssign( ~lhs, rhs.rhs_ );
261  }
262  else {
263  assign ( ~lhs, rhs.lhs_ );
264  subAssign( ~lhs, rhs.rhs_ );
265  }
266  }
268  //**********************************************************************************************
269 
270  //**Assignment to sparse matrices***************************************************************
282  template< typename MT // Type of the target sparse matrix
283  , bool SO2 > // Storage order of the target sparse matrix
284  friend inline void assign( SparseMatrix<MT,SO2>& lhs, const DMatTSMatSubExpr& rhs )
285  {
287 
288  typedef typename SelectType< SO2, OppositeType, ResultType >::Type TmpType;
289 
296 
297  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
298  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
299 
300  const TmpType tmp( rhs );
301  assign( ~lhs, tmp );
302  }
304  //**********************************************************************************************
305 
306  //**Addition assignment to dense matrices*******************************************************
319  template< typename MT // Type of the target dense matrix
320  , bool SO2 > // Storage order of the target dense matrix
321  friend inline void addAssign( DenseMatrix<MT,SO2>& lhs, const DMatTSMatSubExpr& rhs )
322  {
324 
325  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
326  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
327 
328  addAssign( ~lhs, rhs.lhs_ );
329  subAssign( ~lhs, rhs.rhs_ );
330  }
332  //**********************************************************************************************
333 
334  //**Addition assignment to sparse matrices******************************************************
335  // No special implementation for the addition assignment to sparse matrices.
336  //**********************************************************************************************
337 
338  //**Subtraction assignment to dense matrices****************************************************
351  template< typename MT // Type of the target dense matrix
352  , bool SO2 > // Storage order of the target dense matrix
353  friend inline void subAssign( DenseMatrix<MT,SO2>& lhs, const DMatTSMatSubExpr& rhs )
354  {
356 
357  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
358  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
359 
360  subAssign( ~lhs, rhs.lhs_ );
361  addAssign( ~lhs, rhs.rhs_ );
362  }
364  //**********************************************************************************************
365 
366  //**Subtraction assignment to sparse matrices***************************************************
367  // No special implementation for the subtraction assignment to sparse matrices.
368  //**********************************************************************************************
369 
370  //**Multiplication assignment to dense matrices*************************************************
371  // No special implementation for the multiplication assignment to dense matrices.
372  //**********************************************************************************************
373 
374  //**Multiplication assignment to sparse matrices************************************************
375  // No special implementation for the multiplication assignment to sparse matrices.
376  //**********************************************************************************************
377 
378  //**Compile time checks*************************************************************************
385  //**********************************************************************************************
386 };
387 //*************************************************************************************************
388 
389 
390 
391 
392 //=================================================================================================
393 //
394 // GLOBAL BINARY ARITHMETIC OPERATORS
395 //
396 //=================================================================================================
397 
398 //*************************************************************************************************
428 template< typename T1 // Type of the left-hand side dense matrix
429  , typename T2 > // Type of the right-hand side sparse matrix
430 inline const DMatTSMatSubExpr<T1,T2>
432 {
434 
435  if( (~lhs).rows() != (~rhs).rows() || (~lhs).columns() != (~rhs).columns() )
436  throw std::invalid_argument( "Matrix sizes do not match" );
437 
438  return DMatTSMatSubExpr<T1,T2>( ~lhs, ~rhs );
439 }
440 //*************************************************************************************************
441 
442 
443 
444 
445 //=================================================================================================
446 //
447 // GLOBAL RESTRUCTURING BINARY ARITHMETIC OPERATORS
448 //
449 //=================================================================================================
450 
451 //*************************************************************************************************
464 template< typename T1 // Type of the dense matrix of the left-hand side expression
465  , typename T2 // Type of the sparse matrix of the left-hand side expression
466  , typename T3 // Type of the right-hand side dense matrix
467  , bool SO > // Storage order of the right-hand side dense matrix
468 inline const typename AddExprTrait< DMatTSMatSubExpr<T1,T2>, T3 >::Type
469  operator+( const DMatTSMatSubExpr<T1,T2>& lhs, const DenseMatrix<T3,SO>& rhs )
470 {
472 
473  return ( lhs.leftOperand() + (~rhs) ) - lhs.rightOperand();
474 }
476 //*************************************************************************************************
477 
478 
479 //*************************************************************************************************
492 template< typename T1 // Type of the dense matrix of the left-hand side expression
493  , typename T2 // Type of the sparse matrix of the left-hand side expression
494  , typename T3 // Type of the right-hand side dense matrix
495  , bool SO > // Storage order of the right-hand side dense matrix
496 inline const typename SubExprTrait< DMatTSMatSubExpr<T1,T2>, T3 >::Type
497  operator-( const DMatTSMatSubExpr<T1,T2>& lhs, const DenseMatrix<T3,SO>& rhs )
498 {
500 
501  return ( lhs.leftOperand() - (~rhs) ) - lhs.rightOperand();
502 }
504 //*************************************************************************************************
505 
506 
507 
508 
509 //=================================================================================================
510 //
511 // EXPRESSION TRAIT SPECIALIZATIONS
512 //
513 //=================================================================================================
514 
515 //*************************************************************************************************
517 template< typename MT1, typename MT2, typename MT3 >
518 struct DMatDMatAddExprTrait< DMatTSMatSubExpr<MT1,MT2>, MT3 >
519 {
520  public:
521  //**********************************************************************************************
523  typedef typename SelectType< IsDenseMatrix<MT1>::value && IsRowMajorMatrix<MT1>::value &&
524  IsSparseMatrix<MT2>::value && IsColumnMajorMatrix<MT2>::value &&
525  IsDenseMatrix<MT3>::value && IsRowMajorMatrix<MT3>::value
526  , typename DMatTSMatSubExprTrait< typename DMatDMatAddExprTrait<MT1,MT3>::Type, MT2 >::Type
527  , INVALID_TYPE >::Type Type;
529  //**********************************************************************************************
530 };
532 //*************************************************************************************************
533 
534 
535 //*************************************************************************************************
537 template< typename MT1, typename MT2, typename MT3 >
538 struct DMatTDMatAddExprTrait< DMatTSMatSubExpr<MT1,MT2>, MT3 >
539 {
540  public:
541  //**********************************************************************************************
543  typedef typename SelectType< IsDenseMatrix<MT1>::value && IsRowMajorMatrix<MT1>::value &&
544  IsSparseMatrix<MT2>::value && IsColumnMajorMatrix<MT2>::value &&
545  IsDenseMatrix<MT3>::value && IsColumnMajorMatrix<MT3>::value
546  , typename DMatTSMatSubExprTrait< typename DMatTDMatAddExprTrait<MT1,MT3>::Type, MT2 >::Type
547  , INVALID_TYPE >::Type Type;
549  //**********************************************************************************************
550 };
552 //*************************************************************************************************
553 
554 
555 //*************************************************************************************************
557 template< typename MT1, typename MT2, typename MT3 >
558 struct DMatDMatSubExprTrait< DMatTSMatSubExpr<MT1,MT2>, MT3 >
559 {
560  public:
561  //**********************************************************************************************
563  typedef typename SelectType< IsDenseMatrix<MT1>::value && IsRowMajorMatrix<MT1>::value &&
564  IsSparseMatrix<MT2>::value && IsColumnMajorMatrix<MT2>::value &&
565  IsDenseMatrix<MT3>::value && IsRowMajorMatrix<MT3>::value
566  , typename DMatTSMatSubExprTrait< typename DMatDMatSubExprTrait<MT1,MT3>::Type, MT2 >::Type
567  , INVALID_TYPE >::Type Type;
569  //**********************************************************************************************
570 };
572 //*************************************************************************************************
573 
574 
575 //*************************************************************************************************
577 template< typename MT1, typename MT2, typename MT3 >
578 struct DMatTDMatSubExprTrait< DMatTSMatSubExpr<MT1,MT2>, MT3 >
579 {
580  public:
581  //**********************************************************************************************
583  typedef typename SelectType< IsDenseMatrix<MT1>::value && IsRowMajorMatrix<MT1>::value &&
584  IsSparseMatrix<MT2>::value && IsColumnMajorMatrix<MT2>::value &&
585  IsDenseMatrix<MT3>::value && IsColumnMajorMatrix<MT3>::value
586  , typename DMatTSMatSubExprTrait< typename DMatTDMatSubExprTrait<MT1,MT3>::Type, MT2 >::Type
587  , INVALID_TYPE >::Type Type;
589  //**********************************************************************************************
590 };
592 //*************************************************************************************************
593 
594 
595 //*************************************************************************************************
597 template< typename MT1, typename MT2 >
598 struct SubmatrixExprTrait< DMatTSMatSubExpr<MT1,MT2> >
599 {
600  public:
601  //**********************************************************************************************
602  typedef typename SubExprTrait< typename SubmatrixExprTrait<const MT1>::Type
603  , typename SubmatrixExprTrait<const MT2>::Type >::Type Type;
604  //**********************************************************************************************
605 };
607 //*************************************************************************************************
608 
609 
610 //*************************************************************************************************
612 template< typename MT1, typename MT2 >
613 struct RowExprTrait< DMatTSMatSubExpr<MT1,MT2> >
614 {
615  public:
616  //**********************************************************************************************
617  typedef typename SubExprTrait< typename RowExprTrait<const MT1>::Type
618  , typename RowExprTrait<const MT2>::Type >::Type Type;
619  //**********************************************************************************************
620 };
622 //*************************************************************************************************
623 
624 
625 //*************************************************************************************************
627 template< typename MT1, typename MT2 >
628 struct ColumnExprTrait< DMatTSMatSubExpr<MT1,MT2> >
629 {
630  public:
631  //**********************************************************************************************
632  typedef typename SubExprTrait< typename ColumnExprTrait<const MT1>::Type
633  , typename ColumnExprTrait<const MT2>::Type >::Type Type;
634  //**********************************************************************************************
635 };
637 //*************************************************************************************************
638 
639 } // namespace blaze
640 
641 #endif
Compile time check whether the given type is a temporary vector or matrix type.This type trait class ...
Definition: IsTemporary.h:87
LeftOperand lhs_
Left-hand side dense matrix of the subtraction expression.
Definition: DMatTSMatSubExpr.h:234
Header file for the subtraction trait.
ResultType::TransposeType TransposeType
Transpose type for expression template evaluations.
Definition: DMatTSMatSubExpr.h:117
MT2::ReturnType RN2
Return type of the right-hand side sparse matrix expression.
Definition: DMatTSMatSubExpr.h:96
Header file for the IsSparseMatrix type trait.
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.
ResultType::ElementType ElementType
Resulting element type.
Definition: DMatTSMatSubExpr.h:118
ReturnType operator()(size_t i, size_t j) const
2D-access to the matrix elements.
Definition: DMatTSMatSubExpr.h:160
Header file for the IsColumnMajorMatrix type trait.
bool isAliased(const T *alias) const
Returns whether the expression is aliased with the given address alias.
Definition: DMatTSMatSubExpr.h:227
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
SubExprTrait< RN1, RN2 >::Type ExprReturnType
Expression return type for the subscript operator.
Definition: DMatTSMatSubExpr.h:109
Header file for the AddExprTrait class template.
MT2::ResultType RT2
Result type of the right-hand side sparse matrix expression.
Definition: DMatTSMatSubExpr.h:94
Header file for the Computation base class.
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.
Constraint on the data type.
Constraint on the data type.
SelectType< IsExpression< MT2 >::value, const MT2, const MT2 & >::Type RightOperand
Composite type of the right-hand side sparse matrix expression.
Definition: DMatTSMatSubExpr.h:130
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.
Base class for all matrix/matrix subtraction expression templates.The MatMatSubExpr class serves as a...
Definition: MatMatSubExpr.h:65
Expression object for dense matrix-transpose sparse matrix subtractions.The DMatTSMatSubExpr class re...
Definition: DMatTSMatSubExpr.h:87
#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
bool canAlias(const T *alias) const
Returns whether the expression can alias with the given address alias.
Definition: DMatTSMatSubExpr.h:214
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
Header file for the MatMatSubExpr base class.
const DenseIterator< Type > operator+(const DenseIterator< Type > &it, ptrdiff_t inc)
Addition between a DenseIterator and an integral value.
Definition: DenseIterator.h:556
size_t columns() const
Returns the current number of columns of the matrix.
Definition: DMatTSMatSubExpr.h:182
size_t rows() const
Returns the current number of rows of the matrix.
Definition: DMatTSMatSubExpr.h:172
#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.
Evaluation of the return type of a subtraction expression.Via this type trait it is possible to evalu...
Definition: SubExprTrait.h:103
Header file for the SelectType class template.
Header file for the RowExprTrait class template.
Header file for all forward declarations for expression class templates.
Header file for the IsDenseMatrix type trait.
MT1::ResultType RT1
Result type of the left-hand side dense matrix expression.
Definition: DMatTSMatSubExpr.h:93
RightOperand rightOperand() const
Returns the right-hand side transpose sparse matrix operand.
Definition: DMatTSMatSubExpr.h:202
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
LeftOperand leftOperand() const
Returns the left-hand side dense matrix operand.
Definition: DMatTSMatSubExpr.h:192
Header file for run time assertion macros.
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
const DenseIterator< Type > operator-(const DenseIterator< Type > &it, ptrdiff_t inc)
Subtraction between a DenseIterator and an integral value.
Definition: DenseIterator.h:585
ResultType::OppositeType OppositeType
Result type with opposite storage order for expression template evaluations.
Definition: DMatTSMatSubExpr.h:116
MT1::ReturnType RN1
Return type of the left-hand side dense matrix expression.
Definition: DMatTSMatSubExpr.h:95
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
SelectType< IsExpression< MT1 >::value, const MT1, const MT1 & >::Type LeftOperand
Composite type of the left-hand side dense matrix expression.
Definition: DMatTSMatSubExpr.h:127
DMatTSMatSubExpr(const MT1 &lhs, const MT2 &rhs)
Constructor for the DMatTSMatSubExpr class.
Definition: DMatTSMatSubExpr.h:144
#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
RightOperand rhs_
Right-hand side sparse matrix of the subtraction expression.
Definition: DMatTSMatSubExpr.h:235
Header file for the IsRowMajorMatrix type trait.
Base class for all compute expression templates.The Computation class serves as a tag for all computa...
Definition: Computation.h:59
DMatTSMatSubExpr< MT1, MT2 > This
Type of this DMatTSMatSubExpr instance.
Definition: DMatTSMatSubExpr.h:114
#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
const SelectType< returnExpr, ExprReturnType, ElementType >::Type ReturnType
Return type for expression template evaluations.
Definition: DMatTSMatSubExpr.h:121
This ResultType
Result type for expression template evaluations.
Definition: CompressedMatrix.h:2370
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.
const ResultType CompositeType
Data type for composite expression templates.
Definition: DMatTSMatSubExpr.h:124
Base template for the SubTrait class.
Definition: SubTrait.h:141
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
Header file for the IsExpression type trait class.
Header file for the FunctionTrace class.
SubTrait< RT1, RT2 >::Type ResultType
Result type for expression template evaluations.
Definition: DMatTSMatSubExpr.h:115