DMatTransposer.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_DMATTRANSPOSER_H_
36 #define _BLAZE_MATH_EXPRESSIONS_DMATTRANSPOSER_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <blaze/math/Aliases.h>
46 #include <blaze/math/Exception.h>
55 #include <blaze/system/Inline.h>
56 #include <blaze/util/Assert.h>
57 #include <blaze/util/Types.h>
58 
59 
60 namespace blaze {
61 
62 //=================================================================================================
63 //
64 // CLASS DMATTRANSPOSER
65 //
66 //=================================================================================================
67 
68 //*************************************************************************************************
74 template< typename MT // Type of the dense matrix
75  , bool SO > // Storage order
77  : public DenseMatrix< DMatTransposer<MT,SO>, SO >
78 {
79  public:
80  //**Type definitions****************************************************************************
89  using CompositeType = const This&;
96  //**********************************************************************************************
97 
98  //**Compilation flags***************************************************************************
100 
103  static constexpr bool simdEnabled = MT::simdEnabled;
104 
106 
109  static constexpr bool smpAssignable = MT::smpAssignable;
110  //**********************************************************************************************
111 
112  //**Constructor*********************************************************************************
117  explicit inline DMatTransposer( MT& dm ) noexcept
118  : dm_( dm ) // The dense matrix operand
119  {}
120  //**********************************************************************************************
121 
122  //**Access operator*****************************************************************************
129  inline Reference operator()( size_t i, size_t j ) {
130  BLAZE_INTERNAL_ASSERT( i < dm_.columns(), "Invalid row access index" );
131  BLAZE_INTERNAL_ASSERT( j < dm_.rows() , "Invalid column access index" );
132  return dm_(j,i);
133  }
134  //**********************************************************************************************
135 
136  //**Access operator*****************************************************************************
143  inline ConstReference operator()( size_t i, size_t j ) const {
144  BLAZE_INTERNAL_ASSERT( i < dm_.columns(), "Invalid row access index" );
145  BLAZE_INTERNAL_ASSERT( j < dm_.rows() , "Invalid column access index" );
146  return const_cast<const MT&>( dm_ )(j,i);
147  }
148  //**********************************************************************************************
149 
150  //**At function*********************************************************************************
158  inline Reference at( size_t i, size_t j ) {
159  if( i >= dm_.columns() ) {
160  BLAZE_THROW_OUT_OF_RANGE( "Invalid row access index" );
161  }
162  if( j >= dm_.rows() ) {
163  BLAZE_THROW_OUT_OF_RANGE( "Invalid column access index" );
164  }
165  return (*this)(i,j);
166  }
167  //**********************************************************************************************
168 
169  //**At function*********************************************************************************
177  inline ConstReference at( size_t i, size_t j ) const {
178  if( i >= dm_.columns() ) {
179  BLAZE_THROW_OUT_OF_RANGE( "Invalid row access index" );
180  }
181  if( j >= dm_.rows() ) {
182  BLAZE_THROW_OUT_OF_RANGE( "Invalid column access index" );
183  }
184  return (*this)(i,j);
185  }
186  //**********************************************************************************************
187 
188  //**Low-level data access***********************************************************************
193  inline Pointer data() noexcept {
194  return dm_.data();
195  }
196  //**********************************************************************************************
197 
198  //**Low-level data access***********************************************************************
203  inline ConstPointer data() const noexcept {
204  return dm_.data();
205  }
206  //**********************************************************************************************
207 
208  //**Begin function******************************************************************************
219  inline Iterator begin( size_t i ) {
220  return dm_.begin( i );
221  }
222  //**********************************************************************************************
223 
224  //**Begin function******************************************************************************
235  inline ConstIterator begin( size_t i ) const {
236  return dm_.cbegin( i );
237  }
238  //**********************************************************************************************
239 
240  //**Cbegin function*****************************************************************************
251  inline ConstIterator cbegin( size_t i ) const {
252  return dm_.cbegin( i );
253  }
254  //**********************************************************************************************
255 
256  //**End function********************************************************************************
267  inline Iterator end( size_t i ) {
268  return dm_.end( i );
269  }
270  //**********************************************************************************************
271 
272  //**End function********************************************************************************
283  inline ConstIterator end( size_t i ) const {
284  return dm_.cend( i );
285  }
286  //**********************************************************************************************
287 
288  //**Cend function*******************************************************************************
299  inline ConstIterator cend( size_t i ) const {
300  return dm_.cend( i );
301  }
302  //**********************************************************************************************
303 
304  //**Rows function*******************************************************************************
309  inline size_t rows() const noexcept {
310  return dm_.columns();
311  }
312  //**********************************************************************************************
313 
314  //**Columns function****************************************************************************
319  inline size_t columns() const noexcept {
320  return dm_.rows();
321  }
322  //**********************************************************************************************
323 
324  //**Spacing function****************************************************************************
329  inline size_t spacing() const noexcept {
330  return dm_.spacing();
331  }
332  //**********************************************************************************************
333 
334  //**Reset function******************************************************************************
339  inline void reset() {
340  return dm_.reset();
341  }
342  //**********************************************************************************************
343 
344  //**IsIntact function***************************************************************************
349  inline bool isIntact() const noexcept {
350  using blaze::isIntact;
351  return isIntact( dm_ );
352  }
353  //**********************************************************************************************
354 
355  //**CanAliased function*************************************************************************
361  template< typename Other > // Data type of the foreign expression
362  inline bool canAlias( const Other* alias ) const noexcept
363  {
364  return dm_.canAlias( alias );
365  }
366  //**********************************************************************************************
367 
368  //**IsAliased function**************************************************************************
374  template< typename Other > // Data type of the foreign expression
375  inline bool isAliased( const Other* alias ) const noexcept
376  {
377  return dm_.isAliased( alias );
378  }
379  //**********************************************************************************************
380 
381  //**IsAligned function**************************************************************************
386  inline bool isAligned() const noexcept
387  {
388  return dm_.isAligned();
389  }
390  //**********************************************************************************************
391 
392  //**CanSMPAssign function***********************************************************************
397  inline bool canSMPAssign() const noexcept
398  {
399  return dm_.canSMPAssign();
400  }
401  //**********************************************************************************************
402 
403  //**Load function*******************************************************************************
414  BLAZE_ALWAYS_INLINE SIMDType load( size_t i, size_t j ) const noexcept
415  {
416  return dm_.load( j, i );
417  }
418  //**********************************************************************************************
419 
420  //**Loada function******************************************************************************
431  BLAZE_ALWAYS_INLINE SIMDType loada( size_t i, size_t j ) const noexcept
432  {
433  return dm_.loada( j, i );
434  }
435  //**********************************************************************************************
436 
437  //**Loadu function******************************************************************************
448  BLAZE_ALWAYS_INLINE SIMDType loadu( size_t i, size_t j ) const noexcept
449  {
450  return dm_.loadu( j, i );
451  }
452  //**********************************************************************************************
453 
454  //**Store function******************************************************************************
466  BLAZE_ALWAYS_INLINE void store( size_t i, size_t j, const SIMDType& value ) noexcept
467  {
468  dm_.store( j, i, value );
469  }
470  //**********************************************************************************************
471 
472  //**Storea function******************************************************************************
484  BLAZE_ALWAYS_INLINE void storea( size_t i, size_t j, const SIMDType& value ) noexcept
485  {
486  dm_.storea( j, i, value );
487  }
488  //**********************************************************************************************
489 
490  //**Storeu function*****************************************************************************
502  BLAZE_ALWAYS_INLINE void storeu( size_t i, size_t j, const SIMDType& value ) noexcept
503  {
504  dm_.storeu( j, i, value );
505  }
506  //**********************************************************************************************
507 
508  //**Stream function*****************************************************************************
520  BLAZE_ALWAYS_INLINE void stream( size_t i, size_t j, const SIMDType& value ) noexcept
521  {
522  dm_.stream( j, i, value );
523  }
524  //**********************************************************************************************
525 
526  //**Transpose assignment of matrices************************************************************
537  template< typename MT2 // Type of the right-hand side matrix
538  , bool SO2 > // Storage order of the right-hand side matrix
539  inline void assign( const Matrix<MT2,SO2>& rhs )
540  {
541  dm_.assign( trans( ~rhs ) );
542  }
543  //**********************************************************************************************
544 
545  //**Transpose addition assignment of matrices***************************************************
556  template< typename MT2 // Type of the right-hand side matrix
557  , bool SO2 > // Storage order of the right-hand side matrix
558  inline void addAssign( const Matrix<MT2,SO2>& rhs )
559  {
560  dm_.addAssign( trans( ~rhs ) );
561  }
562  //**********************************************************************************************
563 
564  //**Transpose subtraction assignment of matrices************************************************
575  template< typename MT2 // Type of the right-hand side matrix
576  , bool SO2 > // Storage order of the right-hand side matrix
577  inline void subAssign( const Matrix<MT2,SO2>& rhs )
578  {
579  dm_.subAssign( trans( ~rhs ) );
580  }
581  //**********************************************************************************************
582 
583  //**Transpose Schur product assignment of matrices**********************************************
594  template< typename MT2 // Type of the right-hand side matrix
595  , bool SO2 > // Storage order of the right-hand side matrix
596  inline void schurAssign( const Matrix<MT2,SO2>& rhs )
597  {
598  dm_.schurAssign( trans( ~rhs ) );
599  }
600  //**********************************************************************************************
601 
602  //**Transpose multiplication assignment of matrices*********************************************
603  // No special implementation for the transpose multiplication assignment of matrices.
604  //**********************************************************************************************
605 
606  private:
607  //**Member variables****************************************************************************
608  MT& dm_;
609  //**********************************************************************************************
610 
611  //**Compile time checks*************************************************************************
616  //**********************************************************************************************
617 };
618 //*************************************************************************************************
619 
620 
621 
622 
623 //=================================================================================================
624 //
625 // GLOBAL OPERATORS
626 //
627 //=================================================================================================
628 
629 //*************************************************************************************************
637 template< typename MT // Type of the dense matrix
638  , bool SO > // Storage order
639 inline void reset( DMatTransposer<MT,SO>& m )
640 {
641  m.reset();
642 }
644 //*************************************************************************************************
645 
646 
647 //*************************************************************************************************
655 template< typename MT // Type of the dense matrix
656  , bool SO > // Storage order
657 inline bool isIntact( const DMatTransposer<MT,SO>& m ) noexcept
658 {
659  return m.isIntact();
660 }
662 //*************************************************************************************************
663 
664 
665 
666 
667 //=================================================================================================
668 //
669 // SIZE SPECIALIZATIONS
670 //
671 //=================================================================================================
672 
673 //*************************************************************************************************
675 template< typename MT, bool SO >
676 struct Size< DMatTransposer<MT,SO>, 0UL >
677  : public Size<MT,0UL>
678 {};
679 
680 template< typename MT, bool SO >
681 struct Size< DMatTransposer<MT,SO>, 1UL >
682  : public Size<MT,1UL>
683 {};
685 //*************************************************************************************************
686 
687 
688 
689 
690 //=================================================================================================
691 //
692 // MAXSIZE SPECIALIZATIONS
693 //
694 //=================================================================================================
695 
696 //*************************************************************************************************
698 template< typename MT, bool SO >
699 struct MaxSize< DMatTransposer<MT,SO>, 0UL >
700  : public MaxSize<MT,0UL>
701 {};
702 
703 template< typename MT, bool SO >
704 struct MaxSize< DMatTransposer<MT,SO>, 1UL >
705  : public MaxSize<MT,1UL>
706 {};
708 //*************************************************************************************************
709 
710 
711 
712 
713 //=================================================================================================
714 //
715 // HASCONSTDATAACCESS SPECIALIZATIONS
716 //
717 //=================================================================================================
718 
719 //*************************************************************************************************
721 template< typename MT, bool SO >
722 struct HasConstDataAccess< DMatTransposer<MT,SO> >
723  : public HasConstDataAccess<MT>
724 {};
726 //*************************************************************************************************
727 
728 
729 
730 
731 //=================================================================================================
732 //
733 // HASMUTABLEDATAACCESS SPECIALIZATIONS
734 //
735 //=================================================================================================
736 
737 //*************************************************************************************************
739 template< typename MT, bool SO >
740 struct HasMutableDataAccess< DMatTransposer<MT,SO> >
741  : public HasMutableDataAccess<MT>
742 {};
744 //*************************************************************************************************
745 
746 
747 
748 
749 //=================================================================================================
750 //
751 // ISALIGNED SPECIALIZATIONS
752 //
753 //=================================================================================================
754 
755 //*************************************************************************************************
757 template< typename MT, bool SO >
758 struct IsAligned< DMatTransposer<MT,SO> >
759  : public IsAligned<MT>
760 {};
762 //*************************************************************************************************
763 
764 
765 
766 
767 //=================================================================================================
768 //
769 // ISPADDED SPECIALIZATIONS
770 //
771 //=================================================================================================
772 
773 //*************************************************************************************************
775 template< typename MT, bool SO >
776 struct IsPadded< DMatTransposer<MT,SO> >
777  : public IsPadded<MT>
778 {};
780 //*************************************************************************************************
781 
782 } // namespace blaze
783 
784 #endif
Constraint on the data type.
TransposeType_t< MT > ResultType
Result type for expression template evaluations.
Definition: DMatTransposer.h:83
BLAZE_ALWAYS_INLINE void storea(size_t i, size_t j, const SIMDType &value) noexcept
Aligned store of a SIMD element of the matrix.
Definition: DMatTransposer.h:484
Header file for auxiliary alias declarations.
void assign(const Matrix< MT2, SO2 > &rhs)
Implementation of the transpose assignment of a matrix.
Definition: DMatTransposer.h:539
ReturnType_t< MT > ReturnType
Return type for expression template evaluations.
Definition: DMatTransposer.h:88
BLAZE_ALWAYS_INLINE void storeu(size_t i, size_t j, const SIMDType &value) noexcept
Unaligned store of a SIMD element of the matrix.
Definition: DMatTransposer.h:502
ConstIterator cend(size_t i) const
Returns an iterator just past the last non-zero element of row/column i.
Definition: DMatTransposer.h:299
Header file for basic type definitions.
DMatTransposer(MT &dm) noexcept
Constructor for the DMatTransposer class.
Definition: DMatTransposer.h:117
typename T::ResultType ResultType_t
Alias declaration for nested ResultType type definitions.The ResultType_t alias declaration provides ...
Definition: Aliases.h:390
typename T::Reference Reference_t
Alias declaration for nested Reference type definitions.The Reference_t alias declaration provides a ...
Definition: Aliases.h:330
#define BLAZE_CONSTRAINT_MUST_NOT_BE_COMPUTATION_TYPE(T)
Constraint on the data type.In case the given data type T is a computational expression (i...
Definition: Computation.h:81
#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:61
ConstIterator begin(size_t i) const
Returns an iterator to the first non-zero element of row/column i.
Definition: DMatTransposer.h:235
void reset(const DiagonalProxy< MT > &proxy)
Resetting the represented element to the default initial values.
Definition: DiagonalProxy.h:591
static constexpr bool smpAssignable
Compilation flag for SMP assignments.
Definition: CompressedMatrix.h:3113
typename SIMDTrait< T >::Type SIMDTrait_t
Auxiliary alias declaration for the SIMDTrait class template.The SIMDTrait_t alias declaration provid...
Definition: SIMDTrait.h:315
bool canAlias(const Other *alias) const noexcept
Returns whether the matrix can alias with the given address alias.
Definition: DMatTransposer.h:362
SIMDTrait_t< ElementType > SIMDType
SIMD type of the matrix elements.
Definition: DMatTransposer.h:87
void schurAssign(const Matrix< MT2, SO2 > &rhs)
Implementation of the transpose Schur product assignment of a matrix.
Definition: DMatTransposer.h:596
Iterator_t< MT > Iterator
Iterator over non-constant elements.
Definition: DMatTransposer.h:94
typename T::ReturnType ReturnType_t
Alias declaration for nested ReturnType type definitions.The ReturnType_t alias declaration provides ...
Definition: Aliases.h:410
Header file for the SIMD trait.
Header file for the MaxSize type trait.
Pointer data() noexcept
Low-level data access to the matrix elements.
Definition: DMatTransposer.h:193
Base class for dense matrices.The DenseMatrix class is a base class for all dense matrix classes...
Definition: DenseMatrix.h:80
typename T::Pointer Pointer_t
Alias declaration for nested Pointer type definitions.The Pointer_t alias declaration provides a conv...
Definition: Aliases.h:290
typename T::ElementType ElementType_t
Alias declaration for nested ElementType type definitions.The ElementType_t alias declaration provide...
Definition: Aliases.h:170
ConstReference operator()(size_t i, size_t j) const
2D-access to the matrix elements.
Definition: DMatTransposer.h:143
ConstIterator end(size_t i) const
Returns an iterator just past the last non-zero element of row/column i.
Definition: DMatTransposer.h:283
BLAZE_ALWAYS_INLINE SIMDType load(size_t i, size_t j) const noexcept
Load of a SIMD element of the matrix.
Definition: DMatTransposer.h:414
Constraint on the data type.
BLAZE_ALWAYS_INLINE SIMDType loada(size_t i, size_t j) const noexcept
Aligned load of a SIMD element of the matrix.
Definition: DMatTransposer.h:431
Namespace of the Blaze C++ math library.
Definition: Blaze.h:58
#define BLAZE_ALWAYS_INLINE
Platform dependent setup of an enforced inline keyword.
Definition: Inline.h:85
ElementType_t< MT > ElementType
Type of the matrix elements.
Definition: DMatTransposer.h:86
ConstPointer data() const noexcept
Low-level data access to the matrix elements.
Definition: DMatTransposer.h:203
Reference operator()(size_t i, size_t j)
2D-access to the matrix elements.
Definition: DMatTransposer.h:129
#define BLAZE_THROW_OUT_OF_RANGE(MESSAGE)
Macro for the emission of a std::out_of_range exception.This macro encapsulates the default way of Bl...
Definition: Exception.h:331
Header file for the DenseMatrix base class.
void subAssign(const Matrix< MT2, SO2 > &rhs)
Implementation of the transpose subtraction assignment of a matrix.
Definition: DMatTransposer.h:577
size_t spacing() const noexcept
Returns the spacing between the beginning of two rows.
Definition: DMatTransposer.h:329
Expression object for the transposition of a dense matrix.The DMatTransposer class is a wrapper objec...
Definition: DMatTransposer.h:76
bool canSMPAssign() const noexcept
Returns whether the matrix can be used in SMP assignments.
Definition: DMatTransposer.h:397
size_t rows() const noexcept
Returns the current number of rows of the matrix.
Definition: DMatTransposer.h:309
MT & dm_
The dense matrix operand.
Definition: DMatTransposer.h:608
Header file for the IsAligned type trait.
size_t columns() const noexcept
Returns the current number of columns of the matrix.
Definition: DMatTransposer.h:319
Header file for the exception macros of the math module.
static constexpr bool simdEnabled
Compilation flag for SIMD optimization.
Definition: DMatTransposer.h:103
void reset()
Resets the matrix elements.
Definition: DMatTransposer.h:339
BLAZE_ALWAYS_INLINE void store(size_t i, size_t j, const SIMDType &value) noexcept
Store of a SIMD element of the matrix.
Definition: DMatTransposer.h:466
BLAZE_ALWAYS_INLINE void stream(size_t i, size_t j, const SIMDType &value) noexcept
Aligned, non-temporal store of a SIMD element of the matrix.
Definition: DMatTransposer.h:520
Header file for the IsPadded type trait.
Reference_t< MT > Reference
Reference to a non-constant matrix value.
Definition: DMatTransposer.h:90
ConstPointer_t< MT > ConstPointer
Pointer to a constant matrix value.
Definition: DMatTransposer.h:93
ResultType_t< MT > TransposeType
Transpose type for expression template evaluations.
Definition: DMatTransposer.h:85
typename T::OppositeType OppositeType_t
Alias declaration for nested OppositeType type definitions.The OppositeType_t alias declaration provi...
Definition: Aliases.h:270
Header file for the HasConstDataAccess type trait.
typename T::Iterator Iterator_t
Alias declaration for nested Iterator type definitions.The Iterator_t alias declaration provides a co...
Definition: Aliases.h:190
ConstIterator cbegin(size_t i) const
Returns an iterator to the first non-zero element of row/column i.
Definition: DMatTransposer.h:251
void addAssign(const Matrix< MT2, SO2 > &rhs)
Implementation of the transpose addition assignment of a matrix.
Definition: DMatTransposer.h:558
typename T::TransposeType TransposeType_t
Alias declaration for nested TransposeType type definitions.The TransposeType_t alias declaration pro...
Definition: Aliases.h:470
Header file for run time assertion macros.
static constexpr bool smpAssignable
Compilation flag for SMP assignments.
Definition: DMatTransposer.h:109
typename T::ConstPointer ConstPointer_t
Alias declaration for nested ConstPointer type definitions.The ConstPointer_t alias declaration provi...
Definition: Aliases.h:130
Base class for matrices.The Matrix class is a base class for all dense and sparse matrix classes with...
Definition: Forward.h:109
typename T::ConstReference ConstReference_t
Alias declaration for nested ConstReference type definitions.The ConstReference_t alias declaration p...
Definition: Aliases.h:150
Header file for the HasMutableDataAccess type trait.
bool isAliased(const Other *alias) const noexcept
Returns whether the matrix is aliased with the given address alias.
Definition: DMatTransposer.h:375
typename T::ConstIterator ConstIterator_t
Alias declaration for nested ConstIterator type definitions.The ConstIterator_t alias declaration pro...
Definition: Aliases.h:110
ConstIterator_t< MT > ConstIterator
Iterator over constant elements.
Definition: DMatTransposer.h:95
OppositeType_t< MT > OppositeType
Result type with opposite storage order for expression template evaluations.
Definition: DMatTransposer.h:84
decltype(auto) trans(const DenseMatrix< MT, SO > &dm)
Calculation of the transpose of the given dense matrix.
Definition: DMatTransExpr.h:765
ConstReference_t< MT > ConstReference
Reference to a constant matrix value.
Definition: DMatTransposer.h:91
Reference at(size_t i, size_t j)
Checked access to the matrix elements.
Definition: DMatTransposer.h:158
Iterator begin(size_t i)
Returns an iterator to the first non-zero element of row/column i.
Definition: DMatTransposer.h:219
bool isIntact(const DiagonalMatrix< MT, SO, DF > &m)
Returns whether the invariants of the given diagonal matrix are intact.
Definition: DiagonalMatrix.h:263
Pointer_t< MT > Pointer
Pointer to a non-constant matrix value.
Definition: DMatTransposer.h:92
ConstReference at(size_t i, size_t j) const
Checked access to the matrix elements.
Definition: DMatTransposer.h:177
System settings for the inline keywords.
Header file for the Size type trait.
#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
bool isAligned() const noexcept
Returns whether the matrix is properly aligned in memory.
Definition: DMatTransposer.h:386
Iterator end(size_t i)
Returns an iterator just past the last non-zero element of row/column i.
Definition: DMatTransposer.h:267
bool isIntact() const noexcept
Returns whether the invariants of the matrix are intact.
Definition: DMatTransposer.h:349
BLAZE_ALWAYS_INLINE SIMDType loadu(size_t i, size_t j) const noexcept
Unaligned load of a SIMD element of the matrix.
Definition: DMatTransposer.h:448