All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SMatTransExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_SMATTRANSEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_SMATTRANSEXPR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <iterator>
59 #include <blaze/util/Assert.h>
61 #include <blaze/util/EmptyType.h>
62 #include <blaze/util/EnableIf.h>
64 #include <blaze/util/SelectType.h>
65 #include <blaze/util/Types.h>
67 
68 
69 namespace blaze {
70 
71 //=================================================================================================
72 //
73 // CLASS SMATTRANSEXPR
74 //
75 //=================================================================================================
76 
77 //*************************************************************************************************
84 template< typename MT // Type of the sparse matrix
85  , bool SO > // Storage order
86 class SMatTransExpr : public SparseMatrix< SMatTransExpr<MT,SO>, SO >
87  , private MatTransExpr
88  , private SelectType< IsComputation<MT>::value, Computation, EmptyType >::Type
89 {
90  private:
91  //**Type definitions****************************************************************************
92  typedef typename MT::ResultType RT;
93  typedef typename MT::CompositeType CT;
94  //**********************************************************************************************
95 
96  //**********************************************************************************************
98 
104  enum { useAssign = RequiresEvaluation<MT>::value };
105  //**********************************************************************************************
106 
107  //**********************************************************************************************
109  template< typename MT2 >
111  struct UseAssign {
112  enum { value = useAssign };
113  };
115  //**********************************************************************************************
116 
117  public:
118  //**Type definitions****************************************************************************
120  typedef typename MT::TransposeType ResultType;
121  typedef typename MT::OppositeType OppositeType;
122  typedef typename MT::ResultType TransposeType;
123  typedef typename MT::ElementType ElementType;
124  typedef typename MT::ReturnType ReturnType;
125 
128 
130  typedef typename SelectType< IsExpression<MT>::value, const MT, const MT& >::Type Operand;
131  //**********************************************************************************************
132 
133  //**ConstIterator class definition**************************************************************
137  {
138  public:
139  //**Type definitions*************************************************************************
142 
143  typedef std::forward_iterator_tag IteratorCategory;
144  typedef typename std::iterator_traits<IteratorType>::value_type ValueType;
145  typedef typename std::iterator_traits<IteratorType>::pointer PointerType;
146  typedef typename std::iterator_traits<IteratorType>::reference ReferenceType;
147  typedef typename std::iterator_traits<IteratorType>::difference_type DifferenceType;
148 
149  // STL iterator requirements
155  //*******************************************************************************************
156 
157  //**Constructor******************************************************************************
161  : it_( it ) // Iterator over the elements of the sparse matrix expression
162  {}
163  //*******************************************************************************************
164 
165  //**Prefix increment operator****************************************************************
171  ++it_;
172  return *this;
173  }
174  //*******************************************************************************************
175 
176  //**Element access operator******************************************************************
181  inline const ValueType operator*() const {
182  return *it_;
183  }
184  //*******************************************************************************************
185 
186  //**Element access operator******************************************************************
191  inline const IteratorType operator->() const {
192  return it_;
193  }
194  //*******************************************************************************************
195 
196  //**Value function***************************************************************************
201  inline ReturnType value() const {
202  return it_->value();
203  }
204  //*******************************************************************************************
205 
206  //**Index function***************************************************************************
211  inline size_t index() const {
212  return it_->index();
213  }
214  //*******************************************************************************************
215 
216  //**Equality operator************************************************************************
222  inline bool operator==( const ConstIterator& rhs ) const {
223  return it_ == rhs.it_;
224  }
225  //*******************************************************************************************
226 
227  //**Inequality operator**********************************************************************
233  inline bool operator!=( const ConstIterator& rhs ) const {
234  return it_ != rhs.it_;
235  }
236  //*******************************************************************************************
237 
238  //**Subtraction operator*********************************************************************
244  inline DifferenceType operator-( const ConstIterator& rhs ) const {
245  return it_ - rhs.it_;
246  }
247  //*******************************************************************************************
248 
249  private:
250  //**Member variables*************************************************************************
252  //*******************************************************************************************
253  };
254  //**********************************************************************************************
255 
256  //**Constructor*********************************************************************************
261  explicit inline SMatTransExpr( const MT& sm )
262  : sm_( sm )
263  {}
264  //**********************************************************************************************
265 
266  //**Access operator*****************************************************************************
273  inline ReturnType operator()( size_t i, size_t j ) const {
274  BLAZE_INTERNAL_ASSERT( i < sm_.columns(), "Invalid row access index" );
275  BLAZE_INTERNAL_ASSERT( j < sm_.rows() , "Invalid column access index" );
276  return sm_(j,i);
277  }
278  //**********************************************************************************************
279 
280  //**Begin function******************************************************************************
286  inline ConstIterator begin( size_t i ) const {
287  return sm_.begin(i);
288  }
289  //**********************************************************************************************
290 
291  //**End function********************************************************************************
297  inline ConstIterator end( size_t i ) const {
298  return sm_.end(i);
299  }
300  //**********************************************************************************************
301 
302  //**Rows function*******************************************************************************
307  inline size_t rows() const {
308  return sm_.columns();
309  }
310  //**********************************************************************************************
311 
312  //**Columns function****************************************************************************
317  inline size_t columns() const {
318  return sm_.rows();
319  }
320  //**********************************************************************************************
321 
322  //**NonZeros function***************************************************************************
327  inline size_t nonZeros() const {
328  return sm_.nonZeros();
329  }
330  //**********************************************************************************************
331 
332  //**Operand access******************************************************************************
337  inline Operand operand() const {
338  return sm_;
339  }
340  //**********************************************************************************************
341 
342  //**********************************************************************************************
348  template< typename T >
349  inline bool canAlias( const T* alias ) const {
350  return sm_.canAlias( alias );
351  }
352  //**********************************************************************************************
353 
354  //**********************************************************************************************
360  template< typename T >
361  inline bool isAliased( const T* alias ) const {
362  return sm_.isAliased( alias );
363  }
364  //**********************************************************************************************
365 
366  private:
367  //**Member variables****************************************************************************
369  //**********************************************************************************************
370 
371  //**Assignment to dense matrices****************************************************************
385  template< typename MT2 // Type of the target dense matrix
386  , bool SO2 > // Storage order of the target dense matrix
387  friend inline typename EnableIf< UseAssign<MT2> >::Type
388  assign( DenseMatrix<MT2,SO2>& lhs, const SMatTransExpr& rhs )
389  {
391 
392  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
393  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
394 
395  DMatTransposer<MT2,!SO2> tmp( ~lhs );
396  assign( tmp, rhs.sm_ );
397  }
399  //**********************************************************************************************
400 
401  //**Assignment to sparse matrices***************************************************************
415  template< typename MT2 // Type of the target sparse matrix
416  , bool SO2 > // Storage order of the target sparse matrix
417  friend inline typename EnableIf< UseAssign<MT2> >::Type
418  assign( SparseMatrix<MT2,SO2>& lhs, const SMatTransExpr& rhs )
419  {
421 
422  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
423  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
424 
425  SMatTransposer<MT2,!SO2> tmp( ~lhs );
426  assign( tmp, rhs.sm_ );
427  }
429  //**********************************************************************************************
430 
431  //**Addition assignment to dense matrices*******************************************************
445  template< typename MT2 // Type of the target dense matrix
446  , bool SO2 > // Storage order of the target dense matrix
447  friend inline typename EnableIf< UseAssign<MT2> >::Type
448  addAssign( DenseMatrix<MT2,SO2>& lhs, const SMatTransExpr& rhs )
449  {
451 
452  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
453  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
454 
455  DMatTransposer<MT2,!SO2> tmp( ~lhs );
456  addAssign( tmp, rhs.sm_ );
457  }
459  //**********************************************************************************************
460 
461  //**Addition assignment to sparse matrices******************************************************
462  // No special implementation for the addition assignment to sparse matrices.
463  //**********************************************************************************************
464 
465  //**Subtraction assignment to dense matrices****************************************************
479  template< typename MT2 // Type of the target dense matrix
480  , bool SO2 > // Storage order of the target dense matrix
481  friend inline typename EnableIf< UseAssign<MT2> >::Type
482  subAssign( DenseMatrix<MT2,SO2>& lhs, const SMatTransExpr& rhs )
483  {
485 
486  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
487  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
488 
489  DMatTransposer<MT2,!SO2> tmp( ~lhs );
490  subAssign( tmp, rhs.sm_ );
491  }
493  //**********************************************************************************************
494 
495  //**Subtraction assignment to sparse matrices***************************************************
496  // No special implementation for the subtraction assignment to sparse matrices.
497  //**********************************************************************************************
498 
499  //**Multiplication assignment to dense matrices*************************************************
500  // No special implementation for the multiplication assignment to dense matrices.
501  //**********************************************************************************************
502 
503  //**Multiplication assignment to sparse matrices************************************************
504  // No special implementation for the multiplication assignment to sparse matrices.
505  //**********************************************************************************************
506 
507  //**Trans function******************************************************************************
523  template< typename MT2 // Type of the sparse matrix
524  , bool SO2 > // Storage order of the sparse matrix
525  friend inline Operand trans( const SMatTransExpr<MT2,SO2>& sm )
526  {
528 
529  return sm.sm_;
530  }
532  //**********************************************************************************************
533 
534  //**Compile time checks*************************************************************************
539  //**********************************************************************************************
540 };
541 //*************************************************************************************************
542 
543 
544 
545 
546 //=================================================================================================
547 //
548 // GLOBAL OPERATORS
549 //
550 //=================================================================================================
551 
552 //*************************************************************************************************
567 template< typename MT // Type of the sparse matrix
568  , bool SO > // Storage order
570 {
572 
573  return SMatTransExpr<MT,!SO>( ~sm );
574 }
575 //*************************************************************************************************
576 
577 
578 
579 
580 //=================================================================================================
581 //
582 // EXPRESSION TRAIT SPECIALIZATIONS
583 //
584 //=================================================================================================
585 
586 //*************************************************************************************************
588 template< typename MT, bool SO >
589 struct SubmatrixExprTrait< SMatTransExpr<MT,SO> >
590 {
591  public:
592  //**********************************************************************************************
593  typedef typename TransExprTrait< typename SubmatrixExprTrait<const MT>::Type >::Type Type;
594  //**********************************************************************************************
595 };
597 //*************************************************************************************************
598 
599 
600 //*************************************************************************************************
602 template< typename MT, bool SO >
603 struct RowExprTrait< SMatTransExpr<MT,SO> >
604 {
605  public:
606  //**********************************************************************************************
607  typedef typename TransExprTrait< typename ColumnExprTrait<const MT>::Type >::Type Type;
608  //**********************************************************************************************
609 };
611 //*************************************************************************************************
612 
613 
614 //*************************************************************************************************
616 template< typename MT, bool SO >
617 struct ColumnExprTrait< SMatTransExpr<MT,SO> >
618 {
619  public:
620  //**********************************************************************************************
621  typedef typename TransExprTrait< typename RowExprTrait<const MT>::Type >::Type Type;
622  //**********************************************************************************************
623 };
625 //*************************************************************************************************
626 
627 } // namespace blaze
628 
629 #endif
Header file for the sparse matrix transposer.
bool operator!=(const ConstIterator &rhs) const
Inequality comparison between two ConstIterator objects.
Definition: SMatTransExpr.h:233
RemoveReference< Operand >::Type::ConstIterator IteratorType
Iterator type of the sparse matrix expression.
Definition: SMatTransExpr.h:141
MT::OppositeType OppositeType
Result type with opposite storage order for expression template evaluations.
Definition: SMatTransExpr.h:121
ConstIterator begin(size_t i) const
Returns an iterator to the first non-zero element of row/column i.
Definition: SMatTransExpr.h:286
const DMatTransExpr< MT,!SO > trans(const DenseMatrix< MT, SO > &dm)
Calculation of the transpose of the given dense matrix.
Definition: DMatTransExpr.h:446
PointerType pointer
Pointer return type.
Definition: SMatTransExpr.h:152
#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 MatTransExpr base class.
Iterator over the elements of the sparse matrix transposition expression.
Definition: SMatTransExpr.h:136
Header file for the ColumnExprTrait class template.
MT::CompositeType CT
Composite type of the sparse matrix expression.
Definition: SMatTransExpr.h:93
Operand sm_
Sparse matrix of the transposition expression.
Definition: SMatTransExpr.h:368
const This & CompositeType
Data type for composite expression templates.
Definition: CompressedMatrix.h:2375
DifferenceType operator-(const ConstIterator &rhs) const
Calculating the number of elements between two expression iterators.
Definition: SMatTransExpr.h:244
Header file for the Computation base class.
MT::ResultType RT
Result type of the sparse matrix expression.
Definition: SMatTransExpr.h:92
Header file for the RequiresEvaluation type trait.
std::iterator_traits< IteratorType >::value_type ValueType
Type of the underlying pointers.
Definition: SMatTransExpr.h:144
CompressedMatrix< Type, false > OppositeType
Result type with opposite storage order for expression template evaluations.
Definition: CompressedMatrix.h:2371
ReferenceType reference
Reference return type.
Definition: SMatTransExpr.h:153
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.
Header file for the SparseMatrix base class.
Constraint on the data type.
std::iterator_traits< IteratorType >::difference_type DifferenceType
Difference between two iterators.
Definition: SMatTransExpr.h:147
Compile time check to query the requirement to evaluate an expression.Via this type trait it is possi...
Definition: RequiresEvaluation.h:90
MT::ResultType TransposeType
Transpose type for expression template evaluations.
Definition: SMatTransExpr.h:122
MT::ReturnType ReturnType
Return type for expression template evaluations.
Definition: SMatTransExpr.h:124
MT::TransposeType ResultType
Result type for expression template evaluations.
Definition: SMatTransExpr.h:120
Compile time type selection.The SelectType class template selects one of the two given types T1 and T...
Definition: SelectType.h:59
std::iterator_traits< IteratorType >::reference ReferenceType
Reference return type.
Definition: SMatTransExpr.h:146
bool canAlias(const T *alias) const
Returns whether the expression can alias with the given address alias.
Definition: SMatTransExpr.h:349
SMatTransExpr(const MT &sm)
Constructor for the SMatTransExpr class.
Definition: SMatTransExpr.h:261
IteratorType it_
Iterator over the elements of the sparse matrix expression.
Definition: SMatTransExpr.h:251
MT::ElementType ElementType
Resulting element type.
Definition: SMatTransExpr.h:123
IteratorCategory iterator_category
The iterator category.
Definition: SMatTransExpr.h:150
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 columns() const
Returns the current number of columns of the matrix.
Definition: SMatTransExpr.h:317
Expression object for the transposition of a dense matrix.The DMatTransposer class is a wrapper objec...
Definition: DMatTransposer.h:71
ConstIterator(IteratorType it)
Constructor for the ConstIterator class.
Definition: SMatTransExpr.h:160
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
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.
Header file for the dense matrix transposer.
const IteratorType operator->() const
Direct access to the sparse matrix element at the current iterator position.
Definition: SMatTransExpr.h:191
Expression object for the transposition of a sparse matrix.The SMatTransposer class is a wrapper obje...
Definition: Forward.h:100
ReturnType operator()(size_t i, size_t j) const
2D-access to the matrix elements.
Definition: SMatTransExpr.h:273
Header file for the SubmatrixExprTrait class template.
const Type & ReturnType
Return type for expression template evaluations.
Definition: CompressedMatrix.h:2374
Removal of reference modifiers.The RemoveCV type trait removes any reference modifiers from the given...
Definition: RemoveReference.h:69
SelectType< IsExpression< MT >::value, const MT, const MT & >::Type Operand
Composite data type of the sparse matrix expression.
Definition: SMatTransExpr.h:130
Header file for run time assertion macros.
SelectType< useAssign, const ResultType, const SMatTransExpr & >::Type CompositeType
Data type for composite expression templates.
Definition: SMatTransExpr.h:127
SMatTransExpr< MT, SO > This
Type of this SMatTransExpr instance.
Definition: SMatTransExpr.h:119
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
Substitution Failure Is Not An Error (SFINAE) class.The EnableIf class template is an auxiliary tool ...
Definition: EnableIf.h:184
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
std::iterator_traits< IteratorType >::pointer PointerType
Pointer return type.
Definition: SMatTransExpr.h:145
Header file for the TransExprTrait class template.
Operand operand() const
Returns the sparse matrix operand.
Definition: SMatTransExpr.h:337
size_t nonZeros() const
Returns the number of non-zero elements in the sparse matrix.
Definition: SMatTransExpr.h:327
size_t rows() const
Returns the current number of rows of the matrix.
Definition: SMatTransExpr.h:307
Header file for the RemoveReference type trait.
std::forward_iterator_tag IteratorCategory
The iterator category.
Definition: SMatTransExpr.h:143
DifferenceType difference_type
Difference between two iterators.
Definition: SMatTransExpr.h:154
ReturnType value() const
Access to the current value of the sparse element.
Definition: SMatTransExpr.h:201
size_t index() const
Access to the current index of the sparse element.
Definition: SMatTransExpr.h:211
bool operator==(const ConstIterator &rhs) const
Equality comparison between two ConstIterator objects.
Definition: SMatTransExpr.h:222
Header file for the IsComputation type trait class.
#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
Expression object for sparse matrix transpositions.The SMatTransExpr class represents the compile tim...
Definition: Forward.h:99
This ResultType
Result type for expression template evaluations.
Definition: CompressedMatrix.h:2370
ConstIterator end(size_t i) const
Returns an iterator just past the last non-zero element of row/column i.
Definition: SMatTransExpr.h:297
Header file for basic type definitions.
const ValueType operator*() const
Direct access to the sparse matrix element at the current iterator position.
Definition: SMatTransExpr.h:181
ValueType value_type
Type of the underlying pointers.
Definition: SMatTransExpr.h:151
ConstIterator & operator++()
Pre-increment operator.
Definition: SMatTransExpr.h:170
bool isAliased(const T *alias) const
Returns whether the expression is aliased with the given address alias.
Definition: SMatTransExpr.h:361
Header file for the empty type.
#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.