Blaze  3.6
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>
51 #include <blaze/math/Exception.h>
56 #include <blaze/util/Assert.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 void ormqr( DenseMatrix<MT1,SO1>& C, const DenseMatrix<MT2,SO2>& A,
74  char side, char trans, const ElementType_t<MT2>* tau );
76 //*************************************************************************************************
77 
78 
79 //*************************************************************************************************
144 template< typename MT1, bool SO1, typename MT2, bool SO2 >
146  char side, char trans, const ElementType_t<MT2>* tau )
147 {
154 
161 
162  using ET = ElementType_t<MT1>;
163 
164  if( (~A).rows() > (~A).columns() ) {
165  BLAZE_THROW_INVALID_ARGUMENT( "Invalid size of Q matrix" );
166  }
167 
168  if( side != 'L' && side != 'R' ) {
169  BLAZE_THROW_INVALID_ARGUMENT( "Invalid side argument provided" );
170  }
171 
172  if( trans != 'N' && trans != 'T' ) {
173  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
174  }
175 
176  int m ( numeric_cast<int>( SO1 ? (~C).rows() : (~C).columns() ) );
177  int n ( numeric_cast<int>( SO1 ? (~C).columns() : (~C).rows() ) );
178  int k ( numeric_cast<int>( min( (~A).rows(), (~A).columns() ) ) );
179  int lda ( numeric_cast<int>( (~A).spacing() ) );
180  int ldc ( numeric_cast<int>( (~C).spacing() ) );
181  int info( 0 );
182 
183  if( m == 0 || n == 0 || k == 0 ) {
184  return;
185  }
186 
187  if( IsRowMajorMatrix_v<MT1> ) {
188  ( side == 'L' )?( side = 'R' ):( side = 'L' );
189  }
190 
191  if( IsRowMajorMatrix_v<MT1> ^ IsRowMajorMatrix_v<MT2> ) {
192  ( trans == 'N' )?( trans = 'T' ):( trans = 'N' );
193  }
194 
195  int lwork( k*ldc );
196  const std::unique_ptr<ET[]> work( new ET[lwork] );
197 
198  if( SO2 ) {
199  ormqr( side, trans, m, n, k, (~A).data(), lda, tau, (~C).data(), ldc, work.get(), lwork, &info );
200  }
201  else {
202  ormlq( side, trans, m, n, k, (~A).data(), lda, tau, (~C).data(), ldc, work.get(), lwork, &info );
203  }
204 
205  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid argument for Q multiplication" );
206 }
207 //*************************************************************************************************
208 
209 } // namespace blaze
210 
211 #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:140
#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:170
#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.
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:81
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:253
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
Header file for the CLAPACK ormqr wrapper functions.
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:1162
Header file for the DenseMatrix base class.
Header file for the exception macros of the math module.
Constraint on the data type.
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:140
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,...
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,...
Definition: Assert.h:101
Constraint on the data type.