unmlq.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_LAPACK_UNMLQ_H_
36 #define _BLAZE_MATH_LAPACK_UNMLQ_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <memory>
44 #include <boost/cast.hpp>
45 #include <blaze/math/Aliases.h>
51 #include <blaze/math/Exception.h>
55 #include <blaze/util/Assert.h>
57 
58 
59 namespace blaze {
60 
61 //=================================================================================================
62 //
63 // LAPACK FUNCTIONS TO MULTIPLY Q FROM A LQ DECOMPOSITION WITH A MATRIX (UNMLQ)
64 //
65 //=================================================================================================
66 
67 //*************************************************************************************************
70 template< typename MT1, bool SO, typename MT2 >
71 inline void unmlq( DenseMatrix<MT1,SO>& C, const DenseMatrix<MT2,SO>& A,
72  char side, char trans, const ElementType_<MT2>* tau );
74 //*************************************************************************************************
75 
76 
77 //*************************************************************************************************
142 template< typename MT1, bool SO, typename MT2 >
144  char side, char trans, const ElementType_<MT2>* tau )
145 {
146  using boost::numeric_cast;
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 != 'C' ) {
171  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
172  }
173 
174  int m ( numeric_cast<int>( SO ? (~C).rows() : (~C).columns() ) );
175  int n ( numeric_cast<int>( SO ? (~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 
185  if( !SO ) {
186  ( side == 'L' )?( side = 'R' ):( side = 'L' );
187  }
188 
189  int lwork( k*ldc );
190  const std::unique_ptr<ET[]> work( new ET[lwork] );
191 
192  if( SO ) {
193  unmlq( side, trans, m, n, k, (~A).data(), lda, tau, (~C).data(), ldc, work.get(), lwork, &info );
194  }
195  else {
196  unmqr( side, trans, m, n, k, (~A).data(), lda, tau, (~C).data(), ldc, work.get(), lwork, &info );
197  }
198 
199  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid argument for Q multiplication" );
200 }
201 //*************************************************************************************************
202 
203 } // namespace blaze
204 
205 #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.
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:102
Header file for auxiliary alias declarations.
#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
Constraint on the data type.
const ElementType_< MT > min(const DenseMatrix< MT, SO > &dm)
Returns the smallest element of the dense matrix.
Definition: DenseMatrix.h:1755
Constraint on the data type.
#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:71
Header file for the CLAPACK unmqr wrapper functions.
Constraint on the data type.
Namespace of the Blaze C++ math library.
Definition: Blaze.h:57
void unmqr(char side, char trans, int m, int n, int k, const complex< float > *A, int lda, const complex< float > *tau, complex< float > *C, int ldc, complex< float > *work, int lwork, int *info)
LAPACK kernel for the multiplication of the single precision Q from a QR decomposition with another m...
Definition: unmqr.h:136
Header file for the DenseMatrix base class.
void unmlq(char side, char trans, int m, int n, int k, const complex< float > *A, int lda, const complex< float > *tau, complex< float > *C, int ldc, complex< float > *work, int lwork, int *info)
LAPACK kernel for the multiplication of the single precision complex Q from a LQ decomposition with a...
Definition: unmlq.h:136
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:336
Header file for the exception macros of the math module.
Header file for the CLAPACK unmlq wrapper functions.
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
BLAZE_ALWAYS_INLINE size_t rows(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of rows of the matrix.
Definition: Matrix.h:320
#define BLAZE_CONSTRAINT_MUST_BE_COMPLEX_TYPE(T)
Constraint on the data type.This compile time constraint checks that the given data type T is a compl...
Definition: Complex.h:62
const DMatTransExpr< MT,!SO > trans(const DenseMatrix< MT, SO > &dm)
Calculation of the transpose of the given dense matrix.
Definition: DMatTransExpr.h:733
#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