getri¶
Computes the inverse of an LU-factored general matrix determined by getrf.
getri
supports the following precisions.
T
float
double
std::complex<float>
std::complex<double>
Description
The routine computes the inverse inv(A)
of a general matrix
A
. Before calling this routine, call
getrf
to factorize A
.
getri (BUFFER Version)¶
Syntax
-
void
onemkl::lapack
::
getri
(cl::sycl::queue &queue, std::int64_t n, cl::sycl::buffer<T, 1> &a, std::int64_t lda, cl::sycl::buffer<std::int64_t, 1> &ipiv, cl::sycl::buffer<T, 1> &scratchpad, std::int64_t scratchpad_size)¶
Input Parameters
- queue
The queue where the routine should be executed.
- n
The order of the matrix
A
(0≤n)
.- a
The buffer
a
as returned by getrf. Must be of size at leastlda*max(1,n)
.- lda
The leading dimension of a
(n≤lda)
.- ipiv
The buffer as returned by getrf. The dimension of ipiv must be at least
max(1, n)
.- 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 getri_scratchpad_size function.
Output Parameters
- a
Overwritten by the n-by-n matrix
A
.- scratchpad
Buffer holding scratchpad memory to be used by routine for storing intermediate results.
Throws
- onemkl::lapack::exception
Exception is thrown in case of problems happened during calculations. The
info
code of the problem can be obtained by get_info() method of exception object:If
info=-i
, thei
-th parameter had an illegal value.If
info
equals to value passed as scratchpad size, andget_detail()
returns non zero, then passed scratchpad is of insufficient size, and required size should not be less than value return byget_detail()
method of exception object.
getri (USM Version)¶
Syntax
-
cl::sycl::event
onemkl::lapack
::
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 = {})¶
Input Parameters
- queue
The queue where the routine should be executed.
- n
The order of the matrix
A
(0≤n)
.- a
The array as returned by getrf. 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. The dimension of ipiv must be at least
max(1, n)
.- 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 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
A
.- scratchpad
Pointer to scratchpad memory to be used by routine for storing intermediate results.
Throws
- onemkl::lapack::exception
Exception is thrown in case of problems happened during calculations. The
info
code of the problem can be obtained by get_info() method of exception object:If
info=-i
, thei
-th parameter had an illegal value.If
info
equals to value passed as scratchpad size, andget_detail()
returns non zero, then passed scratchpad is of insufficient size, and required size should not be less than value return byget_detail()
method of exception object.
Return Values
Output event to wait on to ensure computation is complete.
Parent topic: LAPACK Linear Equation Routines