hipblaszgetrf Interface Reference

hipblaszgetrf Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblaszgetrf Interface Reference
hipfort_hipblas::hipblaszgetrf Interface Reference

SOLVER API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblaszgetrf_ (handle, n, A, lda, ipiv, myInfo)
 
integer(kind(hipblas_status_success)) function hipblaszgetrf_full_rank (handle, n, A, lda, ipiv, myInfo)
 
integer(kind(hipblas_status_success)) function hipblaszgetrf_rank_0 (handle, n, A, lda, ipiv, myInfo)
 
integer(kind(hipblas_status_success)) function hipblaszgetrf_rank_1 (handle, n, A, lda, ipiv, myInfo)
 

Detailed Description

SOLVER API.

getrf computes the LU factorization of a general n-by-n matrix A using partial pivoting with row interchanges. The LU factorization can be done without pivoting if ipiv is passed as a nullptr.

In the case that ipiv is not null, the factorization has the form:

\[ A = PLU \]

where P is a permutation matrix, L is lower triangular with unit diagonal elements, and U is upper triangular.

In the case that ipiv is null, the factorization is done without pivoting:

\[ A = LU \]

Parameters
[in]handlehipblasHandle_t.
[in]nint. n >= 0.
The number of columns and rows of the matrix A.
[in,out]Apointer to type. Array on the GPU of dimension lda*n.
On entry, the n-by-n matrix A to be factored. On exit, the factors L and U from the factorization. The unit diagonal elements of L are not stored.
[in]ldaint. lda >= n.
Specifies the leading dimension of A.
[out]ipivpointer to int. Array on the GPU of dimension n.
The vector of pivot indices. Elements of ipiv are 1-based indices. For 1 <= i <= n, the row i of the matrix was interchanged with row ipiv[i]. Matrix P of the factorization can be derived from ipiv. The factorization here can be done without pivoting if ipiv is passed in as a nullptr.
[out]infopointer to a int on the GPU.
If info = 0, successful exit. If info = j > 0, U is singular. U[j,j] is the first zero pivot.

Member Function/Subroutine Documentation

◆ hipblaszgetrf_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgetrf::hipblaszgetrf_ ( type(c_ptr), value  handle,
integer(c_int), value  n,
type(c_ptr), value  A,
integer(c_int), value  lda,
type(c_ptr), value  ipiv,
type(c_ptr), value  myInfo 
)

◆ hipblaszgetrf_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgetrf::hipblaszgetrf_full_rank ( type(c_ptr)  handle,
integer(c_int)  n,
complex(c_double_complex), dimension(:,:), target  A,
integer(c_int)  lda,
type(c_ptr)  ipiv,
type(c_ptr)  myInfo 
)

◆ hipblaszgetrf_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgetrf::hipblaszgetrf_rank_0 ( type(c_ptr)  handle,
integer(c_int)  n,
complex(c_double_complex), target  A,
integer(c_int)  lda,
type(c_ptr)  ipiv,
type(c_ptr)  myInfo 
)

◆ hipblaszgetrf_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgetrf::hipblaszgetrf_rank_1 ( type(c_ptr)  handle,
integer(c_int)  n,
complex(c_double_complex), dimension(:), target  A,
integer(c_int)  lda,
type(c_ptr)  ipiv,
type(c_ptr)  myInfo 
)

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