All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TSMatDMatSubExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_TSMATDMATSUBEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_TSMATDMATSUBEXPR_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 SMATTDMATSUBEXPR
71 //
72 //=================================================================================================
73 
74 //*************************************************************************************************
81 template< typename MT1 // Type of the left-hand side sparse matrix
82  , typename MT2 > // Type of the right-hand side dense matrix
83 class TSMatDMatSubExpr : public DenseMatrix< TSMatDMatSubExpr<MT1,MT2>, false >
84  , private MatMatSubExpr
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 TSMatDMatSubExpr( const MT1& lhs, const MT2& rhs )
141  : lhs_( lhs ) // Left-hand side sparse matrix of the subtraction expression
142  , rhs_( rhs ) // Right-hand side dense matrix of the subtraction 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 ( lhs_.canAlias( alias ) ) ||
212  ( IsExpression<MT2>::value && 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 TSMatDMatSubExpr& 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  assign ( ~lhs, -rhs.rhs_ );
256  addAssign( ~lhs, rhs.lhs_ );
257  }
259  //**********************************************************************************************
260 
261  //**Assignment to sparse matrices***************************************************************
273  template< typename MT // Type of the target sparse matrix
274  , bool SO2 > // Storage order of the target sparse matrix
275  friend inline void assign( SparseMatrix<MT,SO2>& lhs, const TSMatDMatSubExpr& rhs )
276  {
278 
279  typedef typename SelectType< SO2, OppositeType, ResultType >::Type TmpType;
280 
287 
288  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
289  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
290 
291  const TmpType tmp( rhs );
292  assign( ~lhs, tmp );
293  }
295  //**********************************************************************************************
296 
297  //**Addition assignment to dense matrices*******************************************************
310  template< typename MT // Type of the target dense matrix
311  , bool SO2 > // Storage order of the target dense matrix
312  friend inline void addAssign( DenseMatrix<MT,SO2>& lhs, const TSMatDMatSubExpr& rhs )
313  {
315 
316  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
317  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
318 
319  subAssign( ~lhs, rhs.rhs_ );
320  addAssign( ~lhs, rhs.lhs_ );
321  }
323  //**********************************************************************************************
324 
325  //**Addition assignment to sparse matrices******************************************************
326  // No special implementation for the addition assignment to sparse matrices.
327  //**********************************************************************************************
328 
329  //**Subtraction assignment to dense matrices****************************************************
342  template< typename MT // Type of the target dense matrix
343  , bool SO2 > // Storage order of the target dense matrix
344  friend inline void subAssign( DenseMatrix<MT,SO2>& lhs, const TSMatDMatSubExpr& rhs )
345  {
347 
348  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
349  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
350 
351  addAssign( ~lhs, rhs.rhs_ );
352  subAssign( ~lhs, rhs.lhs_ );
353  }
355  //**********************************************************************************************
356 
357  //**Subtraction assignment to sparse matrices***************************************************
358  // No special implementation for the subtraction assignment to sparse matrices.
359  //**********************************************************************************************
360 
361  //**Multiplication assignment to dense matrices*************************************************
362  // No special implementation for the multiplication assignment to dense matrices.
363  //**********************************************************************************************
364 
365  //**Multiplication assignment to sparse matrices************************************************
366  // No special implementation for the multiplication assignment to sparse matrices.
367  //**********************************************************************************************
368 
369  //**Compile time checks*************************************************************************
376  //**********************************************************************************************
377 };
378 //*************************************************************************************************
379 
380 
381 
382 
383 //=================================================================================================
384 //
385 // GLOBAL BINARY ARITHMETIC OPERATORS
386 //
387 //=================================================================================================
388 
389 //*************************************************************************************************
419 template< typename T1 // Type of the left-hand side sparse matrix
420  , typename T2 > // Type of the right-hand side dense matrix
421 inline const TSMatDMatSubExpr<T1,T2>
423 {
425 
426  if( (~lhs).rows() != (~rhs).rows() || (~lhs).columns() != (~rhs).columns() )
427  throw std::invalid_argument( "Matrix sizes do not match" );
428 
429  return TSMatDMatSubExpr<T1,T2>( ~lhs, ~rhs );
430 }
431 //*************************************************************************************************
432 
433 
434 
435 
436 //=================================================================================================
437 //
438 // GLOBAL RESTRUCTURING BINARY ARITHMETIC OPERATORS
439 //
440 //=================================================================================================
441 
442 //*************************************************************************************************
455 template< typename T1 // Type of the sparse matrix of the left-hand side expression
456  , typename T2 // Type of the dense matrix of the left-hand side expression
457  , typename T3 // Type of the right-hand side dense matrix
458  , bool SO > // Storage order of the right-hand side dense matrix
459 inline const typename AddExprTrait< TSMatDMatSubExpr<T1,T2>, T3 >::Type
460  operator+( const TSMatDMatSubExpr<T1,T2>& lhs, const DenseMatrix<T3,SO>& rhs )
461 {
463 
464  return ( (~rhs) - lhs.rightOperand() ) + lhs.leftOperand();
465 }
467 //*************************************************************************************************
468 
469 
470 //*************************************************************************************************
483 template< typename T1 // Type of the sparse matrix of the left-hand side expression
484  , typename T2 // Type of the dense matrix of the left-hand side expression
485  , typename T3 // Type of the right-hand side dense matrix
486  , bool SO > // Storage order of the right-hand side dense matrix
487 inline const typename SubExprTrait< TSMatDMatSubExpr<T1,T2>, T3 >::Type
488  operator-( const TSMatDMatSubExpr<T1,T2>& lhs, const DenseMatrix<T3,SO>& rhs )
489 {
491 
492  return lhs.leftOperand() - ( lhs.rightOperand() + (~rhs) );
493 }
495 //*************************************************************************************************
496 
497 
498 
499 
500 //=================================================================================================
501 //
502 // EXPRESSION TRAIT SPECIALIZATIONS
503 //
504 //=================================================================================================
505 
506 //*************************************************************************************************
508 template< typename MT1, typename MT2, typename MT3 >
509 struct DMatDMatAddExprTrait< TSMatDMatSubExpr<MT1,MT2>, MT3 >
510 {
511  public:
512  //**********************************************************************************************
514  typedef typename SelectType< IsSparseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
515  IsDenseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
516  IsDenseMatrix<MT3>::value && IsRowMajorMatrix<MT3>::value
517  , typename DMatTSMatAddExprTrait< typename DMatDMatSubExprTrait<MT3,MT2>::Type, MT1 >::Type
518  , INVALID_TYPE >::Type Type;
520  //**********************************************************************************************
521 };
523 //*************************************************************************************************
524 
525 
526 //*************************************************************************************************
528 template< typename MT1, typename MT2, typename MT3 >
529 struct DMatTDMatAddExprTrait< TSMatDMatSubExpr<MT1,MT2>, MT3 >
530 {
531  public:
532  //**********************************************************************************************
534  typedef typename SelectType< IsSparseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
535  IsDenseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
536  IsDenseMatrix<MT3>::value && IsColumnMajorMatrix<MT3>::value
537  , typename DMatTSMatAddExprTrait< typename TDMatDMatSubExprTrait<MT3,MT2>::Type, MT1 >::Type
538  , INVALID_TYPE >::Type Type;
540  //**********************************************************************************************
541 };
543 //*************************************************************************************************
544 
545 
546 //*************************************************************************************************
548 template< typename MT1, typename MT2, typename MT3 >
549 struct DMatDMatSubExprTrait< TSMatDMatSubExpr<MT1,MT2>, MT3 >
550 {
551  public:
552  //**********************************************************************************************
554  typedef typename SelectType< IsSparseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
555  IsDenseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
556  IsDenseMatrix<MT3>::value && IsRowMajorMatrix<MT3>::value
557  , typename TSMatDMatSubExprTrait< MT1, typename DMatDMatAddExprTrait<MT2,MT3>::Type >::Type
558  , INVALID_TYPE >::Type Type;
560  //**********************************************************************************************
561 };
563 //*************************************************************************************************
564 
565 
566 //*************************************************************************************************
568 template< typename MT1, typename MT2, typename MT3 >
569 struct DMatTDMatSubExprTrait< TSMatDMatSubExpr<MT1,MT2>, MT3 >
570 {
571  public:
572  //**********************************************************************************************
574  typedef typename SelectType< IsSparseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
575  IsDenseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
576  IsDenseMatrix<MT3>::value && IsColumnMajorMatrix<MT3>::value
577  , typename TSMatDMatSubExprTrait< MT1, typename DMatTDMatAddExprTrait<MT2,MT3>::Type >::Type
578  , INVALID_TYPE >::Type Type;
580  //**********************************************************************************************
581 };
583 //*************************************************************************************************
584 
585 
586 //*************************************************************************************************
588 template< typename MT1, typename MT2 >
589 struct SubmatrixExprTrait< TSMatDMatSubExpr<MT1,MT2> >
590 {
591  public:
592  //**********************************************************************************************
593  typedef typename SubExprTrait< typename SubmatrixExprTrait<const MT1>::Type
594  , typename SubmatrixExprTrait<const MT2>::Type >::Type Type;
595  //**********************************************************************************************
596 };
598 //*************************************************************************************************
599 
600 
601 //*************************************************************************************************
603 template< typename MT1, typename MT2 >
604 struct RowExprTrait< TSMatDMatSubExpr<MT1,MT2> >
605 {
606  public:
607  //**********************************************************************************************
608  typedef typename SubExprTrait< typename RowExprTrait<const MT1>::Type
609  , typename RowExprTrait<const MT2>::Type >::Type Type;
610  //**********************************************************************************************
611 };
613 //*************************************************************************************************
614 
615 
616 //*************************************************************************************************
618 template< typename MT1, typename MT2 >
619 struct ColumnExprTrait< TSMatDMatSubExpr<MT1,MT2> >
620 {
621  public:
622  //**********************************************************************************************
623  typedef typename SubExprTrait< typename ColumnExprTrait<const MT1>::Type
624  , typename ColumnExprTrait<const MT2>::Type >::Type Type;
625  //**********************************************************************************************
626 };
628 //*************************************************************************************************
629 
630 } // namespace blaze
631 
632 #endif
bool canAlias(const T *alias) const
Returns whether the expression can alias with the given address alias.
Definition: TSMatDMatSubExpr.h:210
Compile time check whether the given type is a temporary vector or matrix type.This type trait class ...
Definition: IsTemporary.h:87
size_t columns() const
Returns the current number of columns of the matrix.
Definition: TSMatDMatSubExpr.h:178
ReturnType operator()(size_t i, size_t j) const
2D-access to the matrix elements.
Definition: TSMatDMatSubExpr.h:156
Header file for the subtraction trait.
Efficient implementation of a compressed matrix.The CompressedMatrix class template is the represent...
Definition: CompressedMatrix.h:196
MT1::ResultType RT1
Result type of the left-hand side sparse matrix expression.
Definition: TSMatDMatSubExpr.h:89
#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.
RightOperand rightOperand() const
Returns the right-hand side dense matrix operand.
Definition: TSMatDMatSubExpr.h:198
ResultType::OppositeType OppositeType
Result type with opposite storage order for expression template evaluations.
Definition: TSMatDMatSubExpr.h:112
LeftOperand leftOperand() const
Returns the left-hand side transpose sparse matrix operand.
Definition: TSMatDMatSubExpr.h:188
RightOperand rhs_
Right-hand side dense matrix of the subtraction expression.
Definition: TSMatDMatSubExpr.h:231
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.
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.
const ResultType CompositeType
Data type for composite expression templates.
Definition: TSMatDMatSubExpr.h:120
MT2::ReturnType RN2
Return type of the right-hand side dense matrix expression.
Definition: TSMatDMatSubExpr.h:92
Constraint on the data type.
Constraint on the data type.
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
LeftOperand lhs_
Left-hand side sparse matrix of the subtraction expression.
Definition: TSMatDMatSubExpr.h:230
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
ResultType::TransposeType TransposeType
Transpose type for expression template evaluations.
Definition: TSMatDMatSubExpr.h:113
#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.
bool isAliased(const T *alias) const
Returns whether the expression is aliased with the given address alias.
Definition: TSMatDMatSubExpr.h:223
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.
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
Expression object for transpose sparse matrix-dense matrix subtractions.The TSMatDMatSubExpr class re...
Definition: Forward.h:134
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
MT1::ReturnType RN1
Return type of the left-hand side sparse matrix expression.
Definition: TSMatDMatSubExpr.h:91
MT2::ResultType RT2
Result type of the right-hand side dense matrix expression.
Definition: TSMatDMatSubExpr.h:90
SelectType< IsExpression< MT2 >::value, const MT2, const MT2 & >::Type RightOperand
Composite type of the right-hand side sparse matrix expression.
Definition: TSMatDMatSubExpr.h:126
#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
TSMatDMatSubExpr(const MT1 &lhs, const MT2 &rhs)
Constructor for the TSMatDMatSubExpr class.
Definition: TSMatDMatSubExpr.h:140
ResultType::ElementType ElementType
Resulting element type.
Definition: TSMatDMatSubExpr.h:114
SubTrait< RT1, RT2 >::Type ResultType
Result type for expression template evaluations.
Definition: TSMatDMatSubExpr.h:111
const SelectType< returnExpr, ExprReturnType, ElementType >::Type ReturnType
Return type for expression template evaluations.
Definition: TSMatDMatSubExpr.h:117
SelectType< IsExpression< MT1 >::value, const MT1, const MT1 & >::Type LeftOperand
Composite type of the left-hand side dense matrix expression.
Definition: TSMatDMatSubExpr.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
SubExprTrait< RN1, RN2 >::Type ExprReturnType
Expression return type for the subscript operator.
Definition: TSMatDMatSubExpr.h:105
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.
Base template for the SubTrait class.
Definition: SubTrait.h:141
size_t rows() const
Returns the current number of rows of the matrix.
Definition: TSMatDMatSubExpr.h:168
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.
TSMatDMatSubExpr< MT1, MT2 > This
Type of this TSMatDMatSubExpr instance.
Definition: TSMatDMatSubExpr.h:110
Header file for the FunctionTrace class.