unmrq (USM Version)¶
Multiplies a complex matrix by the unitary matrix Q of the RQ
factorization formed by the gerqf (USM Version) function. This routine
belongs to the oneapi::mkl::lapack
namespace.
Syntax
-
cl::sycl::event
unmrq
(cl::sycl::queue &queue, mkl::side side, mkl::transpose trans, std::int64_t m, std::int64_t n, std::int64_t k, T *a, std::int64_t lda, T *tau, T *c, std::int64_t ldc, T *scratchpad, std::int64_t scratchpad_size, const cl::sycl::vector_class<cl::sycl::event> &events = {})¶
unmrq
(USM version) supports the following precisions and
devices:
T |
Devices supported |
---|---|
|
Host and CPU |
|
Host and CPU |
Description
The routine multiplies a complex m
-by-n
matrix C
by Q
or Q
T, where Q
is the orthogonal matrix Q of the
RQ
factorization formed by the routine gerqf (USM
Version) .
Depending on the parameters side
and trans
, the routine can
form one of the matrix products Q*C
, Q
T*C
,
C*Q
, or C*Q
T (overwriting the result over C
).
Input Parameters
- queue
Device queue where calculations will be performed.
- side
If
side
=mkl::side::left
,Q
orQ
T is applied toC
from the left. Ifside
=mkl::side::right
,Q
orQ
T is applied toC
from the right.- trans
If
trans=mkl::transpose::trans
, the routine multipliesC
byQ
.If
trans=mkl::transpose::nontrans
, the routine multipliesC
byQ
T.- m
The number of rows in the matrix
A
(0≤m
).- n
The number of columns in the matrix
A
(0≤n≤m
).- k
The number of elementary reflectors whose product defines the matrix
Q
(0≤k≤n
).- a
The pointer to the result of the gerqf (USM Version) function. The second dimension of
a
must be at leastmax(1,k)
.- lda
The leading dimension of a.
- tau
The pointer to tau returned by the gerqf (USM Version) function.
- c
The pointer to the matrix
C
. The second dimension of c must be at leastmax(1,n)
.- ldc
The leading dimension of c.
- scratchpad
Pointer to scratchpad memory to be used by the routine for storing intermediate results.
- scratchpad_size
Size of scratchpad memory as a number of floating point elements of type
T
. Size should not be less than the value returned by the unmrq_scratchpad_size function.- events
List of events to wait for before starting computation. Defaults to empty list.
Output Parameters
- c
Overwritten by the product
Q
*C
,Q
T*C
,C
*Q
, orC
*Q
T (as specified by side and trans).
Exceptions
mkl::lapack::exception |
This exception is thrown when problems occur during calculations. You can obtain the info code of the problem using the info() method of the exception object: If |
Return Values
Output event to wait on to ensure computation is complete.