rocsparse_bsrilu0_zero_pivot Interface Reference

rocsparse_bsrilu0_zero_pivot Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_bsrilu0_zero_pivot Interface Reference

Incomplete LU factorization with 0 fill-ins and no pivoting using BSR storage format. More...

Public Member Functions
integer(kind(rocsparse_status_success)) function	rocsparse_bsrilu0_zero_pivot_ (handle, myInfo, position)

Detailed Description

Incomplete LU factorization with 0 fill-ins and no pivoting using BSR storage format.

rocsparse_bsrilu0_zero_pivot returns rocsparse_status_zero_pivot, if either a structural or numerical zero has been found during rocsparse_sbsrilu0(), rocsparse_dbsrilu0(), rocsparse_cbsrilu0() or rocsparse_zbsrilu0() computation. The first zero pivot \(j\) at \(A_{j,j}\) is stored in position, using same index base as the BSR matrix.

position can be in host or device memory. If no zero pivot has been found, position is set to -1 and rocsparse_status_success is returned instead.

Note: If a zero pivot is found, position \(=j\) means that either the diagonal block \(A_{j,j}\) is missing (structural zero) or the diagonal block \(A_{j,j}\) is not invertible (numerical zero).; rocsparse_bsrilu0_zero_pivot is a blocking function. It might influence performance negatively.

Parameters

[in]	handle	handle to the rocsparse library context queue.
[in]	info	structure that holds the information collected during the analysis step.
[in,out]	position	pointer to zero pivot \(j\), can be in host or device memory.

Return values

rocsparse_status_success	the operation completed successfully.
rocsparse_status_invalid_handle	the library context was not initialized.
rocsparse_status_invalid_pointer	`info` or `position` pointer is invalid.
rocsparse_status_internal_error	an internal error occurred.
rocsparse_status_zero_pivot	zero pivot has been found.

Member Function/Subroutine Documentation