rocfft_execution_info_set_work_buffer Interface Reference#
Set work buffer in execution info for the current HIP device. More...
Public Member Functions | |
| integer(kind(rocfft_status_success)) function | rocfft_execution_info_set_work_buffer_ (myinfo, work_buffer, size_in_bytes) |
Detailed Description
Set work buffer in execution info for the current HIP device.
This is one of the execution info functions to specify optional additional information to control execution. This API provides a work buffer for the transform. It must be called before rocfft_execute.
Work memory may be required on any device(s) with input or output data for the transform, and also the current device when the plan was created. If the FFT plan uses multiple devices then this function can be called repeatedly with each of those devices as the current HIP device, to set work memory for all devices.
When a non-zero value is obtained from rocfft_plan_get_work_buffer_size, that means the library needs a work buffer to compute the transform. In this case, the user should allocate the work buffer and pass it to the library via this API.
If a work buffer is required for the transform but is not specified using this function, rocfft_execute will automatically allocate the required buffer and free it when execution is finished.
Users should allocate their own work buffers if they need precise control over the lifetimes of those buffers, or if multiple plans need to share the same buffer.
- Parameters
-
[in] myInfo - execution info handle [in] work_buffer - work buffer [in] size_in_bytes - size of work buffer in bytes
Member Function/Subroutine Documentation
◆ rocfft_execution_info_set_work_buffer_()
| integer(kind(rocfft_status_success)) function hipfort_rocfft::rocfft_execution_info_set_work_buffer::rocfft_execution_info_set_work_buffer_ | ( | type(c_ptr), value | myinfo, |
| type(c_ptr), value | work_buffer, | ||
| integer(c_size_t), value | size_in_bytes | ||
| ) |
The documentation for this interface was generated from the following file: