rocsparse_bsrsm_clear Interface Reference

rocsparse_bsrsm_clear Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_bsrsm_clear Interface Reference

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

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

Detailed Description

Sparse triangular system solve using BSR storage format.

rocsparse_bsrsm_clear deallocates all memory that was allocated by rocsparse_sbsrsm_analysis(), rocsparse_dbsrsm_analysis(), rocsparse_cbsrsm_analysis() or rocsparse_zbsrsm_analysis(). This is especially useful, if memory is an issue and the analysis data is not required for further computation, e.g. when switching to another sparse matrix format. Calling rocsparse_bsrsm_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