potri¶
Computes the inverse of a symmetric (Hermitian) positive-definite matrix using the Cholesky factorization.
potri supports the following precisions.
T
float
double
std::complex<float>
std::complex<double>
Description
The routine computes the inverse inv(A) of a symmetric positive
definite or, for complex flavors, Hermitian positive-definite matrix
A. Before calling this routine, call
potrf
to factorize A.
potri (BUFFER Version)¶
Syntax
-
void
onemkl::lapack::potri(cl::sycl::queue &queue, onemkl::uplo upper_lower, std::int64_t n, cl::sycl::buffer<T, 1> &a, std::int64_t lda, cl::sycl::buffer<T, 1> &scratchpad, std::int64_t scratchpad_size)¶
Input Parameters
- queue
The queue where the routine should be executed.
- upper_lower
Indicates how the input matrix
Ahas been factored:If
upper_lower = onemkl::uplo::upper, the upper triangle ofAis stored.If
upper_lower = onemkl::uplo::lower, the lower triangle ofAis stored.- n
Specifies the order of the matrix
A(0≤n).- a
Contains the factorization of the matrix
A, as returned by potrf. The second dimension ofamust be at leastmax(1, n).- lda
The leading dimension of
a.- 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 potri_scratchpad_size function.
Output Parameters
- a
Overwritten by the upper or lower triangle of the inverse of
A. Specified byupper_lower.- 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
infocode 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=i, thei-th diagonal element of the Cholesky factor (and therefore the factor itself) is zero, and the inversion could not be completed.If
infoequals 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.
potri (USM Version)¶
Syntax
-
cl::sycl::event
onemkl::lapack::potri(cl::sycl::queue &queue, onemkl::uplo upper_lower, std::int64_t n, T *a, std::int64_t lda, 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.
- upper_lower
Indicates how the input matrix
Ahas been factored:If
upper_lower = onemkl::uplo::upper, the upper triangle ofAis stored.If
upper_lower = onemkl::uplo::lower, the lower triangle ofAis stored.- n
Specifies the order of the matrix
A(0≤n).- a
Contains the factorization of the matrix
A, as returned by potrf. The second dimension ofamust be at leastmax(1, n).- lda
The leading dimension of
a.- 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 potri_scratchpad_size function.
- events
List of events to wait for before starting computation. Defaults to empty list.
Output Parameters
- a
Overwritten by the upper or lower triangle of the inverse of
A. Specified byupper_lower.- 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
infocode 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=i, thei-th diagonal element of the Cholesky factor (and therefore the factor itself) is zero, and the inversion could not be completed.If
infoequals 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