hipsparsesbsrilu02_numericboost Interface Reference

• hipfort_hipsparse
• hipsparsesbsrilu02_numericboost

Public Member Functions | List of all members

hipfort_hipsparse::hipsparsesbsrilu02_numericboost Interface Reference

Public Member Functions
integer(kind(hipsparse_status_success)) function	hipsparsesbsrilu02_numericboost_ (handle, myinfo, enable_boost, tol, boost_val)

Detailed Description

hipsparseXbsrilu02_numericBoost enables the user to replace a numerical value in an incomplete LU factorization. tol is used to determine whether a numerical value is replaced by boost_val, such that \(A_{j,j} = \text{boost_val}\) if \(\text{tol} ≥ \left|A_{j,j}\right|\).

Note

The boost value is enabled by setting enable_boost to 1 or disabled by setting enable_boost to 0.

tol and boost_val can be in host or device memory.

Deprecated:

This function is deprecated when using the CUDA backend (CUDA 12.0+) and will be removed in CUDA 13.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]	enable_boost	- enable/disable numeric boost.
[in]	tol	- tolerance to determine whether a numerical value is replaced or not.
[in]	boost_val	- boost value to replace a numerical value.

Return values

HIPSPARSE_STATUS_SUCCESS	the operation completed successfully.
HIPSPARSE_STATUS_NOT_INITIALIZED	handle is not initialized.
HIPSPARSE_STATUS_INVALID_VALUE	handle, info, tol, or boost_val is nullptr.
HIPSPARSE_STATUS_INTERNAL_ERROR	an internal error occurred.

Member Function/Subroutine Documentation

◆ hipsparsesbsrilu02_numericboost_()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsesbsrilu02_numericboost::hipsparsesbsrilu02_numericboost_	(	type(c_ptr), value	handle,
		type(c_ptr), value	myinfo,
		integer(c_int), value	enable_boost,
		real(c_double)	tol,
		real(c_float)	boost_val
	)

---

The documentation for this interface was generated from the following file:

• hipfort_hipsparse.F90