getrs_batch_scratchpad_size (Strided Version)

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 7/13/2023

Version

Public

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

getrs_batch_scratchpad_size (Strided Version)

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

API

Syntax

namespace oneapi::mkl::lapack {
  std::int64_t getrs_batch_scratchpad_size(sycl::queue &queue,
  mkl::transpose trans,
  std::int64_t n,
  std::int64_t nrhs,
  std::int64_t lda,
  std::int64_t stride_a,
  std::int64_t stride_ipiv,
  std::int64_t ldb,
  std::int64_t stride_b,
  std::int64_t batch_size)
}

Input Parameters

queue

Device queue where calculations will be performed.

trans

Indicates the form of the equations:

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

The order of the matrices A_i and the number of rows in matrices B_i (n ≥ 0).

nrhs

The number of right hand sides (nrhs ≥ 0).

lda

The leading dimension of A_i (lda ≥ max(1, n)).

stride_a

The stride between the beginnings of matrices A_i inside the batch array a (stride_a ≥ max(1, lda * n)).

stride_ipiv

The stride between the beginnings of arrays ipiv_i inside the array ipiv (stride_ipiv ≥ max(1, n)).

ldb

The leading dimensions of B_i (ldb ≥ max(1, n)).

stride_b

The stride between the beginnings of matrices B_i inside the batch array b (stride_b ≥ max(1, ldb * nrhs)).

batch_size

The number of problems in a batch (batch_size ≥ 0).

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 (Strided 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 (Strided Version)

Description

API