A newer version of this document is available. Customers should click here to go to the newest version.
Visible to Intel only — GUID: GUID-0A9AB29F-46DF-4DB4-A2D7-E2E942034CFD
Visible to Intel only — GUID: GUID-0A9AB29F-46DF-4DB4-A2D7-E2E942034CFD
potrf_batch_scratchpad_size (Group Version)
Computes the size of scratchpad memory required for potrf_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 potrf_batch (Group Version) function must be able to hold.
API
Syntax
namespace oneapi::mkl::lapack { int64_t potrf_batch_scratchpad_size(sycl::queue &queue, mkl::uplo *uplo, int64_t *n, int64_t *lda, 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.
- uplo
-
Array of group_count parameters uplog.
Each of uplog indicates whether the upper or lower triangular parts of the input matrices are provided.
If uplog=mkl::uplo::upper, input matrices from array a belonging to group g store the upper triangular parts.
If uplog=mkl::uplo::lower, input matrices from array a belonging to group g store the lower triangular parts.
- n
-
Array of group_countng parameters.
Each ng specifies the order of the input matrices belonging to group g (ng ≥ 0).
- lda
-
Array of group_count parameters ldag.
Each ldag specifies the leading dimension of the matrices belonging to group g (ldag ≥ 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 potrf_batch (Group Version) function must be able to hold.