hipblassgetrf Interface Reference

• hipfort_hipblas
• hipblassgetrf

Public Member Functions | List of all members

hipfort_hipblas::hipblassgetrf Interface Reference

SOLVER API. More...

Public Member Functions
integer(kind(hipblas_status_success)) function	hipblassgetrf_ (handle, n, a, lda, ipiv, myinfo)
integer(kind(hipblas_status_success)) function	hipblassgetrf_rank_0 (handle, n, a, lda, ipiv, myinfo)
integer(kind(hipblas_status_success)) function	hipblassgetrf_rank_1 (handle, n, a, lda, ipiv, myinfo)
integer(kind(hipblas_status_success)) function	hipblassgetrf_full_rank (handle, n, a, lda, ipiv, myinfo)

Detailed Description

SOLVER API.

The getrf functions compute 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.

When 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.

When ipiv is null, the factorization is done without pivoting:

\[ A = LU \]

• Supported precisions in rocSOLVER : s, d, c, and z.
• Supported precisions in cuBLAS : s, d, c, and z.

Parameters

[in]	handle	- hipblasHandle_t.
[in]	n	- int. n >= 0. The number of columns and rows of the matrix A.
[in,out]	A	- pointer 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]	lda	- int. lda >= n. Specifies the leading dimension of A.
[out]	ipiv	- pointer 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, row i of the matrix was interchanged with row ipiv[i]. Matrix P of the factorization can be derived from ipiv. This factorization can be done without pivoting if ipiv is passed in as a nullptr.
[out]	myInfo	- pointer 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

◆ hipblassgetrf_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgetrf::hipblassgetrf_	(	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
	)

◆ hipblassgetrf_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgetrf::hipblassgetrf_full_rank	(	type(c_ptr)	handle,
		integer(c_int)	n,
		real(c_float), dimension(:,:), target	a,
		integer(c_int)	lda,
		integer(c_int), dimension(:), target	ipiv,
		type(c_ptr)	myinfo
	)

◆ hipblassgetrf_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgetrf::hipblassgetrf_rank_0	(	type(c_ptr)	handle,
		integer(c_int)	n,
		real(c_float), target	a,
		integer(c_int)	lda,
		integer(c_int), target	ipiv,
		type(c_ptr)	myinfo
	)

◆ hipblassgetrf_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgetrf::hipblassgetrf_rank_1	(	type(c_ptr)	handle,
		integer(c_int)	n,
		real(c_float), dimension(:), target	a,
		integer(c_int)	lda,
		integer(c_int), dimension(:), target	ipiv,
		type(c_ptr)	myinfo
	)

---

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

• hipfort_hipblas.F90