rocfft_execute Interface Reference

rocfft_execute Interface Reference#

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

Execute an FFT plan. More...

Public Member Functions

integer(kind(rocfft_status_success)) function rocfft_execute_ (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.

Input and output buffer are arrays of pointers. Interleaved array formats are the default, and require just one pointer per input or output buffer. Planar array formats require two pointers per input or output buffer - real and imaginary pointers, in that order.

Note that input buffers may still be overwritten during execution of a transform, even if the transform is not in-place.

The final parameter in this function is a rocfft_execution_info handle. This optional parameter serves as a way for the user to control execution streams and work buffers.

[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, ignored for in-place transforms
[in]infoexecution info handle created by rocfft_execution_info_create

Member Function/Subroutine Documentation

◆ rocfft_execute_()

integer(kind(rocfft_status_success)) function hipfort_rocfft::rocfft_execute::rocfft_execute_ ( 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: