hipfftplanmany Interface Reference

hipfftplanmany Interface Reference#

HIPFORT API Reference: hipfort_hipfft::hipfftplanmany Interface Reference
hipfort_hipfft::hipfftplanmany Interface Reference

Create a new batched rank-dimensional FFT plan. More...

Public Member Functions

integer(kind(hipfft_success)) function hipfftplanmany_ (plan, rank, n, inembed, istride, idist, onembed, ostride, odist, myType, batch)
 
integer(kind(hipfft_success)) function hipfftplanmany_rank_0 (plan, rank, n, inembed, istride, idist, onembed, ostride, odist, myType, batch)
 
integer(kind(hipfft_success)) function hipfftplanmany_rank_1 (plan, rank, n, inembed, istride, idist, onembed, ostride, odist, myType, batch)
 

Detailed Description

Create a new batched rank-dimensional FFT plan.

Allocate and initialize a new batched rank-dimensional FFT. The batch parameter tells hipFFT how many transforms to perform. Used in complicated usage case like flexible input and output layout.

Parameters
[out]planPointer to the FFT plan handle.
[in]rankDimension of FFT transform (1, 2, or 3).
[in]nNumber of elements in the x/y/z directions.
[in]inembed
[in]istride
[in]idistDistance between input batches.
[in]onembed
[in]ostride
[in]odistDistance between output batches.
[in]typeFFT type.
[in]batchNumber of batched transforms to perform.

Member Function/Subroutine Documentation

◆ hipfftplanmany_()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftplanmany::hipfftplanmany_ ( type(c_ptr)  plan,
integer(c_int), value  rank,
type(c_ptr), value  n,
type(c_ptr), value  inembed,
integer(c_int), value  istride,
integer(c_int), value  idist,
type(c_ptr), value  onembed,
integer(c_int), value  ostride,
integer(c_int), value  odist,
integer(kind(hipfft_r2c)), value  myType,
integer(c_int), value  batch 
)

◆ hipfftplanmany_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftplanmany::hipfftplanmany_rank_0 ( type(c_ptr)  plan,
integer(c_int)  rank,
integer(c_int), target  n,
integer(c_int), target  inembed,
integer(c_int)  istride,
integer(c_int)  idist,
integer(c_int), target  onembed,
integer(c_int)  ostride,
integer(c_int)  odist,
integer(kind(hipfft_r2c))  myType,
integer(c_int)  batch 
)

◆ hipfftplanmany_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftplanmany::hipfftplanmany_rank_1 ( type(c_ptr)  plan,
integer(c_int)  rank,
integer(c_int), dimension(:), target  n,
integer(c_int), dimension(:), target  inembed,
integer(c_int)  istride,
integer(c_int)  idist,
integer(c_int), dimension(:), target  onembed,
integer(c_int)  ostride,
integer(c_int)  odist,
integer(kind(hipfft_r2c))  myType,
integer(c_int)  batch 
)

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