A newer version of this document is available. Customers should click here to go to the newest version.
Visible to Intel only — GUID: GUID-0F4E2172-46B8-413C-B0DC-8D83D2CAF29D
Visible to Intel only — GUID: GUID-0F4E2172-46B8-413C-B0DC-8D83D2CAF29D
getrs_batch_scratchpad_size (Group Version)
Computes size of scratchpad memory required for getrs_batch (Group 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 getrs_batch (Group Version) function must be able to hold.
API
Syntax
namespace oneapi::mkl::lapack { int64_t getrs_batch_scratchpad_size(sycl::queue &queue, mkl::transpose *trans, int64_t *n, int64_t *nrhs, int64_t *lda, int64_t *ldb, int64_t group_count, int64_t *group_sizes) }
This function supports the following precisions and devices:
T |
Devices supported |
|---|---|
float |
CPU and GPU |
double |
CPU and GPU |
std::complex<float> |
CPU and GPU |
std::complex<double> |
CPU and GPU |
Input Parameters
- queue
-
Device queue where calculations will be performed.
- trans
-
Array of group_count parameters transg indicating the form of the equations for the group g:
If trans = mkl::transpose::nontrans, then Ai*Xi = Bi is solved for Xi.
If trans = mkl::transpose::trans, then AiT*Xi = Bi is solved for Xi.
If trans = mkl::transpose::conjtrans, then AiH*Xi = Bi is solved for Xi.
- n
-
Array of group_count parameters ng specifying the order of the matrices Ai and the number of rows in matrices Bi belonging to group g (ng ≥ 0).
- nrhs
-
Array of group_count parameters nrhsg specifying the number of right hand sides for group g (nrhsg ≥ 0).
- lda
-
Array of group_count parameters ldag specifying the leading dimension of Ai from group g (ldag ≥ max(1, ng)).
- ldb
-
Array of group_count parameters ldbg specifying the leading dimension of Bi from group g (ldbg ≥ max(1, ng)).
- group_count
-
Specifies the number of groups of parameters. Must be at least 0.
- group_sizes
-
Array of group_count integers. Array element with index g specifies the number of problems to solve for each of the groups of parameters g. So the total number of problems to solve, batch_size, is a sum of all parameter group sizes.
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 getrs_batch (Group Version) function must be able to hold.