getri (USM 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-1BA5951C-BF65-4882-9D3F-26E99E7C167B

View Details

getri (USM Version)

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

Description
API

Description

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

API

Syntax

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

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

Exception	Description
`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.

Exception

Description

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.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

getri (USM Version)

Description

API