hipfftmakeplan2d Interface Reference

hipfftmakeplan2d Interface Reference#

HIPFORT API Reference: hipfort_hipfft::hipfftmakeplan2d Interface Reference
hipfort_hipfft::hipfftmakeplan2d Interface Reference

Initialize a new two-dimensional FFT plan. More...

Public Member Functions

integer(kind(hipfft_success)) function hipfftmakeplan2d_ (plan, nx, ny, myType, workSize)
 
integer(kind(hipfft_success)) function hipfftmakeplan2d_rank_0 (plan, nx, ny, myType, workSize)
 
integer(kind(hipfft_success)) function hipfftmakeplan2d_rank_1 (plan, nx, ny, myType, workSize)
 

Detailed Description

Initialize a new two-dimensional FFT plan.

Assumes that the plan has been created already, and modifies the plan associated with the plan handle. Two-dimensional data should be stored in C ordering (row-major format), so that indexes in y-direction (j index) vary the fastest.

Parameters
[in]planHandle of the FFT plan.
[in]nxNumber of elements in the x-direction (slow index).
[in]nyNumber of elements in the y-direction (fast index).
[in]typeFFT type.
[out]workSizePointer to work area size (returned value).

Member Function/Subroutine Documentation

◆ hipfftmakeplan2d_()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftmakeplan2d::hipfftmakeplan2d_ ( type(c_ptr), value  plan,
integer(c_int), value  nx,
integer(c_int), value  ny,
integer(kind(hipfft_r2c)), value  myType,
type(c_ptr), value  workSize 
)

◆ hipfftmakeplan2d_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftmakeplan2d::hipfftmakeplan2d_rank_0 ( type(c_ptr)  plan,
integer(c_int)  nx,
integer(c_int)  ny,
integer(kind(hipfft_r2c))  myType,
integer(c_size_t), target  workSize 
)

◆ hipfftmakeplan2d_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftmakeplan2d::hipfftmakeplan2d_rank_1 ( type(c_ptr)  plan,
integer(c_int)  nx,
integer(c_int)  ny,
integer(kind(hipfft_r2c))  myType,
integer(c_size_t), dimension(:), target  workSize 
)

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