rocfft_execute Interface Reference

rocfft_execute Interface Reference#

HIPFORT API Reference: hipfort_rocfft::rocfft_execute Interface Reference
hipfort_rocfft::rocfft_execute Interface Reference

! More...

Public Member Functions

integer(kind(rocfft_status_success)) function rocfft_execute_orig (plan, in_buffer, out_buffer, myInfo)
 

Detailed Description

!

Execute an FFT plan

This API executes an FFT plan on buffers given by the user. If the transform is in-place, only the input buffer is needed and the output buffer parameter can be set to NULL. For not in-place transforms, output buffers have to be specified. Note that both input and output buffer are arrays of pointers, this is to facilitate passing planar buffers where real and imaginary parts are in 2 separate buffers. For the default interleaved format, just a unit sized array holding the pointer to inputoutput buffer need to be passed. The final parameter in this function is an execution_info handle. This parameter serves as a way for the user to control execution, as well as for the library to pass any execution related information back to the user.

Parameters
[in]planplan handle
[in,out]in_bufferarray (of size 1 for interleaved data, of size 2 for planar data) of input buffers
[in,out]out_bufferarray (of size 1 for interleaved data, of size 2 for planar data) of output buffers, can be nullptr for inplace result placement
[in]infoexecution info handle created by rocfft_execution_info_create

Member Function/Subroutine Documentation

◆ rocfft_execute_orig()

integer(kind(rocfft_status_success)) function hipfort_rocfft::rocfft_execute::rocfft_execute_orig ( type(c_ptr), value  plan,
type(c_ptr)  in_buffer,
type(c_ptr)  out_buffer,
type(c_ptr), value  myInfo 
)

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