rocsparse_create_handle Interface Reference

rocsparse_create_handle Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_create_handle Interface Reference

Create a rocsparse handle. More...

Public Member Functions
integer(kind(rocsparse_status_success)) function	rocsparse_create_handle_ (handle)

Detailed Description

Create a rocsparse handle.

rocsparse_create_handle creates the rocSPARSE library context. It must be initialized before any other rocSPARSE API function is invoked and must be passed to all subsequent library function calls. The handle should be destroyed at the end using rocsparse_destroy_handle().

Parameters

[out] handle the pointer to the handle to the rocSPARSE library context.

Return values

rocsparse_status_success	the initialization succeeded.
rocsparse_status_invalid_handle	`handle` pointer is invalid.
rocsparse_status_internal_error	an internal error occurred.

Member Function/Subroutine Documentation