getrs_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-0F4E2172-46B8-413C-B0DC-8D83D2CAF29D

View Details

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::lapack namespace.

Description
API

Description

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

API

Syntax

namespace oneapi::mkl::lapack {
  int64_t getrs_batch_scratchpad_size(sycl::queue &queue,
  mkl::transpose *trans,
  int64_t *n,
  int64_t *nrhs,
  int64_t *lda,
  int64_t *ldb,
  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.

trans

Array of group_count parameters trans_g indicating the form of the equations for the group g:

If trans = mkl::transpose::nontrans, then A_i*X_i = B_i is solved for X_i.

If trans = mkl::transpose::trans, then A_i^T*X_i = B_i is solved for X_i.

If trans = mkl::transpose::conjtrans, then A_i^H*X_i = B_i is solved for X_i.

n

Array of group_count parameters n_g specifying the order of the matrices A_i and the number of rows in matrices B_i belonging to group g (n_g ≥ 0).

nrhs

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

lda

Array of group_count parameters lda_g specifying the leading dimension of A_i from group g (lda_g ≥ max(1, n_g)).

ldb

Array of group_count parameters ldb_g specifying the leading dimension of B_i from group g (ldb_g ≥ max(1, n_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

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 getrs_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

getrs_batch_scratchpad_size (Group Version)

Description

API