rocsparse_bsrsm_zero_pivot Interface Reference

rocsparse_bsrsm_zero_pivot Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_bsrsm_zero_pivot Interface Reference

Public Member Functions
integer(kind(rocsparse_status_success)) function	rocsparse_bsrsm_zero_pivot_ (handle, myinfo, position)

Detailed Description

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

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

Note: rocsparse_bsrsm_zero_pivot is a blocking function. It might negatively influence performance.; This routine does not support execution in a hipGraph context.

Parameters

[in]	handle	- handle to the rocSPARSE library context queue.
[in]	myInfo	- structure that holds the information collected during the analysis step.
[in,out]	position	- pointer to zero pivot \(j\), which 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