rocsparse_bsrmv_clear Interface Reference

rocsparse_bsrmv_clear Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_bsrmv_clear Interface Reference

Public Member Functions
integer(kind(rocsparse_status_success)) function	rocsparse_bsrmv_clear_ (handle, myinfo)

Detailed Description

rocsparse_bsrmv_clear deallocates all memory that was allocated by rocsparse_Xbsrmv_analysis(). This is especially useful if memory is an issue and the analysis data is not required anymore for further computation, for example, when switching to another sparse matrix format.

Calling rocsparse_bsrmv_clear is optional. All allocated resources will be cleared when the opaque rocsparse_mat_info object is destroyed using rocsparse_destroy_mat_info().

Note: This routine does not support execution in a hipGraph context.

Parameters

[in]	handle	- handle to the rocSPARSE library context queue.
[in,out]	myInfo	- structure that holds the information collected during 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 for the gathered information could not be deallocated.
rocsparse_status_internal_error	an internal error occurred.

Member Function/Subroutine Documentation