unmqr_scratchpad_size¶
Computes size of scratchpad memory required for unmqr function.
unmqr_scratchpad_size
supports the following precisions.
T
std::complex<float>
std::complex<double>
Description
Computes the number of elements of type T the scratchpad memory to be passed to unmqr function should be able to hold. Calls to this routine must specify the template parameter explicitly.
unmqr_scratchpad_size¶
Syntax
-
template<typename
T
>
std::int64_tonemkl::lapack
::
unmqr_scratchpad_size
(cl::sycl::queue &queue, onemkl::side left_right, onemkl::transpose trans, std::int64_t m, std::int64_t n, std::int64_t k, std::int64_t lda, std::int64_t ldc, std::int64_t &scratchpad_size)¶
Input Parameters
- queue
Device queue where calculations by unmqr function will be performed.
- left_right
If
left_right=onemkl::side::left
,Q
orQ
H is applied toC
from the left.If
left_right=onemkl::side::right
,Q
orQ
H is applied toC
from the right.- trans
If
trans=onemkl::transpose::trans
, the routine multipliesC
byQ
.If
trans=onemkl::transpose::conjtrans
, the routine multipliesC
byQ
H.- m
The number of rows in the matrix
A
(0≤m
).- n
The number of columns the matrix
A
(0≤n≤m
).- k
The number of elementary reflectors whose product defines the matrix
Q
(0≤k≤n
).- lda
The leading dimension of
a
.- ldc
The leading dimension of
c
.
Throws
- onemkl::lapack::exception
Exception is thrown in case of incorrect argument value is supplied. Position of wrong argument can be determined by get_info() method of exception object.
Return Value
The number of elements of type T the scratchpad memory to be passed to unmqr function should be able to hold.
Parent topic: LAPACK Linear Equation Routines