rocsparse_bsrsv_zero_pivot Interface Reference

rocsparse_bsrsv_zero_pivot Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_bsrsv_zero_pivot Interface Reference

Sparse triangular solve using BSR storage format. More...

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

Detailed Description

Sparse triangular solve using BSR storage format.

rocsparse_bsrsv_zero_pivot returns rocsparse_status_zero_pivot, if either a structural or numerical zero has been found during rocsparse_sbsrsv_solve(), rocsparse_dbsrsv_solve(), rocsparse_cbsrsv_solve() or rocsparse_zbsrsv_solve() 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: rocsparse_bsrsv_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