ormrq.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_LAPACK_ORMRQ_H_
36 #define _BLAZE_MATH_LAPACK_ORMRQ_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <memory>
44 #include <blaze/math/Aliases.h>
51 #include <blaze/math/Exception.h>
56 #include <blaze/util/Assert.h>
58 #include <blaze/util/mpl/Xor.h>
59 #include <blaze/util/NumericCast.h>
60 
61 
62 namespace blaze {
63 
64 //=================================================================================================
65 //
66 // LAPACK FUNCTIONS TO MULTIPLY Q FROM A RQ DECOMPOSITION WITH A MATRIX (ORMRQ)
67 //
68 //=================================================================================================
69 
70 //*************************************************************************************************
73 template< typename MT1, bool SO1, typename MT2, bool SO2 >
74 inline void ormrq( DenseMatrix<MT1,SO1>& C, const DenseMatrix<MT2,SO2>& A,
75  char side, char trans, const ElementType_t<MT2>* tau );
77 //*************************************************************************************************
78 
79 
80 //*************************************************************************************************
145 template< typename MT1, bool SO1, typename MT2, bool SO2 >
147  char side, char trans, const ElementType_t<MT2>* tau )
148 {
155 
162 
163  using ET = ElementType_t<MT1>;
164 
165  if( (~A).rows() < (~A).columns() ) {
166  BLAZE_THROW_INVALID_ARGUMENT( "Invalid size of Q matrix" );
167  }
168 
169  if( side != 'L' && side != 'R' ) {
170  BLAZE_THROW_INVALID_ARGUMENT( "Invalid side argument provided" );
171  }
172 
173  if( trans != 'N' && trans != 'T' ) {
174  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
175  }
176 
177  int m ( numeric_cast<int>( SO1 ? (~C).rows() : (~C).columns() ) );
178  int n ( numeric_cast<int>( SO1 ? (~C).columns() : (~C).rows() ) );
179  int k ( numeric_cast<int>( min( (~A).rows(), (~A).columns() ) ) );
180  int lda ( numeric_cast<int>( (~A).spacing() ) );
181  int ldc ( numeric_cast<int>( (~C).spacing() ) );
182  int info( 0 );
183 
184  if( m == 0 || n == 0 || k == 0 ) {
185  return;
186  }
187 
188  if( IsRowMajorMatrix_v<MT1> ) {
189  ( side == 'L' )?( side = 'R' ):( side = 'L' );
190  }
191 
192  if( IsRowMajorMatrix_v<MT1> ^ IsRowMajorMatrix_v<MT2> ) {
193  ( trans == 'N' )?( trans = 'T' ):( trans = 'N' );
194  }
195 
196  int lwork( k*ldc );
197  const std::unique_ptr<ET[]> work( new ET[lwork] );
198  const size_t offset( (~A).rows() - (~A).columns() );
199 
200  if( SO2 ) {
201  ormrq( side, trans, m, n, k, (~A).data()+offset, lda, tau, (~C).data(), ldc, work.get(), lwork, &info );
202  }
203  else {
204  ormql( side, trans, m, n, k, (~A).data(offset), lda, tau, (~C).data(), ldc, work.get(), lwork, &info );
205  }
206 
207  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid argument for Q multiplication" );
208 }
209 //*************************************************************************************************
210 
211 } // namespace blaze
212 
213 #endif
#define BLAZE_THROW_INVALID_ARGUMENT(MESSAGE)
Macro for the emission of a std::invalid_argument exception.This macro encapsulates the default way o...
Definition: Exception.h:235
Constraint on the data type.
Header file for auxiliary alias declarations.
void ormql(char side, char trans, int m, int n, int k, const float *A, int lda, const float *tau, float *C, int ldc, float *work, int lwork, int *info)
LAPACK kernel for the multiplication of the single precision Q from a QL decomposition with another m...
Definition: ormql.h:135
#define BLAZE_CONSTRAINT_MUST_HAVE_MUTABLE_DATA_ACCESS(T)
Constraint on the data type.In case the given data type T does not provide low-level data access to m...
Definition: MutableDataAccess.h:61
#define BLAZE_CONSTRAINT_MUST_HAVE_CONST_DATA_ACCESS(T)
Constraint on the data type.In case the given data type T does not provide low-level data access to c...
Definition: ConstDataAccess.h:61
MT::ElementType * data(DenseMatrix< MT, SO > &dm) noexcept
Low-level data access to the dense matrix elements.
Definition: DenseMatrix.h:169
Header file for the CLAPACK ormrq wrapper functions.
#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
Constraint on the data type.
Constraint on the data type.
void ormrq(char side, char trans, int m, int n, int k, const float *A, int lda, const float *tau, float *C, int ldc, float *work, int lwork, int *info)
LAPACK kernel for the multiplication of the single precision Q from a RQ decomposition with another m...
Definition: ormrq.h:135
Cast operators for numeric types.
constexpr size_t columns(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of columns of the matrix.
Definition: Matrix.h:514
#define BLAZE_CONSTRAINT_MUST_NOT_BE_ADAPTOR_TYPE(T)
Constraint on the data type.In case the given data type T is an adaptor type (as for instance LowerMa...
Definition: Adaptor.h:81
Base class for dense matrices.The DenseMatrix class is a base class for all dense matrix classes...
Definition: DenseMatrix.h:80
typename T::ElementType ElementType_t
Alias declaration for nested ElementType type definitions.The ElementType_t alias declaration provide...
Definition: Aliases.h:170
size_t spacing(const DenseMatrix< MT, SO > &dm) noexcept
Returns the spacing between the beginning of two rows/columns.
Definition: DenseMatrix.h:252
Constraint on the data type.
Namespace of the Blaze C++ math library.
Definition: Blaze.h:58
#define BLAZE_CONSTRAINT_MUST_BE_CONTIGUOUS_TYPE(T)
Constraint on the data type.In case the given data type T is not an array-like data type with contigu...
Definition: Contiguous.h:61
decltype(auto) min(const DenseMatrix< MT1, SO1 > &lhs, const DenseMatrix< MT2, SO2 > &rhs)
Computes the componentwise minimum of the dense matrices lhs and rhs.
Definition: DMatDMatMapExpr.h:1147
Header file for the DenseMatrix base class.
Header file for the CLAPACK ormql wrapper functions.
Header file for the exception macros of the math module.
Constraint on the data type.
Header file for run time assertion macros.
Constraint on the data type.
#define BLAZE_CONSTRAINT_MUST_BE_BLAS_COMPATIBLE_TYPE(T)
Constraint on the data type.In case the given data type T is not a BLAS compatible data type (i...
Definition: BLASCompatible.h:61
constexpr size_t rows(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of rows of the matrix.
Definition: Matrix.h:498
#define BLAZE_CONSTRAINT_MUST_BE_BUILTIN_TYPE(T)
Constraint on the data type.In case the given data type T is not a built-in data type, a compilation error is created.
Definition: Builtin.h:60
decltype(auto) trans(const DenseMatrix< MT, SO > &dm)
Calculation of the transpose of the given dense matrix.
Definition: DMatTransExpr.h:765
Header file for the IsRowMajorMatrix 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
Constraint on the data type.
Header file for the Xor class template.