Visible to Intel only — GUID: GUID-03A89FF3-AACE-4812-9D9F-9EF1CD29B11E
Visible to Intel only — GUID: GUID-03A89FF3-AACE-4812-9D9F-9EF1CD29B11E
potrs_batch_scratchpad_size (Strided Version)
Computes size of scratchpad memory required for potrs_batch (Strided 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 potrs_batch (Strided Version) function must be able to hold.
API
Syntax
namespace oneapi::mkl::lapack {
std::int64_t potrs_batch_scratchpad_size(
sycl::queue &queue,
mkl::uplo uplo,
std::int64_t n,
std::int64_t nrhs,
std::int64_t lda,
std::int64_t stride_a,
std::int64_t ldb,
std::int64_t stride_b,
std::int64_t batch_size)
}
Input Parameters
- queue
-
Device queue where calculations will be performed.
- uplo
-
Indicates how the input matrix has been factored:
If uplo=mkl::uplo::upper, the upper triangle Ui of Ai is stored, where Ai = UiT*Ui for real data, Ai = UiH*Ui for complex data.
If uplo=mkl::uplo::lower, the upper triangle Li of Ai is stored, where Ai = Li*LiT for real data, Ai = Li*LiH for complex data.
- n
-
The order of the matrices Ai (n ≥ 0).
- nrhs
-
The number of right hand sides (nrhs ≥ 0).
- lda
-
The leading dimension of Ai (lda ≥ max(1, n)).
- stride_a
-
The stride between the beginnings of matrices inside the batch array a (stride_a ≥ max(1, lda * n)).
- ldb
-
The leading dimensions of Bi (ldb ≥ max(1, n)).
- stride_b
-
The stride between the beginnings of matrices Bi inside the batch array b (stride_b ≥ max(1, ldb * nrhs)).
- batch_size
-
The number of problems in a batch (batch_size ≥ 0).
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 potrs_batch (Strided Version) function must be able to hold.