rocfft_execution_info_set_store_callback Interface Reference

rocfft_execution_info_set_store_callback Interface Reference#

HIPFORT API Reference: hipfort_rocfft::rocfft_execution_info_set_store_callback Interface Reference
hipfort_rocfft::rocfft_execution_info_set_store_callback Interface Reference

Set a store callback for a plan execution (experimental) More...

Public Member Functions

integer(kind(rocfft_status_success)) function rocfft_execution_info_set_store_callback_ (myInfo, cb_functions, cb_data, shared_mem_bytes)

Detailed Description

Set a store callback for a plan execution (experimental)

This function specifies a user-defined callback function that is run to store output to global memory at the end of the transform. Callbacks are an experimental feature in rocFFT.

Callback function pointers/data are given as arrays, with one function/data pointer per device executing this plan. Currently, plans can only use one device.

The provided function pointers replace any previously-specified store callback for this execution info handle.

Store callbacks have the following signature:

void store_cb(t* data, size_t offset, t element, void* cbdata, void* sharedmem);

'T' is the type of a single element of the output buffer. It is the caller's responsibility to ensure that the function type is appropriate for the plan (for example, a single-precision real-to-complex transform would store single-precision complex elements).

A null value for 'cb' may be specified to clear any previously registered store callback.

Currently, 'shared_mem_bytes' must be 0. Callbacks are not supported on transforms that use planar formats for either input or output.

[in]infoexecution info handle
[in]cbcallbacks function pointers
[in]cbdatacallback function data, passed to the function pointer when it is called
[in]shared_mem_bytesamount of shared memory to allocate for the callback function to use

Member Function/Subroutine Documentation

◆ rocfft_execution_info_set_store_callback_()

integer(kind(rocfft_status_success)) function hipfort_rocfft::rocfft_execution_info_set_store_callback::rocfft_execution_info_set_store_callback_ ( type(c_ptr), value  myInfo,
type(c_ptr)  cb_functions,
type(c_ptr)  cb_data,
integer(c_size_t), value  shared_mem_bytes 

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