This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

rocsparse_set_stream Interface Reference

rocsparse_set_stream Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_set_stream Interface Reference
hipfort_rocsparse::rocsparse_set_stream Interface Reference

Specify user defined HIP stream. More...

Public Member Functions

integer(kind(rocsparse_status_success)) function rocsparse_set_stream_ (handle, stream)
 

Detailed Description

Specify user defined HIP stream.

rocsparse_set_stream specifies the stream to be used by the rocSPARSE library context and all subsequent function calls.

Parameters
[in,out]handlethe handle to the rocSPARSE library context.
[in]streamthe stream to be used by the rocSPARSE library context.
Return values
rocsparse_status_successthe operation completed successfully.
rocsparse_status_invalid_handlehandle is invalid.
Example
This example illustrates, how a user defined stream can be used in rocSPARSE.
/ Create rocSPARSE handle
rocsparse_handle handle;
rocsparse_create_handle(&handle);
/ Create stream
hipStream_t stream;
hipStreamCreate(&stream);
/ Set stream to rocSPARSE handle
rocsparse_set_stream(handle, stream);
/ Do some work
/ ...
/ Clean up
rocsparse_destroy_handle(handle);
hipStreamDestroy(stream);
@ to
Definition: hipfort_enums.f:49

Member Function/Subroutine Documentation

◆ rocsparse_set_stream_()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_set_stream::rocsparse_set_stream_ ( type(c_ptr), value  handle,
type(c_ptr), value  stream 
)

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