hipblassgetrfbatched Interface Reference

hipblassgetrfbatched Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblassgetrfbatched Interface Reference

SOLVER API. More...

Public Member Functions
integer(kind(hipblas_status_success)) function	hipblassgetrfbatched_ (handle, n, a, lda, ipiv, myinfo, batchcount)

Detailed Description

SOLVER API.

The getrfBatched functions compute the LU factorization of a batch of general n -by-n matrices 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 of matrix \(A_i\) in the batch has the form:

\[ A_i = P_iL_iU_i \]

where \(P_i\) is a permutation matrix, \(L_i\) is lower triangular with unit diagonal elements, and \(U_i\) is upper triangular.

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

\[ A_i = L_iU_i \]

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 all matrices A_i in the batch.
[in,out]	A	- array of pointers to type. Each pointer points to an array on the GPU of dimension lda*n. On entry, the n-by-n matrices A_i to be factored. On exit, the factors L_i and U_i from the factorizations. The unit diagonal elements of L_i are not stored.
[in]	lda	- int. lda >= n. Specifies the leading dimension of matrices A_i.
[out]	ipiv	- pointer to int. Array on the GPU. Contains the vectors of pivot indices ipiv_i (corresponding to A_i). Dimension of ipiv_i is n. Elements of ipiv_i are 1-based indices. For each instance A_i in the batch and for 1 <= j <= n, row j of the matrix A_i was interchanged with row ipiv_i[j]. Matrix P_i of the factorization can be derived from ipiv_i. This factorization can be done without pivoting if ipiv is passed in as a nullptr.
[out]	myInfo	- pointer to int. Array of batchCount integers on the GPU. If info[i] = 0, successful exit for factorization of A_i. If info[i] = j > 0, U_i is singular. U_i[j,j] is the first zero pivot.
[in]	batchCount	- int. batchCount >= 0. Number of matrices in the batch.

Member Function/Subroutine Documentation