All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SMatEvalExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_SMATEVALEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_SMATEVALEXPR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <cmath>
61 #include <blaze/util/Assert.h>
63 #include <blaze/util/EnableIf.h>
64 #include <blaze/util/InvalidType.h>
66 #include <blaze/util/SelectType.h>
67 #include <blaze/util/Types.h>
68 
69 
70 namespace blaze {
71 
72 //=================================================================================================
73 //
74 // CLASS SMATEVALEXPR
75 //
76 //=================================================================================================
77 
78 //*************************************************************************************************
85 template< typename MT // Type of the sparse matrix
86  , bool SO > // Storage order
87 class SMatEvalExpr : public SparseMatrix< SMatEvalExpr<MT,SO>, SO >
88  , private MatEvalExpr
89  , private Computation
90 {
91  public:
92  //**Type definitions****************************************************************************
94  typedef typename MT::ResultType ResultType;
95  typedef typename MT::OppositeType OppositeType;
96  typedef typename MT::TransposeType TransposeType;
97  typedef typename MT::ElementType ElementType;
98  typedef typename MT::ReturnType ReturnType;
99 
101  typedef const ResultType CompositeType;
102 
104  typedef typename SelectType< IsExpression<MT>::value, const MT, const MT& >::Type Operand;
105  //**********************************************************************************************
106 
107  //**Constructor*********************************************************************************
112  explicit inline SMatEvalExpr( const MT& sm )
113  : sm_( sm ) // Sparse matrix of the evaluation expression
114  {}
115  //**********************************************************************************************
116 
117  //**Access operator*****************************************************************************
124  inline ReturnType operator()( size_t i, size_t j ) const {
125  BLAZE_INTERNAL_ASSERT( i < sm_.rows() , "Invalid row access index" );
126  BLAZE_INTERNAL_ASSERT( j < sm_.columns(), "Invalid column access index" );
127  return sm_(i,j);
128  }
129  //**********************************************************************************************
130 
131  //**Rows function*******************************************************************************
136  inline size_t rows() const {
137  return sm_.rows();
138  }
139  //**********************************************************************************************
140 
141  //**Columns function****************************************************************************
146  inline size_t columns() const {
147  return sm_.columns();
148  }
149  //**********************************************************************************************
150 
151  //**NonZeros function***************************************************************************
156  inline size_t nonZeros() const {
157  return sm_.nonZeros();
158  }
159  //**********************************************************************************************
160 
161  //**NonZeros function***************************************************************************
167  inline size_t nonZeros( size_t i ) const {
168  return sm_.nonZeros(i);
169  }
170  //**********************************************************************************************
171 
172  //**Operand access******************************************************************************
177  inline Operand operand() const {
178  return sm_;
179  }
180  //**********************************************************************************************
181 
182  //**********************************************************************************************
188  template< typename T >
189  inline bool canAlias( const T* alias ) const {
190  return sm_.canAlias( alias );
191  }
192  //**********************************************************************************************
193 
194  //**********************************************************************************************
200  template< typename T >
201  inline bool isAliased( const T* alias ) const {
202  return sm_.isAliased( alias );
203  }
204  //**********************************************************************************************
205 
206  private:
207  //**Member variables****************************************************************************
209  //**********************************************************************************************
210 
211  //**Assignment to dense matrices****************************************************************
223  template< typename MT2 // Type of the target dense matrix
224  , bool SO2 > // Storage order of the target dense matrix
225  friend inline void assign( DenseMatrix<MT2,SO2>& lhs, const SMatEvalExpr& rhs )
226  {
228 
229  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
230  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
231 
232  assign( ~lhs, rhs.sm_ );
233  }
235  //**********************************************************************************************
236 
237  //**Assignment to sparse matrices***************************************************************
249  template< typename MT2 // Type of the target sparse matrix
250  , bool SO2 > // Storage order of the target sparse matrix
251  friend inline void assign( SparseMatrix<MT2,SO2>& lhs, const SMatEvalExpr& rhs )
252  {
254 
255  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
256  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
257 
258  assign( ~lhs, rhs.sm_ );
259  }
261  //**********************************************************************************************
262 
263  //**Addition assignment to dense matrices*******************************************************
275  template< typename MT2 // Type of the target dense matrix
276  , bool SO2 > // Storage order of the target dense matrix
277  friend inline void addAssign( DenseMatrix<MT2,SO2>& lhs, const SMatEvalExpr& rhs )
278  {
280 
281  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
282  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
283 
284  addAssign( ~lhs, rhs.sm_ );
285  }
287  //**********************************************************************************************
288 
289  //**Addition assignment to sparse matrices******************************************************
301  template< typename MT2 // Type of the target sparse matrix
302  , bool SO2 > // Storage order of the target sparse matrix
303  friend inline void addAssign( SparseMatrix<MT2,SO2>& lhs, const SMatEvalExpr& rhs )
304  {
306 
307  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
308  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
309 
310  addAssign( ~lhs, rhs.sm_ );
311  }
313  //**********************************************************************************************
314 
315  //**Subtraction assignment to dense matrices****************************************************
327  template< typename MT2 // Type of the target dense matrix
328  , bool SO2 > // Storage order of the target dense matrix
329  friend inline void subAssign( DenseMatrix<MT2,SO2>& lhs, const SMatEvalExpr& rhs )
330  {
332 
333  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
334  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
335 
336  subAssign( ~lhs, rhs.sm_ );
337  }
339  //**********************************************************************************************
340 
341  //**Subtraction assignment to sparse matrices***************************************************
353  template< typename MT2 // Type of the target sparse matrix
354  , bool SO2 > // Storage order of the target sparse matrix
355  friend inline void subAssign( SparseMatrix<MT2,SO2>& lhs, const SMatEvalExpr& rhs )
356  {
358 
359  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
360  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
361 
362  subAssign( ~lhs, rhs.sm_ );
363  }
365  //**********************************************************************************************
366 
367  //**Multiplication assignment to dense matrices*************************************************
379  template< typename MT2 // Type of the target dense matrix
380  , bool SO2 > // Storage order of the target dense matrix
381  friend inline void multAssign( DenseMatrix<MT2,SO2>& lhs, const SMatEvalExpr& rhs )
382  {
384 
385  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
386  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
387 
388  multAssign( ~lhs, rhs.sm_ );
389  }
391  //**********************************************************************************************
392 
393  //**Multiplication assignment to sparse matrices************************************************
405  template< typename MT2 // Type of the target sparse matrix
406  , bool SO2 > // Storage order of the target sparse matrix
407  friend inline void multAssign( SparseMatrix<MT2,SO2>& lhs, const SMatEvalExpr& rhs )
408  {
410 
411  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
412  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
413 
414  multAssign( ~lhs, rhs.sm_ );
415  }
417  //**********************************************************************************************
418 
419  //**Compile time checks*************************************************************************
424  //**********************************************************************************************
425 };
426 //*************************************************************************************************
427 
428 
429 
430 
431 //=================================================================================================
432 //
433 // GLOBAL FUNCTIONS
434 //
435 //=================================================================================================
436 
437 //*************************************************************************************************
454 template< typename MT // Type of the sparse matrix
455  , bool SO > // Storage order
457 {
459 
460  return SMatEvalExpr<MT,SO>( ~sm );
461 }
462 //*************************************************************************************************
463 
464 
465 
466 
467 //=================================================================================================
468 //
469 // GLOBAL RESTRUCTURING FUNCTIONS
470 //
471 //=================================================================================================
472 
473 //*************************************************************************************************
484 template< typename MT // Type of the sparse matrix
485  , bool SO > // Storage order
486 inline const SMatEvalExpr<MT,SO> eval( const SMatEvalExpr<MT,SO>& sm )
487 {
488  return sm;
489 }
491 //*************************************************************************************************
492 
493 
494 
495 
496 //=================================================================================================
497 //
498 // EXPRESSION TRAIT SPECIALIZATIONS
499 //
500 //=================================================================================================
501 
502 //*************************************************************************************************
504 template< typename MT >
505 struct SMatEvalExprTrait< SMatEvalExpr<MT,false> >
506 {
507  public:
508  //**********************************************************************************************
509  typedef typename SelectType< IsSparseMatrix<MT>::value && IsRowMajorMatrix<MT>::value
510  , SMatEvalExpr<MT,false>
511  , INVALID_TYPE >::Type Type;
512  //**********************************************************************************************
513 };
515 //*************************************************************************************************
516 
517 
518 //*************************************************************************************************
520 template< typename MT >
521 struct TSMatEvalExprTrait< SMatEvalExpr<MT,true> >
522 {
523  public:
524  //**********************************************************************************************
525  typedef typename SelectType< IsSparseMatrix<MT>::value && IsColumnMajorMatrix<MT>::value
526  , SMatEvalExpr<MT,true>
527  , INVALID_TYPE >::Type Type;
528  //**********************************************************************************************
529 };
531 //*************************************************************************************************
532 
533 
534 //*************************************************************************************************
536 template< typename MT, bool SO >
537 struct SubmatrixExprTrait< SMatEvalExpr<MT,SO> >
538 {
539  public:
540  //**********************************************************************************************
541  typedef typename EvalExprTrait< typename SubmatrixExprTrait<const MT>::Type >::Type Type;
542  //**********************************************************************************************
543 };
545 //*************************************************************************************************
546 
547 
548 //*************************************************************************************************
550 template< typename MT, bool SO >
551 struct RowExprTrait< SMatEvalExpr<MT,SO> >
552 {
553  public:
554  //**********************************************************************************************
555  typedef typename EvalExprTrait< typename RowExprTrait<const MT>::Type >::Type Type;
556  //**********************************************************************************************
557 };
559 //*************************************************************************************************
560 
561 
562 //*************************************************************************************************
564 template< typename MT, bool SO >
565 struct ColumnExprTrait< SMatEvalExpr<MT,SO> >
566 {
567  public:
568  //**********************************************************************************************
569  typedef typename EvalExprTrait< typename ColumnExprTrait<const MT>::Type >::Type Type;
570  //**********************************************************************************************
571 };
573 //*************************************************************************************************
574 
575 } // namespace blaze
576 
577 #endif
MT::OppositeType OppositeType
Result type with opposite storage order for expression template evaluations.
Definition: SMatEvalExpr.h:95
SMatEvalExpr< MT, SO > This
Type of this SMatEvalExpr instance.
Definition: SMatEvalExpr.h:93
size_t columns() const
Returns the current number of columns of the matrix.
Definition: SMatEvalExpr.h:146
Header file for the IsSparseMatrix type trait.
#define BLAZE_CONSTRAINT_MUST_BE_MATRIX_WITH_STORAGE_ORDER(T, SO)
Constraint on the data type.In case the given data type T is not a dense or sparse matrix type and in...
Definition: StorageOrder.h:242
Header file for the ColumnExprTrait class template.
Header file for the TSMatEvalExprTrait class template.
Header file for the IsColumnMajorMatrix type trait.
Operand operand() const
Returns the sparse matrix operand.
Definition: SMatEvalExpr.h:177
Header file for the MatEvalExpr base class.
MT::ElementType ElementType
Resulting element type.
Definition: SMatEvalExpr.h:97
Header file for the Computation base class.
Header file for the RequiresEvaluation type trait.
CompressedMatrix< Type, false > OppositeType
Result type with opposite storage order for expression template evaluations.
Definition: CompressedMatrix.h:2371
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
SelectType< IsExpression< MT >::value, const MT, const MT & >::Type Operand
Composite data type of the sparse matrix expression.
Definition: SMatEvalExpr.h:104
Constraint on the data type.
const ResultType CompositeType
Data type for composite expression templates.
Definition: SMatEvalExpr.h:101
Header file for the SparseMatrix base class.
Constraint on the data type.
Operand sm_
Sparse matrix of the evaluation expression.
Definition: SMatEvalExpr.h:208
Header file for the SMatEvalExprTrait class template.
Compile time type selection.The SelectType class template selects one of the two given types T1 and T...
Definition: SelectType.h:59
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
size_t nonZeros(size_t i) const
Returns the number of non-zero elements in the specified row.
Definition: SMatEvalExpr.h:167
CompressedMatrix< Type, false > TransposeType
Transpose type for expression template evaluations.
Definition: CompressedMatrix.h:2372
Constraints on the storage order of matrix types.
Type ElementType
Type of the sparse matrix elements.
Definition: CompressedMatrix.h:2373
void multAssign(Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the multiplication assignment of a matrix to a matrix.
Definition: Matrix.h:269
MT::ResultType ResultType
Result type for expression template evaluations.
Definition: SMatEvalExpr.h:94
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 EnableIf class template.
bool isAliased(const T *alias) const
Returns whether the expression is aliased with the given address alias.
Definition: SMatEvalExpr.h:201
bool canAlias(const T *alias) const
Returns whether the expression can alias with the given address alias.
Definition: SMatEvalExpr.h:189
Header file for the SubmatrixExprTrait class template.
const Type & ReturnType
Return type for expression template evaluations.
Definition: CompressedMatrix.h:2374
SMatEvalExpr(const MT &sm)
Constructor for the SMatEvalExpr class.
Definition: SMatEvalExpr.h:112
Header file for run time assertion macros.
Utility type for generic codes.
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
Header file for the EvalExprTrait class template.
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
const DMatEvalExpr< MT, SO > eval(const DenseMatrix< MT, SO > &dm)
Forces the evaluation of the given dense matrix expression dm.
Definition: DMatEvalExpr.h:395
size_t nonZeros() const
Returns the number of non-zero elements in the sparse matrix.
Definition: SMatEvalExpr.h:156
ReturnType operator()(size_t i, size_t j) const
2D-access to the matrix elements.
Definition: SMatEvalExpr.h:124
Header file for the IsRowMajorMatrix type trait.
#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
MT::ReturnType ReturnType
Return type for expression template evaluations.
Definition: SMatEvalExpr.h:98
This ResultType
Result type for expression template evaluations.
Definition: CompressedMatrix.h:2370
Header file for basic type definitions.
Expression object for the forced evaluation of sparse matrices.The SMatEvalExpr class represents the ...
Definition: Forward.h:90
MT::TransposeType TransposeType
Transpose type for expression template evaluations.
Definition: SMatEvalExpr.h:96
size_t rows() const
Returns the current number of rows of the matrix.
Definition: SMatEvalExpr.h:136
#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
Header file for the IsExpression type trait class.
Header file for the FunctionTrace class.