getri_batch (USM Strided Version)¶

Computes the batch of inverses of an LU-factored general matrices determined by getrf_batch (USM stride version) function. This routine belongs to the oneapi::mkl::lapack namespace.

Description ¶

The routine computes the inverses A₁-1 of a general matrices A₁. Before calling this routine, call getrf_batch (USM Strided Version) function to factorize A₁.

API ¶

Syntax¶

namespace oneapi::mkl::lapack {
  cl::sycl::event getri_batch(cl::sycl::queue &queue,
  std::int64_t n,
  T *a,
 std::int64_t lda,
 std::int64_t stride_a,
 std::int64_t *ipiv,
 std::int64_t stride_ipiv,
 std::int64_t batch_size,
 T *scratchpad,
 std::int64_t scratchpad_size,
 const std::vector<cl::sycl::event> &events = {})
}

Function supports the following precisions and devices.

T	Devices supported
`float`	Host, CPU, and GPU
`double`	Host, CPU, and GPU
`std::complex<float>`	Host, CPU, and GPU
`std::complex<double>`	Host, CPU, and GPU

Input Parameters¶

queue: Device queue where calculations will be performed.
n: The order of the matrices A_i (0 ≤ n).
a: Result of the getrf_batch (USM Strided Version) function
lda: The leading dimension of A_i (n ≤ lda).
stride_a: The stride between the beginnings of matrices A_i inside the batch array a.
ipiv: The array as returned by getrf_batch (USM Strided Version).
stride_ipiv: The stride between the beginnings of arrays ipiv_i inside the array ipiv.
batch_size: Specifies the number of problems in a batch.
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 than the value returned by stride version of getri_batch_scratchpad_size (Strided Version) function.
events: List of events to wait for before starting computation. Defaults to empty list.

Output Parameters¶

a: Overwritten by the n-by-n matrices A_i^-1.

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.

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.

Return Values¶

Output event to wait on to ensure computation is complete.

getri_batch (Group Version) getri_batch_scratchpad_size (Group Version)

oneAPI Math Kernel Library (oneMKL) documentation