geqrf.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_LAPACK_GEQRF_H_
36 #define _BLAZE_MATH_LAPACK_GEQRF_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <boost/cast.hpp>
50 #include <blaze/util/Assert.h>
51 #include <blaze/util/Complex.h>
53 #include <blaze/util/UniqueArray.h>
54 
55 
56 namespace blaze {
57 
58 //=================================================================================================
59 //
60 // LAPACK FORWARD DECLARATIONS
61 //
62 //=================================================================================================
63 
64 //*************************************************************************************************
66 extern "C" {
67 
68 void sgeqrf_( int* m, int* n, float* A, int* lda, float* tau, float* work, int* lwork, int* info );
69 void dgeqrf_( int* m, int* n, double* A, int* lda, double* tau, double* work, int* lwork, int* info );
70 void cgeqrf_( int* m, int* n, float* A, int* lda, float* tau, float* work, int* lwork, int* info );
71 void zgeqrf_( int* m, int* n, double* A, int* lda, double* tau, double* work, int* lwork, int* info );
72 
73 }
75 //*************************************************************************************************
76 
77 
78 
79 
80 //=================================================================================================
81 //
82 // LAPACK QR DECOMPOSITION FUNCTIONS (GEQRF)
83 //
84 //=================================================================================================
85 
86 //*************************************************************************************************
89 inline void geqrf( int m, int n, float* A, int lda, float* tau,
90  float* work, int lwork, int* info );
91 
92 inline void geqrf( int m, int n, double* A, int lda, double* tau,
93  double* work, int lwork, int* info );
94 
95 inline void geqrf( int m, int n, complex<float>* A, int lda, complex<float>* tau,
96  complex<float>* work, int lwork, int* info );
97 
98 inline void geqrf( int m, int n, complex<double>* A, int lda, complex<double>* tau,
99  complex<double>* work, int lwork, int* info );
100 
101 template< typename MT, bool SO >
102 inline void geqrf( DenseMatrix<MT,SO>& A, typename MT::ElementType* tau );
104 //*************************************************************************************************
105 
106 
107 //*************************************************************************************************
155 inline void geqrf( int m, int n, float* A, int lda, float* tau,
156  float* work, int lwork, int* info )
157 {
158  sgeqrf_( &m, &n, A, &lda, tau, work, &lwork, info );
159 }
160 //*************************************************************************************************
161 
162 
163 //*************************************************************************************************
211 inline void geqrf( int m, int n, double* A, int lda, double* tau,
212  double* work, int lwork, int* info )
213 {
214  dgeqrf_( &m, &n, A, &lda, tau, work, &lwork, info );
215 }
216 //*************************************************************************************************
217 
218 
219 //*************************************************************************************************
267 inline void geqrf( int m, int n, complex<float>* A, int lda, complex<float>* tau,
268  complex<float>* work, int lwork, int* info )
269 {
270  BLAZE_STATIC_ASSERT( sizeof( complex<float> ) == 2UL*sizeof( float ) );
271 
272  cgeqrf_( &m, &n, reinterpret_cast<float*>( A ), &lda, reinterpret_cast<float*>( tau ),
273  reinterpret_cast<float*>( work ), &lwork, info );
274 }
275 //*************************************************************************************************
276 
277 
278 //*************************************************************************************************
326 inline void geqrf( int m, int n, complex<double>* A, int lda, complex<double>* tau,
327  complex<double>* work, int lwork, int* info )
328 {
329  BLAZE_STATIC_ASSERT( sizeof( complex<double> ) == 2UL*sizeof( double ) );
330 
331  zgeqrf_( &m, &n, reinterpret_cast<double*>( A ), &lda, reinterpret_cast<double*>( tau ),
332  reinterpret_cast<double*>( work ), &lwork, info );
333 }
334 //*************************************************************************************************
335 
336 
337 //*************************************************************************************************
382 template< typename MT // Type of the dense matrix
383  , bool SO > // Storage order of the dense matrix
384 inline void geqrf( DenseMatrix<MT,SO>& A, typename MT::ElementType* tau )
385 {
386  using boost::numeric_cast;
387 
392 
393  typedef typename MT::ElementType ET;
394 
395  int m ( numeric_cast<int>( SO ? (~A).rows() : (~A).columns() ) );
396  int n ( numeric_cast<int>( SO ? (~A).columns() : (~A).rows() ) );
397  int lda ( numeric_cast<int>( (~A).spacing() ) );
398  int info( 0 );
399 
400  if( m == 0 || n == 0 ) {
401  return;
402  }
403 
404  int lwork( n*lda );
405  const UniqueArray<ET> work( new ET[lwork] );
406 
407  geqrf( m, n, (~A).data(), lda, tau, work.get(), lwork, &info );
408 
409  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid argument for QR decomposition" );
410 }
411 //*************************************************************************************************
412 
413 } // namespace blaze
414 
415 #endif
Constraint on the data type.
Log level for high-level information.
Definition: LogLevel.h:80
#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:79
#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:118
Pointer get() const
Returns a pointer to the managed array.
Definition: UniqueArray.h:245
BLAZE_ALWAYS_INLINE size_t rows(const Matrix< MT, SO > &matrix)
Returns the current number of rows of the matrix.
Definition: Matrix.h:308
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:118
Base class for dense matrices.The DenseMatrix class is a base class for all dense matrix classes...
Definition: DenseMatrix.h:70
Namespace of the Blaze C++ math library.
Definition: Blaze.h:57
Compile time assertion.
Header file for the DenseMatrix base class.
Type ElementType
Type of the sparse matrix elements.
Definition: CompressedMatrix.h:2586
Constraint on the data type.
Constraint on the data type.
const bool spacing
Adding an additional spacing line between two log messages.This setting gives the opportunity to add ...
Definition: Logging.h:70
Header file for run time assertion macros.
Header file for the UniqueArray smart pointer class.
void geqrf(int m, int n, float *A, int lda, float *tau, float *work, int lwork, int *info)
LAPACK kernel for the QR decomposition of the given dense single precision column-major matrix...
Definition: geqrf.h:155
#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:79
Header file for the IsRowMajorMatrix type trait.
BLAZE_ALWAYS_INLINE size_t columns(const Matrix< MT, SO > &matrix)
Returns the current number of columns of the matrix.
Definition: Matrix.h:324
Header file for the complex data type.
#define BLAZE_STATIC_ASSERT(expr)
Compile time assertion macro.In case of an invalid compile time expression, a compilation error is cr...
Definition: StaticAssert.h:143
Scope-limited management of dynamically allocated arrays.The UniqueArray class implements a scope-res...
Definition: UniqueArray.h:97
#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