potrs (USM Version)#
Solves a system of linear equations with a Cholesky-factored symmetric
(Hermitian) positive-definite coefficient matrix. This routine belongs
to the oneapi::mkl::lapack namespace.
Description#
The routine solves for X the system of linear equations
A*X = B with a symmetric positive-definite or, for
complex data, Hermitian positive-definite matrix A, given the
Cholesky factorization of A:
|
if uplo= |
|
if uplo= |
where L is a lower triangular matrix and U is upper
triangular. The system is solved with multiple right-hand sides
stored in the columns of the matrix B.
Before calling this routine, you must call potrf (USM Version) to compute the Cholesky factorization of A.
API#
Syntax#
namespace oneapi::mkl::lapack {
sycl::event potrs(
sycl::queue &queue,
mkl::uplo uplo,
int64_t n,
int64_t nrhs,
const T *a,
int64_t lda,
T *b,
int64_t ldb,
T *scratchpad,
int64_t scratchpad_size,
const std::vector<sycl::event> &events = {})
}
potrs (USM version) supports the following precisions and devices:
T |
Devices supported |
|---|---|
|
CPU and GPU |
|
CPU and GPU |
|
CPU and GPU |
|
CPU and GPU |
Input Parameters#
- queue
Device queue where calculations will be performed.
- uplo
Indicates how the input matrix has been factored:
If uplo=
mkl::uplo::upper, the upper triangleUofAis stored, whereA=UT*Ufor real data,A=UH*Ufor complex data.If uplo=
mkl::uplo::lower, the upper triangleLofAis stored, whereA=L*LT for real data,A=L*LH for complex data.- n
The order of matrix
A(0 ≤ n).- nrhs
The number of right-hand sides (0 ≤ nrhs).
- a
Pointer to factorization of the matrix
A, as returned by potrf (USM Version). The size ofamust be at leastlda*n.- lda
The leading dimension of a.
- b
Pointer to the data of matrix
Bwhose columns are the right-hand sides for the systems of equations. The size ofbmust be at leastldb*nrhs.- ldb
The leading dimension of b.
- 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 potrs_scratchpad_size function.- events
List of events to wait for before starting computation. Defaults to empty list.
Output Parameters#
- b
The memory pointed to by pointer b is overwritten by the solution matrix
X.
Exceptions#
Exception |
Description |
|---|---|
|
This exception is thrown when problems occur during calculations. You can obtain the info code of the problem using the If If If |
Return Values#
Output event to wait on to ensure computation is complete.