getrs_batch (Buffer Strided Version)

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 3/22/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-B25DBCD0-A4B3-4CB2-8597-256CF827B18F

View Details

getrs_batch (Buffer Strided Version)

Solves a batch of linear equations with an LU-factored square coefficient matrices, with multiple right-hand sides. This routine belongs to the oneapi::mkl::lapack namespace.

Description
API

Description

The routine solves for X_i the following systems of linear equations:

A_i * X_i = B_i If trans = mkl::transpose::notrans
A_i^T * X_i = B_i If trans = mkl::transpose::trans
A_i^H * X_i = B_i If trans = mkl::transpose::conjtrans

Before calling this routine you must call getrf_batch (Buffer Strided Version) to compute the LU factorization of A_i.

API

Syntax

 namespace oneapi::mkl::lapack {
   void getrs_batch(sycl::queue &queue,
   mkl::transpose trans,
   std::int64_t n,
   std::int64_t nrhs,
   sycl::buffer<T> &a,
   std::int64_t lda,
   std::int64_t stride_a,
   sycl::buffer<std::int64_t> &ipiv,
   std::int64_t stride_ipiv,
   sycl::buffer<T> &b,
   std::int64_t ldb,
   std::int64_t stride_b,
   std::int64_t batch_size,
   sycl::buffer<T> &scratchpad,
   std::int64_t scratchpad_size)
}

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

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).

a

Array containing the factorizations of the matrices A_i, as returned by getrf_batch (Buffer Strided Version).

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)).

ipiv

The ipiv array, as returned by getrf_batch (Buffer Strided Version).

stride_ipiv

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

b

The array containing the matrices B_i whose columns are the right-hand sides for the systems of equations.

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).

scratchpad

Scratchpad memory to be used by routine for storing intermediate results.

scratchpad_size

Size of scratchpad memory as a number of floating point elements of type T. Size should not be less then the value returned by stride version of getrs_batch_scratchpad_size (Strided Version) function.

Output Parameters

b: Overwritten by the solution matrices X_i.

Exceptions

Exception	Description
`mkl::lapack::batch_exception`	This exception is thrown when problems occur during calculations. You can obtain the info code of the problem using the info() method of the exception object: If `info = -n`, the `n`-th parameter had an illegal value. If `info` equals the value passed as scratchpad size, and detail() returns non-zero, then the passed scratchpad is of insufficient size, and the required size should be not less then value returned by the detail() method of the exception object. If `info` is zero, then the diagonal element of some of `U`_i is zero, and the solve could not be completed. The indexes of such matrices in the batch can be obtained with the `ids()` method of the exception object. You can obtain the indexes of the first zero diagonal elements in these `U`_i matrices using the `infos()` method of the exception object.

Exception

Description

mkl::lapack::batch_exception

This exception is thrown when problems occur during calculations. You can obtain the info code of the problem using the info() method of the exception object:

If info = -n, the n-th parameter had an illegal value.

If info equals the value passed as scratchpad size, and detail() returns non-zero, then the passed scratchpad is of insufficient size, and the required size should be not less then value returned by the detail() method of the exception object.

If info is zero, then the diagonal element of some of U_i is zero, and the solve could not be completed. The indexes of such matrices in the batch can be obtained with the ids() method of the exception object. You can obtain the indexes of the first zero diagonal elements in these U_i matrices using the infos() method of the exception object.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

getrs_batch (Buffer Strided Version)

Description

API