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::lapacknamespace.

Syntax

std::int64_t getrs_batch_scratchpad_size(cl::sycl::queue &queue, mkl::transpose *trans, std::int64_t *n, std::int64_t *nrhs, std::int64_t *lda, std::int64_t *ldb, std::int64_t group_count, std::int64_t *group_sizes)

Function supports the following precisions and devices.

T

Devices supported

float

Host, CPU, and GPU

double

Host, CPU, and GPU

std::complex<float>

Host, CPU, and GPU

std::complex<double>

Host, CPU, and GPU

Description

Computes the number of elements of type T the scratchpad memory to be passed to the getrs_batch (Group Version) function should be able to hold.

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 (0 ng) belonging to group g.

nrhs

Array of group_count parameters nrhsg specifying the number of right hand sides (0≤nrhsg) for group g.

lda

Array of group_count parameters ldag specifying the leading dimension of Ai from group g.

ldb

Array of group_count parameters ldbg specifying the leading dimension of Bi from group g.

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

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 should be able to hold.