hipsparsexcsrsv2_zeropivot Interface Reference

hipsparsexcsrsv2_zeropivot Interface Reference#

HIPFORT API Reference: hipfort_hipsparse::hipsparsexcsrsv2_zeropivot Interface Reference

Public Member Functions
integer(kind(hipsparse_status_success)) function	hipsparsexcsrsv2_zeropivot_ (handle, myinfo, position)

Detailed Description

hipsparseXcsrsv2_zeroPivot returns HIPSPARSE_STATUS_ZERO_PIVOT if either a structural or numerical zero has been found during hipsparseScsrsv2_solve(), hipsparseDcsrsv2_solve(), hipsparseCcsrsv2_solve(), or hipsparseZcsrsv2_solve() computation. The first zero pivot \(j\) at \(A_{j,j}\) is stored in position, using same index base as the CSR matrix.

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

Note: hipsparseXcsrsv2_zeroPivot is a blocking function. It might negatively influence performance.

Deprecated:: This function is deprecated when using the CUDA backend (CUDA 11.0+) and will be removed in CUDA 12.0. This deprecation does not apply to the ROCm backend.

Parameters

[in]	handle	- handle to the hipSPARSE 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

HIPSPARSE_STATUS_SUCCESS	the operation completed successfully.
HIPSPARSE_STATUS_NOT_INITIALIZED	`handle` is not initialized.
HIPSPARSE_STATUS_INVALID_VALUE	`handle`, `info`, or `position` is nullptr.
HIPSPARSE_STATUS_INTERNAL_ERROR	an internal error occurred.
HIPSPARSE_STATUS_ZERO_PIVOT	zero pivot has been found.

Member Function/Subroutine Documentation