All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TDMatSMatSubExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_TDMATSMATSUBEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_TDMATSMATSUBEXPR_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 TDMATSMATSUBEXPR
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 TDMatSMatSubExpr : public DenseMatrix< TDMatSMatSubExpr<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 TDMatSMatSubExpr( const MT1& lhs, const MT2& rhs )
141  : lhs_( lhs ) // Left-hand side dense matrix of the subtraction expression
142  , rhs_( rhs ) // Right-hand side sparse 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 ( 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 TDMatSMatSubExpr& 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  subAssign( ~lhs, rhs.rhs_ );
257  }
258  else {
259  assign ( ~lhs, rhs.lhs_ );
260  subAssign( ~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 TDMatSMatSubExpr& 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 TDMatSMatSubExpr& 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  subAssign( ~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 TDMatSMatSubExpr& 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  addAssign( ~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 inline const TDMatSMatSubExpr<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 TDMatSMatSubExpr<T1,T2>( ~lhs, ~rhs );
436 }
437 //*************************************************************************************************
438 
439 
440 
441 
442 //=================================================================================================
443 //
444 // GLOBAL RESTRUCTURING BINARY ARITHMETIC OPERATORS
445 //
446 //=================================================================================================
447 
448 //*************************************************************************************************
461 template< typename T1 // Type of the dense matrix of the left-hand side expression
462  , typename T2 // Type of the sparse matrix of the left-hand side expression
463  , typename T3 // Type of the right-hand side dense matrix
464  , bool SO > // Storage order of the right-hand side dense matrix
465 inline const typename AddExprTrait< TDMatSMatSubExpr<T1,T2>, T3 >::Type
466  operator+( const TDMatSMatSubExpr<T1,T2>& lhs, const DenseMatrix<T3,SO>& rhs )
467 {
469 
470  return ( lhs.leftOperand() + (~rhs) ) - lhs.rightOperand();
471 }
473 //*************************************************************************************************
474 
475 
476 //*************************************************************************************************
489 template< typename T1 // Type of the dense matrix of the left-hand side expression
490  , typename T2 // Type of the sparse matrix of the left-hand side expression
491  , typename T3 // Type of the right-hand side dense matrix
492  , bool SO > // Storage order of the right-hand side dense matrix
493 inline const typename SubExprTrait< TDMatSMatSubExpr<T1,T2>, T3 >::Type
494  operator-( const TDMatSMatSubExpr<T1,T2>& lhs, const DenseMatrix<T3,SO>& rhs )
495 {
497 
498  return ( lhs.leftOperand() - (~rhs) ) - lhs.rightOperand();
499 }
501 //*************************************************************************************************
502 
503 
504 
505 
506 //=================================================================================================
507 //
508 // EXPRESSION TRAIT SPECIALIZATIONS
509 //
510 //=================================================================================================
511 
512 //*************************************************************************************************
514 template< typename MT1, typename MT2, typename MT3 >
515 struct DMatDMatAddExprTrait< TDMatSMatSubExpr<MT1,MT2>, MT3 >
516 {
517  public:
518  //**********************************************************************************************
520  typedef typename SelectType< IsDenseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
521  IsSparseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
522  IsDenseMatrix<MT3>::value && IsRowMajorMatrix<MT3>::value
523  , typename DMatSMatSubExprTrait< typename TDMatDMatAddExprTrait<MT1,MT3>::Type, MT2 >::Type
524  , INVALID_TYPE >::Type Type;
526  //**********************************************************************************************
527 };
529 //*************************************************************************************************
530 
531 
532 //*************************************************************************************************
534 template< typename MT1, typename MT2, typename MT3 >
535 struct DMatTDMatAddExprTrait< TDMatSMatSubExpr<MT1,MT2>, MT3 >
536 {
537  public:
538  //**********************************************************************************************
540  typedef typename SelectType< IsDenseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
541  IsSparseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
542  IsDenseMatrix<MT3>::value && IsColumnMajorMatrix<MT3>::value
543  , typename TDMatSMatSubExprTrait< typename TDMatTDMatAddExprTrait<MT1,MT3>::Type, MT2 >::Type
544  , INVALID_TYPE >::Type Type;
546  //**********************************************************************************************
547 };
549 //*************************************************************************************************
550 
551 
552 //*************************************************************************************************
554 template< typename MT1, typename MT2, typename MT3 >
555 struct DMatDMatSubExprTrait< TDMatSMatSubExpr<MT1,MT2>, MT3 >
556 {
557  public:
558  //**********************************************************************************************
560  typedef typename SelectType< IsDenseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
561  IsSparseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
562  IsDenseMatrix<MT3>::value && IsRowMajorMatrix<MT3>::value
563  , typename DMatSMatSubExprTrait< typename TDMatDMatSubExprTrait<MT1,MT3>::Type, MT2 >::Type
564  , INVALID_TYPE >::Type Type;
566  //**********************************************************************************************
567 };
569 //*************************************************************************************************
570 
571 
572 //*************************************************************************************************
574 template< typename MT1, typename MT2, typename MT3 >
575 struct DMatTDMatSubExprTrait< TDMatSMatSubExpr<MT1,MT2>, MT3 >
576 {
577  public:
578  //**********************************************************************************************
580  typedef typename SelectType< IsDenseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
581  IsSparseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
582  IsDenseMatrix<MT3>::value && IsColumnMajorMatrix<MT3>::value
583  , typename TDMatSMatSubExprTrait< typename TDMatTDMatSubExprTrait<MT1,MT3>::Type, MT2 >::Type
584  , INVALID_TYPE >::Type Type;
586  //**********************************************************************************************
587 };
589 //*************************************************************************************************
590 
591 
592 //*************************************************************************************************
594 template< typename MT1, typename MT2 >
595 struct SubmatrixExprTrait< TDMatSMatSubExpr<MT1,MT2> >
596 {
597  public:
598  //**********************************************************************************************
599  typedef typename SubExprTrait< typename SubmatrixExprTrait<const MT1>::Type
600  , typename SubmatrixExprTrait<const MT2>::Type >::Type Type;
601  //**********************************************************************************************
602 };
604 //*************************************************************************************************
605 
606 
607 //*************************************************************************************************
609 template< typename MT1, typename MT2 >
610 struct RowExprTrait< TDMatSMatSubExpr<MT1,MT2> >
611 {
612  public:
613  //**********************************************************************************************
614  typedef typename SubExprTrait< typename RowExprTrait<const MT1>::Type
615  , typename RowExprTrait<const MT2>::Type >::Type Type;
616  //**********************************************************************************************
617 };
619 //*************************************************************************************************
620 
621 
622 //*************************************************************************************************
624 template< typename MT1, typename MT2 >
625 struct ColumnExprTrait< TDMatSMatSubExpr<MT1,MT2> >
626 {
627  public:
628  //**********************************************************************************************
629  typedef typename SubExprTrait< typename ColumnExprTrait<const MT1>::Type
630  , typename ColumnExprTrait<const MT2>::Type >::Type Type;
631  //**********************************************************************************************
632 };
634 //*************************************************************************************************
635 
636 } // namespace blaze
637 
638 #endif
RightOperand rightOperand() const
Returns the right-hand side sparse matrix operand.
Definition: TDMatSMatSubExpr.h:198
MT2::ReturnType RN2
Return type of the right-hand side sparse matrix expression.
Definition: TDMatSMatSubExpr.h:92
ResultType::TransposeType TransposeType
Transpose type for expression template evaluations.
Definition: TDMatSMatSubExpr.h:113
Compile time check whether the given type is a temporary vector or matrix type.This type trait class ...
Definition: IsTemporary.h:87
Header file for the subtraction trait.
const ResultType CompositeType
Data type for composite expression templates.
Definition: TDMatSMatSubExpr.h:120
Efficient implementation of a compressed matrix.The CompressedMatrix class template is the represent...
Definition: CompressedMatrix.h:196
TDMatSMatSubExpr< MT1, MT2 > This
Type of this TDMatSMatSubExpr instance.
Definition: TDMatSMatSubExpr.h:110
#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.
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.
ResultType::OppositeType OppositeType
Result type with opposite storage order for expression template evaluations.
Definition: TDMatSMatSubExpr.h:112
ResultType::ElementType ElementType
Resulting element type.
Definition: TDMatSMatSubExpr.h:114
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.
SubExprTrait< RN1, RN2 >::Type ExprReturnType
Expression return type for the subscript operator.
Definition: TDMatSMatSubExpr.h:105
MT2::ResultType RT2
Result type of the right-hand side sparse matrix expression.
Definition: TDMatSMatSubExpr.h:90
SelectType< IsExpression< MT1 >::value, const MT1, const MT1 & >::Type LeftOperand
Composite type of the left-hand side dense matrix expression.
Definition: TDMatSMatSubExpr.h:123
#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 dense matrix of the subtraction expression.
Definition: TDMatSMatSubExpr.h:230
MT1::ReturnType RN1
Return type of the left-hand side dense matrix expression.
Definition: TDMatSMatSubExpr.h:91
Header file for the DenseMatrix base class.
bool isAliased(const T *alias) const
Returns whether the expression is aliased with the given address alias.
Definition: TDMatSMatSubExpr.h:223
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
#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
size_t columns() const
Returns the current number of columns of the matrix.
Definition: TDMatSMatSubExpr.h:178
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
size_t rows() const
Returns the current number of rows of the matrix.
Definition: TDMatSMatSubExpr.h:168
Header file for the SelectType class template.
Header file for the RowExprTrait class template.
Header file for all forward declarations for expression class templates.
TDMatSMatSubExpr(const MT1 &lhs, const MT2 &rhs)
Constructor for the TDMatSMatSubExpr class.
Definition: TDMatSMatSubExpr.h:140
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 transpose dense matrix operand.
Definition: TDMatSMatSubExpr.h:188
Header file for run time assertion macros.
SubTrait< RT1, RT2 >::Type ResultType
Result type for expression template evaluations.
Definition: TDMatSMatSubExpr.h:111
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
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< MT2 >::value, const MT2, const MT2 & >::Type RightOperand
Composite type of the right-hand side sparse matrix expression.
Definition: TDMatSMatSubExpr.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
#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
MT1::ResultType RT1
Result type of the left-hand side dense matrix expression.
Definition: TDMatSMatSubExpr.h:89
RightOperand rhs_
Right-hand side sparse matrix of the subtraction expression.
Definition: TDMatSMatSubExpr.h:231
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.
bool canAlias(const T *alias) const
Returns whether the expression can alias with the given address alias.
Definition: TDMatSMatSubExpr.h:210
Base template for the SubTrait class.
Definition: SubTrait.h:141
const SelectType< returnExpr, ExprReturnType, ElementType >::Type ReturnType
Return type for expression template evaluations.
Definition: TDMatSMatSubExpr.h:117
ReturnType operator()(size_t i, size_t j) const
2D-access to the matrix elements.
Definition: TDMatSMatSubExpr.h:156
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
Expression object for transpose dense matrix-sparse matrix subtractions.The TDMatSMatSubExpr class re...
Definition: Forward.h:125
#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.