This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

rocsolver_spotrf Interface Reference

rocsolver_spotrf Interface Reference#

HIPFORT API Reference: hipfort_rocsolver::rocsolver_spotrf Interface Reference
hipfort_rocsolver::rocsolver_spotrf Interface Reference

POTRF computes the Cholesky factorization of a real symmetric (complex Hermitian) positive definite matrix A. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocsolver_spotrf_ (handle, uplo, n, A, lda, myInfo)
 
integer(kind(rocblas_status_success)) function rocsolver_spotrf_full_rank (handle, uplo, n, A, lda, myInfo)
 
integer(kind(rocblas_status_success)) function rocsolver_spotrf_rank_0 (handle, uplo, n, A, lda, myInfo)
 
integer(kind(rocblas_status_success)) function rocsolver_spotrf_rank_1 (handle, uplo, n, A, lda, myInfo)
 

Detailed Description

POTRF computes the Cholesky factorization of a real symmetric (complex Hermitian) positive definite matrix A.

(This is the blocked version of the algorithm).

The factorization has the form:

\[ \begin{array}{cl} A = U'U & \: \text{if uplo is upper, or}\newline A = LL' & \: \text{if uplo is lower.} \end{array} \]

U is an upper triangular matrix and L is lower triangular.

Parameters
[in]handlerocblas_handle.
[in]uplorocblas_fill.
Specifies whether the factorization is upper or lower triangular. If uplo indicates lower (or upper), then the upper (or lower) part of A is not used.
[in]nrocblas_int. n >= 0.
The number of rows and columns of matrix A.
[in,out]Apointer to type. Array on the GPU of dimension lda*n.
On entry, the matrix A to be factored. On exit, the lower or upper triangular factor.
[in]ldarocblas_int. lda >= n.
specifies the leading dimension of A.
[out]infopointer to a rocblas_int on the GPU.
If info = 0, successful factorization of matrix A. If info = j > 0, the leading minor of order j of A is not positive definite. The factorization stopped at this point.

Member Function/Subroutine Documentation

◆ rocsolver_spotrf_()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_spotrf::rocsolver_spotrf_ ( type(c_ptr), value  handle,
integer(kind(rocblas_fill_upper)), value  uplo,
integer(c_int), value  n,
type(c_ptr), value  A,
integer(c_int), value  lda,
integer(c_int)  myInfo 
)

◆ rocsolver_spotrf_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_spotrf::rocsolver_spotrf_full_rank ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
real(c_float), dimension(:,:), target  A,
integer(c_int)  lda,
integer(c_int)  myInfo 
)

◆ rocsolver_spotrf_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_spotrf::rocsolver_spotrf_rank_0 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
real(c_float), target  A,
integer(c_int)  lda,
integer(c_int)  myInfo 
)

◆ rocsolver_spotrf_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_spotrf::rocsolver_spotrf_rank_1 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
real(c_float), dimension(:), target  A,
integer(c_int)  lda,
integer(c_int)  myInfo 
)

The documentation for this interface was generated from the following file: