potrf_batch_scratchpad_size#
Computes size of scratchpad memory required for the potrf_batch function.
Description
potrf_batch_scratchpad_size
supports the following precisions.
T
float
double
std::complex<float>
std::complex<double>
Group API
Computes the number of elements of type T
the scratchpad memory should able to hold to be passed to the Group API of the potrf_batch function.
Syntax
namespace oneapi::mkl::lapack {
template <typename T>
std::int64_t potrf_batch_scratchpad_size(sycl::queue &queue, mkl::uplo *uplo, std::int64_t *n, std::int64_t *lda, std::int64_t group_count, std::int64_t *group_sizes)
}
Input Parameters
- queue
Device queue where calculations will be performed.
- uplo
- Array of
group_count
\(\text{uplo}_g\) parameters.Each of \(\text{uplo}_g\) indicates whether the upper or lower triangular parts of the input matrices are provided:If \(\text{uplo}_g\) ismkl::uplo::upper
, input matrices from arraya
belonging to group \(g\) store the upper triangular parts,If \(\text{uplo}_g\) ismkl::uplo::lower
, input matrices from arraya
belonging to group \(g\) store the lower triangular parts. - n
- Array of
group_count
\(n_g\) parameters.Each ng specifies the order of the input matrices belonging to group \(g\). - lda
- Array of
group_count
\(\text{lda}_g\) parameters.Each ldag specifies the leading dimensions of the matrices belonging to group \(g\). - group_count
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.
Return Values
Number of elements of type T
the scratchpad memory should able to hold to be passed to the Group API of the potrf_batch function.
Strided API
Computes the number of elements of type T
the scratchpad memory should able to hold to be passed to the Strided API of the potrf_batch function.
Syntax
namespace oneapi::mkl::lapack {
template <typename T>
std::int64_t potrf_batch_scratchpad_size(sycl::queue &queue, mkl::uplo uplo, std::int64_t n, std::int64_t lda, std::int64_t stride_a, std::int64_t batch_size)
};
Input Parameters
- queue
Device queue where calculations will be performed.
- uplo
- Indicates whether the upper or lower triangular part of \(A_i\) is stored and how \(A_i\) is factored:If
uplo = mkl::uplo::upper
, the arraya
stores the upper triangular parts of the matrices \(A_i\),Ifuplo = mkl::uplo::lower
, the arraya
stores the lower triangular parts of the matrices \(A_i\). - n
Order of the matrices \(A_i\), (\(0 \le n\)).
- lda
Leading dimension of \(A_i\).
- stride_a
Stride between the beginnings of matrices \(A_i\) inside the batch.
- batch_size
Number of problems in a batch.
Return Values
Number of elements of type T
the scratchpad memory should able to hold to be passed to the Strided API of the potrf_batch function.
Parent topic: LAPACK-like Extensions Routines