rocsparse_bsric0_clear Interface Reference

rocsparse_bsric0_clear Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_bsric0_clear Interface Reference

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

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

Detailed Description

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

rocsparse_bsric0_clear deallocates all memory that was allocated by rocsparse_sbsric0_analysis(), rocsparse_dbsric0_analysis(), rocsparse_cbsric0_analysis() or rocsparse_zbsric0_analysis(). This is especially useful, if memory is an issue and the analysis data is not required for further computation.

Note: Calling rocsparse_bsric0_clear is optional. All allocated resources will be cleared, when the opaque rocsparse_mat_info struct is destroyed using rocsparse_destroy_mat_info().

Parameters

[in]	handle	handle to the rocsparse library context queue.
[in,out]	info	structure that holds the information collected during the analysis step.

Return values

rocsparse_status_success	the operation completed successfully.
rocsparse_status_invalid_handle	the library context was not initialized.
rocsparse_status_invalid_pointer	`info` pointer is invalid.
rocsparse_status_memory_error	the buffer holding the meta data could not be deallocated.
rocsparse_status_internal_error	an internal error occurred.

Member Function/Subroutine Documentation