ormqr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_LAPACK_ORMQR_H_
36 #define _BLAZE_MATH_LAPACK_ORMQR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <memory>
44 #include <blaze/math/Aliases.h>
50 #include <blaze/math/Exception.h>
55 #include <blaze/util/Assert.h>
57 #include <blaze/util/mpl/Xor.h>
58 #include <blaze/util/NumericCast.h>
59 
60 
61 namespace blaze {
62 
63 //=================================================================================================
64 //
65 // LAPACK FUNCTIONS TO MULTIPLY Q FROM A QR DECOMPOSITION WITH A MATRIX (ORMQR)
66 //
67 //=================================================================================================
68 
69 //*************************************************************************************************
72 template< typename MT1, bool SO1, typename MT2, bool SO2 >
73 inline void ormqr( DenseMatrix<MT1,SO1>& C, const DenseMatrix<MT2,SO2>& A,
74  char side, char trans, const ElementType_<MT2>* tau );
76 //*************************************************************************************************
77 
78 
79 //*************************************************************************************************
144 template< typename MT1, bool SO1, typename MT2, bool SO2 >
146  char side, char trans, const ElementType_<MT2>* tau )
147 {
153 
159 
160  using ET = ElementType_<MT1>;
161 
162  if( (~A).rows() > (~A).columns() ) {
163  BLAZE_THROW_INVALID_ARGUMENT( "Invalid size of Q matrix" );
164  }
165 
166  if( side != 'L' && side != 'R' ) {
167  BLAZE_THROW_INVALID_ARGUMENT( "Invalid side argument provided" );
168  }
169 
170  if( trans != 'N' && trans != 'T' ) {
171  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
172  }
173 
174  int m ( numeric_cast<int>( SO1 ? (~C).rows() : (~C).columns() ) );
175  int n ( numeric_cast<int>( SO1 ? (~C).columns() : (~C).rows() ) );
176  int k ( numeric_cast<int>( min( (~A).rows(), (~A).columns() ) ) );
177  int lda ( numeric_cast<int>( (~A).spacing() ) );
178  int ldc ( numeric_cast<int>( (~C).spacing() ) );
179  int info( 0 );
180 
181  if( m == 0 || n == 0 || k == 0 ) {
182  return;
183  }
184 
186  ( side == 'L' )?( side = 'R' ):( side = 'L' );
187  }
188 
190  ( trans == 'N' )?( trans = 'T' ):( trans = 'N' );
191  }
192 
193  int lwork( k*ldc );
194  const std::unique_ptr<ET[]> work( new ET[lwork] );
195 
196  if( SO2 ) {
197  ormqr( side, trans, m, n, k, (~A).data(), lda, tau, (~C).data(), ldc, work.get(), lwork, &info );
198  }
199  else {
200  ormlq( side, trans, m, n, k, (~A).data(), lda, tau, (~C).data(), ldc, work.get(), lwork, &info );
201  }
202 
203  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid argument for Q multiplication" );
204 }
205 //*************************************************************************************************
206 
207 } // namespace blaze
208 
209 #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 ormqr(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 QR decomposition with another m...
Definition: ormqr.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
#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
const ElementType_< MT > min(const DenseMatrix< MT, SO > &dm)
Returns the smallest element of the dense matrix.
Definition: DenseMatrix.h:1903
Constraint on the data type.
Cast operators for numeric types.
#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
BLAZE_ALWAYS_INLINE 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
Compile time check for row-major matrix types.This type trait tests whether or not the given template...
Definition: IsRowMajorMatrix.h:110
Header file for the CLAPACK ormqr wrapper functions.
Header file for the DenseMatrix base class.
typename T::ElementType ElementType_
Alias declaration for nested ElementType type definitions.The ElementType_ alias declaration provides...
Definition: Aliases.h:163
BLAZE_ALWAYS_INLINE size_t columns(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of columns of the matrix.
Definition: Matrix.h:506
Header file for the exception macros of the math module.
Constraint on the data type.
Compile time logical &#39;xor&#39; evaluation.The Xor alias declaration performs at compile time a logical &#39;x...
Definition: Xor.h:74
Header file for the CLAPACK ormlq wrapper functions.
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
void ormlq(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 LQ decomposition with another m...
Definition: ormlq.h:135
#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
BLAZE_ALWAYS_INLINE size_t rows(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of rows of the matrix.
Definition: Matrix.h:490
BLAZE_ALWAYS_INLINE MT::ElementType * data(DenseMatrix< MT, SO > &dm) noexcept
Low-level data access to the dense matrix elements.
Definition: DenseMatrix.h:169
decltype(auto) trans(const DenseMatrix< MT, SO > &dm)
Calculation of the transpose of the given dense matrix.
Definition: DMatTransExpr.h:789
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.