A newer version of this document is available. Customers should click here to go to the newest version.
Visible to Intel only — GUID: GUID-2A200476-6D30-4BE2-84D3-3D59E7C22E83
Visible to Intel only — GUID: GUID-2A200476-6D30-4BE2-84D3-3D59E7C22E83
ormtr_scratchpad_size
Computes size of scratchpad memory required for ormtr (USM Version) function. This routine belongs to the oneapi::mkl::lapack namespace.
Description
Computes the number of elements of type T the scratchpad memory to be passed to the ormtr (buffer or USM version) function must be able to hold.
API
Syntax
namespace oneapi::mkl::lapack { template<typename T> std::int64_t ormtr_scratchpad_size(sycl::queue &queue, mkl::side side, mkl::uplo uplo, mkl::transpose trans, std::int64_t m, std::int64_t n, std::int64_t lda, std::int64_t ldc) }
Input Parameters
In the descriptions below, r denotes the order of Q:
r = m |
if side = side::left |
r = n |
if side = side::right |
- queue
-
Device queue where calculations by the ormtr (buffer or USM version) function will be performed.
- side
-
Must be either side::left or side::right.
If side = side::left, Q or QT is applied to C from the left.
If side = side::right, Q or QT is applied to C from the right.
- uplo
-
Must be either uplo::upper or uplo::lower. Uses the same uplo as supplied to sytrd (USM Version).
- trans
-
Must be either transpose::nontrans or transpose::trans.
If trans = transpose::nontrans, the routine multiplies C by Q.
If trans = transpose::trans, the routine multiplies C by QT.
- m
-
The number of rows in the matrix C(m ≥ 0).
- n
-
The number of columns in the matrix C(n ≥ 0).
- lda
-
The leading dimension of a(lda ≥ max(1, r)).
- ldc
-
The leading dimension of c(ldc ≥ max(1, m)).
Exceptions
Exception |
Description |
|---|---|
mkl::lapack::exception |
This exception is thrown when an incorrect argument value is supplied. You can determine the position of the incorrect argument by the info() method of the exception object. |
Return Values
The number of elements of type T the scratchpad memory to be passed to the ormtr (buffer or USM version) function must be able to hold.