gels_batch_scratchpad_size (Group Version)

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 6/24/2024

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-52B45858-0A8C-4FA4-851A-726FD6784AAB

View Details

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
API

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 {
   std::int64_t gels_batch_scratchpad_size(sycl::queue &queue,
   mkl::transpose *trans,
   std::int64_t *m,
   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)
}

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 A_i. 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 A_i and B_i belonging to group g (m ≥ 0).
n: Array of group_count parameters n _g specifying the number of columns of the matrices A_i 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 B_i belonging in group g (nrhs ≥ 0).
lda: Array of group_count parameters specifying the leading dimensions of A_i belonging to group g (lda ≥ max(1,m)).
ldb: Array of group_count parameters specifying the leading dimensions of B_i belonging to group g (ldb ≥ max(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.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

gels_batch_scratchpad_size (Group Version)

Description

API