All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SMatTDMatSubExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_SMATTDMATSUBEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_SMATTDMATSUBEXPR_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 SMATTDMATSUBEXPR
75 //
76 //=================================================================================================
77 
78 //*************************************************************************************************
85 template< typename MT1 // Type of the left-hand side sparse matrix
86  , typename MT2 > // Type of the right-hand side dense matrix
87 class SMatTDMatSubExpr : public DenseMatrix< SMatTDMatSubExpr<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 SMatTDMatSubExpr( const MT1& lhs, const MT2& rhs )
145  : lhs_( lhs ) // Left-hand side sparse matrix of the subtraction expression
146  , rhs_( rhs ) // Right-hand side dense 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 ( lhs_.canAlias( alias ) ) ||
216  ( IsExpression<MT2>::value && 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 SMatTDMatSubExpr& 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  assign ( ~lhs, -rhs.rhs_ );
260  addAssign( ~lhs, rhs.lhs_ );
261  }
263  //**********************************************************************************************
264 
265  //**Assignment to sparse matrices***************************************************************
277  template< typename MT // Type of the target sparse matrix
278  , bool SO2 > // Storage order of the target sparse matrix
279  friend inline void assign( SparseMatrix<MT,SO2>& lhs, const SMatTDMatSubExpr& rhs )
280  {
282 
283  typedef typename SelectType< SO2, OppositeType, ResultType >::Type TmpType;
284 
291 
292  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
293  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
294 
295  const TmpType tmp( rhs );
296  assign( ~lhs, tmp );
297  }
299  //**********************************************************************************************
300 
301  //**Addition assignment to dense matrices*******************************************************
314  template< typename MT // Type of the target dense matrix
315  , bool SO2 > // Storage order of the target dense matrix
316  friend inline void addAssign( DenseMatrix<MT,SO2>& lhs, const SMatTDMatSubExpr& rhs )
317  {
319 
320  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
321  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
322 
323  subAssign( ~lhs, rhs.rhs_ );
324  addAssign( ~lhs, rhs.lhs_ );
325  }
327  //**********************************************************************************************
328 
329  //**Addition assignment to sparse matrices******************************************************
330  // No special implementation for the addition assignment to sparse matrices.
331  //**********************************************************************************************
332 
333  //**Subtraction assignment to dense matrices****************************************************
346  template< typename MT // Type of the target dense matrix
347  , bool SO2 > // Storage order of the target dense matrix
348  friend inline void subAssign( DenseMatrix<MT,SO2>& lhs, const SMatTDMatSubExpr& rhs )
349  {
351 
352  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
353  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
354 
355  addAssign( ~lhs, rhs.rhs_ );
356  subAssign( ~lhs, rhs.lhs_ );
357  }
359  //**********************************************************************************************
360 
361  //**Subtraction assignment to sparse matrices***************************************************
362  // No special implementation for the subtraction assignment to sparse matrices.
363  //**********************************************************************************************
364 
365  //**Multiplication assignment to dense matrices*************************************************
366  // No special implementation for the multiplication assignment to dense matrices.
367  //**********************************************************************************************
368 
369  //**Multiplication assignment to sparse matrices************************************************
370  // No special implementation for the multiplication assignment to sparse matrices.
371  //**********************************************************************************************
372 
373  //**Compile time checks*************************************************************************
380  //**********************************************************************************************
381 };
382 //*************************************************************************************************
383 
384 
385 
386 
387 //=================================================================================================
388 //
389 // GLOBAL BINARY ARITHMETIC OPERATORS
390 //
391 //=================================================================================================
392 
393 //*************************************************************************************************
424 template< typename T1 // Type of the left-hand side sparse matrix
425  , typename T2 > // Type of the right-hand side dense matrix
426 inline const SMatTDMatSubExpr<T1,T2>
428 {
430 
431  if( (~lhs).rows() != (~rhs).rows() || (~lhs).columns() != (~rhs).columns() )
432  throw std::invalid_argument( "Matrix sizes do not match" );
433 
434  return SMatTDMatSubExpr<T1,T2>( ~lhs, ~rhs );
435 }
436 //*************************************************************************************************
437 
438 
439 
440 
441 //=================================================================================================
442 //
443 // GLOBAL RESTRUCTURING BINARY ARITHMETIC OPERATORS
444 //
445 //=================================================================================================
446 
447 //*************************************************************************************************
460 template< typename T1 // Type of the sparse matrix of the left-hand side expression
461  , typename T2 // Type of the dense matrix of the left-hand side expression
462  , typename T3 // Type of the right-hand side dense matrix
463  , bool SO > // Storage order of the right-hand side dense matrix
464 inline const typename AddExprTrait< SMatTDMatSubExpr<T1,T2>, T3 >::Type
465  operator+( const SMatTDMatSubExpr<T1,T2>& lhs, const DenseMatrix<T3,SO>& rhs )
466 {
468 
469  return ( (~rhs) - lhs.rightOperand() ) + lhs.leftOperand();
470 }
472 //*************************************************************************************************
473 
474 
475 //*************************************************************************************************
488 template< typename T1 // Type of the sparse matrix of the left-hand side expression
489  , typename T2 // Type of the dense matrix of the left-hand side expression
490  , typename T3 // Type of the right-hand side dense matrix
491  , bool SO > // Storage order of the right-hand side dense matrix
492 inline const typename SubExprTrait< SMatTDMatSubExpr<T1,T2>, T3 >::Type
493  operator-( const SMatTDMatSubExpr<T1,T2>& lhs, const DenseMatrix<T3,SO>& rhs )
494 {
496 
497  return lhs.leftOperand() - ( lhs.rightOperand() + (~rhs) );
498 }
500 //*************************************************************************************************
501 
502 
503 
504 
505 //=================================================================================================
506 //
507 // EXPRESSION TRAIT SPECIALIZATIONS
508 //
509 //=================================================================================================
510 
511 //*************************************************************************************************
513 template< typename MT1, typename MT2, typename MT3 >
514 struct DMatDMatAddExprTrait< SMatTDMatSubExpr<MT1,MT2>, MT3 >
515 {
516  public:
517  //**********************************************************************************************
519  typedef typename SelectType< IsSparseMatrix<MT1>::value && IsRowMajorMatrix<MT1>::value &&
520  IsDenseMatrix<MT2>::value && IsColumnMajorMatrix<MT2>::value &&
521  IsDenseMatrix<MT3>::value && IsRowMajorMatrix<MT3>::value
522  , typename DMatSMatAddExprTrait< typename DMatTDMatSubExprTrait<MT3,MT2>::Type, MT1 >::Type
523  , INVALID_TYPE >::Type Type;
525  //**********************************************************************************************
526 };
528 //*************************************************************************************************
529 
530 
531 //*************************************************************************************************
533 template< typename MT1, typename MT2, typename MT3 >
534 struct DMatTDMatAddExprTrait< SMatTDMatSubExpr<MT1,MT2>, MT3 >
535 {
536  public:
537  //**********************************************************************************************
539  typedef typename SelectType< IsSparseMatrix<MT1>::value && IsRowMajorMatrix<MT1>::value &&
540  IsDenseMatrix<MT2>::value && IsColumnMajorMatrix<MT2>::value &&
541  IsDenseMatrix<MT3>::value && IsColumnMajorMatrix<MT3>::value
542  , typename TDMatSMatAddExprTrait< typename TDMatTDMatSubExprTrait<MT3,MT2>::Type, MT1 >::Type
543  , INVALID_TYPE >::Type Type;
545  //**********************************************************************************************
546 };
548 //*************************************************************************************************
549 
550 
551 //*************************************************************************************************
553 template< typename MT1, typename MT2, typename MT3 >
554 struct DMatDMatSubExprTrait< SMatTDMatSubExpr<MT1,MT2>, MT3 >
555 {
556  public:
557  //**********************************************************************************************
559  typedef typename SelectType< IsSparseMatrix<MT1>::value && IsRowMajorMatrix<MT1>::value &&
560  IsDenseMatrix<MT2>::value && IsColumnMajorMatrix<MT2>::value &&
561  IsDenseMatrix<MT3>::value && IsRowMajorMatrix<MT3>::value
562  , typename SMatDMatSubExprTrait< MT1, typename TDMatDMatAddExprTrait<MT2,MT3>::Type >::Type
563  , INVALID_TYPE >::Type Type;
565  //**********************************************************************************************
566 };
568 //*************************************************************************************************
569 
570 
571 //*************************************************************************************************
573 template< typename MT1, typename MT2, typename MT3 >
574 struct DMatTDMatSubExprTrait< SMatTDMatSubExpr<MT1,MT2>, MT3 >
575 {
576  public:
577  //**********************************************************************************************
579  typedef typename SelectType< IsSparseMatrix<MT1>::value && IsRowMajorMatrix<MT1>::value &&
580  IsDenseMatrix<MT2>::value && IsColumnMajorMatrix<MT2>::value &&
581  IsDenseMatrix<MT3>::value && IsColumnMajorMatrix<MT3>::value
582  , typename SMatTDMatSubExprTrait< MT1, typename TDMatTDMatAddExprTrait<MT2,MT3>::Type >::Type
583  , INVALID_TYPE >::Type Type;
585  //**********************************************************************************************
586 };
588 //*************************************************************************************************
589 
590 
591 //*************************************************************************************************
593 template< typename MT1, typename MT2 >
594 struct SubmatrixExprTrait< SMatTDMatSubExpr<MT1,MT2> >
595 {
596  public:
597  //**********************************************************************************************
598  typedef typename SubExprTrait< typename SubmatrixExprTrait<const MT1>::Type
599  , typename SubmatrixExprTrait<const MT2>::Type >::Type Type;
600  //**********************************************************************************************
601 };
603 //*************************************************************************************************
604 
605 
606 //*************************************************************************************************
608 template< typename MT1, typename MT2 >
609 struct RowExprTrait< SMatTDMatSubExpr<MT1,MT2> >
610 {
611  public:
612  //**********************************************************************************************
613  typedef typename SubExprTrait< typename RowExprTrait<const MT1>::Type
614  , typename RowExprTrait<const MT2>::Type >::Type Type;
615  //**********************************************************************************************
616 };
618 //*************************************************************************************************
619 
620 
621 //*************************************************************************************************
623 template< typename MT1, typename MT2 >
624 struct ColumnExprTrait< SMatTDMatSubExpr<MT1,MT2> >
625 {
626  public:
627  //**********************************************************************************************
628  typedef typename SubExprTrait< typename ColumnExprTrait<const MT1>::Type
629  , typename ColumnExprTrait<const MT2>::Type >::Type Type;
630  //**********************************************************************************************
631 };
633 //*************************************************************************************************
634 
635 } // namespace blaze
636 
637 #endif
SubTrait< RT1, RT2 >::Type ResultType
Result type for expression template evaluations.
Definition: SMatTDMatSubExpr.h:115
Compile time check whether the given type is a temporary vector or matrix type.This type trait class ...
Definition: IsTemporary.h:87
MT1::ReturnType RN1
Return type of the left-hand side sparse matrix expression.
Definition: SMatTDMatSubExpr.h:95
Header file for the subtraction trait.
const SelectType< returnExpr, ExprReturnType, ElementType >::Type ReturnType
Return type for expression template evaluations.
Definition: SMatTDMatSubExpr.h:121
MT2::ResultType RT2
Result type of the right-hand side dense matrix expression.
Definition: SMatTDMatSubExpr.h:94
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.
MT2::ReturnType RN2
Return type of the right-hand side dense matrix expression.
Definition: SMatTDMatSubExpr.h:96
Header file for the IsColumnMajorMatrix type trait.
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
MT1::ResultType RT1
Result type of the left-hand side sparse matrix expression.
Definition: SMatTDMatSubExpr.h:93
Header file for the AddExprTrait class template.
Header file for the Computation base class.
SubExprTrait< RN1, RN2 >::Type ExprReturnType
Expression return type for the subscript operator.
Definition: SMatTDMatSubExpr.h:109
ResultType::TransposeType TransposeType
Transpose type for expression template evaluations.
Definition: SMatTDMatSubExpr.h:117
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.
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.
Expression object for sparse matrix-transpose dense matrix subtractions.The SMatTDMatSubExpr class re...
Definition: Forward.h:98
SMatTDMatSubExpr(const MT1 &lhs, const MT2 &rhs)
Constructor for the SMatTDMatSubExpr class.
Definition: SMatTDMatSubExpr.h:144
#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: SMatTDMatSubExpr.h:234
RightOperand rhs_
Right-hand side dense matrix of the subtraction expression.
Definition: SMatTDMatSubExpr.h:235
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
bool isAliased(const T *alias) const
Returns whether the expression is aliased with the given address alias.
Definition: SMatTDMatSubExpr.h:227
#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.
SMatTDMatSubExpr< MT1, MT2 > This
Type of this SMatTDMatSubExpr instance.
Definition: SMatTDMatSubExpr.h:114
ReturnType operator()(size_t i, size_t j) const
2D-access to the matrix elements.
Definition: SMatTDMatSubExpr.h:160
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
LeftOperand leftOperand() const
Returns the left-hand side sparse matrix operand.
Definition: SMatTDMatSubExpr.h:192
ResultType::OppositeType OppositeType
Result type with opposite storage order for expression template evaluations.
Definition: SMatTDMatSubExpr.h:116
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: SMatTDMatSubExpr.h:127
const ResultType CompositeType
Data type for composite expression templates.
Definition: SMatTDMatSubExpr.h:124
#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
SelectType< IsExpression< MT2 >::value, const MT2, const MT2 & >::Type RightOperand
Composite type of the right-hand side sparse matrix expression.
Definition: SMatTDMatSubExpr.h:130
Header file for the IsRowMajorMatrix type trait.
bool canAlias(const T *alias) const
Returns whether the expression can alias with the given address alias.
Definition: SMatTDMatSubExpr.h:214
size_t rows() const
Returns the current number of rows of the matrix.
Definition: SMatTDMatSubExpr.h:172
#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
ResultType::ElementType ElementType
Resulting element type.
Definition: SMatTDMatSubExpr.h:118
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.
Base template for the SubTrait class.
Definition: SubTrait.h:141
RightOperand rightOperand() const
Returns the right-hand side transpose dense matrix operand.
Definition: SMatTDMatSubExpr.h:202
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
size_t columns() const
Returns the current number of columns of the matrix.
Definition: SMatTDMatSubExpr.h:182
Header file for the IsExpression type trait class.
Header file for the FunctionTrace class.