getri (USM Version)

Computes the inverse of an LU-factored general matrix determined by getrf (USM Version). This routine belongs to the oneapi::mkl::lapacknamespace.

Syntax

cl::sycl::event getri(cl::sycl::queue &queue, std::int64_t n, T *a, std::int64_t lda, std::int64_t *ipiv, T *scratchpad, std::int64_t scratchpad_size, const cl::sycl::vector_class<cl::sycl::event> &events = {})

getri (USM version) 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

Description

The routine computes the inverse inv(A) of a general matrix A. Before calling this routine, call getrf (USM Version) to factorize A.

Input Parameters

queue

Device queue where calculations will be performed.

n

The order of the matrix A(0≤n).

a

The pointer returned by getrf (USM Version). Must be of size at least lda*max(1,n).

lda

The leading dimension of a(n≤lda).

ipiv

The array as returned by getrf (USM Version). The dimension of ipiv must be at least max(1, n).

scratchpad

Pointer to scratchpad memory to be used by the 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 the getri_scratchpad_size function.

events

List of events to wait for before starting computation. Defaults to empty list.

Output Parameters

a

Overwritten by the n-by-n matrix inv(A).

Exceptions

mkl::lapack::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 = -i, the i-th parameter had an illegal value. If info is equal to the value passed as scratchpad size, and detail() returns non zero, then the passed scratchpad has an insufficient size, and the required size should not be less than the value returned by the detail() method of the exception object.

Return Values

Output event to wait on to ensure computation is complete.