gels_batch_scratchpad_size (Group Version)

gels_batch_scratchpad_size (Group Version)#

Computes size of scratchpad memory required for gels_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 gels_batch (Group Version) function must be able to hold.

API#

Syntax#

 namespace oneapi::mkl::lapack {
   int64_t gels_batch_scratchpad_size(sycl::queue &queue,
   mkl::transpose *trans,
   int64_t *m,
   int64_t *n,
   int64_t *nrhs,
   int64_t *lda,
   int64_t *ldb,
   int64_t group_count,
   int64_t *group_sizes)
}

Input Parameters#

queue

Device queue where calculations will be performed.

trans

Array of group_count parameters trans g indicating the form of equations for the group g. Operation assumed to be done on input matrices Ai. Only the trans = mkl::transpose::nontrans case is currently supported.

m

Array of group_count parameters m g specifying the number of rows of the matrices Ai and Bi belonging to group g (m 0).

n

Array of group_count parameters n g specifying the number of columns of the matrices Ai belonging in group g (n 0).

nrhs

Array of group_count parameters nrhs g specifying the number of right-hand sides: the number of columns in Bi belonging in group g (nrhs 0).

lda

Array of group_count parameters specifying the leading dimensions of Ai belonging to group g (ldamax(1,m)).

ldb

Array of group_count parameters specifying the leading dimensions of Bi belonging to group g (ldbmax(1,max(m,n))).

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 group 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 using the info() method of the exception object.

Return Values#

The number of elements of type T the scratchpad memory to be passed to the gels_batch (Group Version) function must be able to hold.