hipfftmakeplanmany Interface Reference

hipfftmakeplanmany Interface Reference#

HIPFORT API Reference: hipfort_hipfft::hipfftmakeplanmany Interface Reference
hipfort_hipfft::hipfftmakeplanmany Interface Reference

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

Public Member Functions

integer(kind(hipfft_success)) function hipfftmakeplanmany_ (plan, rank, n, inembed, istride, idist, onembed, ostride, odist, myType, batch, workSize)
 
integer(kind(hipfft_success)) function hipfftmakeplanmany_rank_0 (plan, rank, n, inembed, istride, idist, onembed, ostride, odist, myType, batch, workSize)
 
integer(kind(hipfft_success)) function hipfftmakeplanmany_rank_1 (plan, rank, n, inembed, istride, idist, onembed, ostride, odist, myType, batch, workSize)
 

Detailed Description

Initialize a new batched rank-dimensional FFT plan.

Assumes that the plan has been created already, and modifies the plan associated with the plan handle. The batch parameter tells hipFFT how many transforms to perform. Used in complicated usage case like flexible input and output layout.

Parameters
[in]planPointer to the FFT plan.
[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.
[out]workSizePointer to work area size (returned value).

Member Function/Subroutine Documentation

◆ hipfftmakeplanmany_()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftmakeplanmany::hipfftmakeplanmany_ ( type(c_ptr), value  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,
type(c_ptr), value  workSize 
)

◆ hipfftmakeplanmany_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftmakeplanmany::hipfftmakeplanmany_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,
integer(c_size_t), target  workSize 
)

◆ hipfftmakeplanmany_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftmakeplanmany::hipfftmakeplanmany_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,
integer(c_size_t), dimension(:), target  workSize 
)

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