Blaze 3.9
Loading...
Searching...
No Matches
ormql.h
Go to the documentation of this file.
1//=================================================================================================
33//=================================================================================================
34
35#ifndef _BLAZE_MATH_LAPACK_ORMQL_H_
36#define _BLAZE_MATH_LAPACK_ORMQL_H_
37
38
39//*************************************************************************************************
40// Includes
41//*************************************************************************************************
42
43#include <memory>
44#include <blaze/math/Aliases.h>
56#include <blaze/util/Assert.h>
59
60
61namespace blaze {
62
63//=================================================================================================
64//
65// LAPACK FUNCTIONS TO MULTIPLY Q FROM A QL DECOMPOSITION WITH A MATRIX (ORMQL)
66//
67//=================================================================================================
68
69//*************************************************************************************************
72template< typename MT1, bool SO1, typename MT2, bool SO2 >
74 char side, char trans, const ElementType_t<MT2>* tau );
76//*************************************************************************************************
77
78
79//*************************************************************************************************
128//
129// - ... the number of rows of the given \a A matrix is larger than the number of columns;
130// - ... the given \a side argument is neither \c 'L' nor \c 'R';
131// - ... the given \a trans argument is neither \c 'N' nor \c 'T'.
132//
133// In all failure cases an exception is thrown.
134//
135// For more information on the ormql() functions (i.e. sormql() and dormql()) see the LAPACK
136// online documentation browser:
137//
138// http://www.netlib.org/lapack/explore-html/
139//
140// \note This function can only be used if a fitting LAPACK library, which supports this function,
141// is available and linked to the executable. Otherwise a call to this function will result in a
142// linker error.
143*/
144template< 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 blas_int_t m ( numeric_cast<blas_int_t>( SO1 ? (*C).rows() : (*C).columns() ) );
177 blas_int_t n ( numeric_cast<blas_int_t>( SO1 ? (*C).columns() : (*C).rows() ) );
178 blas_int_t k ( numeric_cast<blas_int_t>( min( (*A).rows(), (*A).columns() ) ) );
179 blas_int_t lda ( numeric_cast<blas_int_t>( (*A).spacing() ) );
180 blas_int_t ldc ( numeric_cast<blas_int_t>( (*C).spacing() ) );
181 blas_int_t info( 0 );
182
183 if( m == 0 || n == 0 || k == 0 ) {
184 return;
185 }
186
188 ( side == 'L' )?( side = 'R' ):( side = 'L' );
189 }
190
192 ( trans == 'N' )?( trans = 'T' ):( trans = 'N' );
193 }
194
195 blas_int_t lwork( k*ldc );
196 const std::unique_ptr<ET[]> work( new ET[lwork] );
197 const size_t offset( (*A).rows() - (*A).columns() );
198
199 if( SO2 ) {
200 ormql( side, trans, m, n, k, (*A).data()+offset, lda, tau, (*C).data(), ldc, work.get(), lwork, &info );
201 }
202 else {
203 ormrq( side, trans, m, n, k, (*A).data(offset), lda, tau, (*C).data(), ldc, work.get(), lwork, &info );
204 }
205
206 BLAZE_INTERNAL_ASSERT( info == 0, "Invalid argument for Q multiplication" );
207}
208//*************************************************************************************************
209
210} // namespace blaze
211
212#endif
Constraint on the data type.
Header file for auxiliary alias declarations.
typename T::ElementType ElementType_t
Alias declaration for nested ElementType type definitions.
Definition Aliases.h:190
Header file for run time assertion macros.
Constraint on the data type.
Constraint on the data type.
Constraint on the data type.
Constraint on the data type.
Header file for the IsRowMajorMatrix type trait.
Constraint on the data type.
Cast operators for numeric types.
Header file for the CLAPACK ormql wrapper functions.
Header file for the CLAPACK ormrq wrapper functions.
Base class for dense matrices.
Definition DenseMatrix.h:82
Constraint on the data type.
Header file for the DenseMatrix base class.
#define BLAZE_CONSTRAINT_MUST_BE_BUILTIN_TYPE(T)
Constraint on the data type.
Definition Builtin.h:60
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:1339
decltype(auto) trans(const DenseMatrix< MT, SO > &dm)
Calculation of the transpose of the given dense matrix.
Definition DMatTransExpr.h:766
void ormql(char side, char trans, blas_int_t m, blas_int_t n, blas_int_t k, const float *A, blas_int_t lda, const float *tau, float *C, blas_int_t ldc, float *work, blas_int_t lwork, blas_int_t *info)
LAPACK kernel for the multiplication of the single precision Q from a QL decomposition with another m...
Definition ormql.h:145
void ormrq(char side, char trans, blas_int_t m, blas_int_t n, blas_int_t k, const float *A, blas_int_t lda, const float *tau, float *C, blas_int_t ldc, float *work, blas_int_t lwork, blas_int_t *info)
LAPACK kernel for the multiplication of the single precision Q from a RQ decomposition with another m...
Definition ormrq.h:145
#define BLAZE_CONSTRAINT_MUST_BE_BLAS_COMPATIBLE_TYPE(T)
Constraint on the data type.
Definition BLASCompatible.h:61
#define BLAZE_CONSTRAINT_MUST_BE_CONTIGUOUS_TYPE(T)
Constraint on the data type.
Definition Contiguous.h:61
#define BLAZE_CONSTRAINT_MUST_NOT_BE_COMPUTATION_TYPE(T)
Constraint on the data type.
Definition Computation.h:81
#define BLAZE_CONSTRAINT_MUST_NOT_BE_ADAPTOR_TYPE(T)
Constraint on the data type.
Definition Adaptor.h:81
#define BLAZE_CONSTRAINT_MUST_HAVE_MUTABLE_DATA_ACCESS(T)
Constraint on the data type.
Definition MutableDataAccess.h:61
#define BLAZE_CONSTRAINT_MUST_HAVE_CONST_DATA_ACCESS(T)
Constraint on the data type.
Definition ConstDataAccess.h:61
constexpr bool IsRowMajorMatrix_v
Auxiliary variable template for the IsRowMajorMatrix type trait.
Definition IsRowMajorMatrix.h:129
int32_t blas_int_t
Signed integer type used in the BLAS/LAPACK wrapper functions.
Definition Types.h:64
#define BLAZE_INTERNAL_ASSERT(expr, msg)
Run time assertion macro for internal checks.
Definition Assert.h:101
To numeric_cast(From from)
Checked conversion of values of numeric type.
Definition NumericCast.h:275
#define BLAZE_THROW_INVALID_ARGUMENT(MESSAGE)
Macro for the emission of a std::invalid_argument exception.
Definition Exception.h:235
Header file for the exception macros of the math module.