hipfort_hipfft Module Reference

hipfort_hipfft Module Reference#

HIPFORT API Reference: hipfort_hipfft Module Reference
hipfort_hipfft Module Reference

Data Types

interface  hipfftcreate
 Allocate a new plan. More...
 
interface  hipfftdestroy
 Destroy and deallocate an existing plan. More...
 
interface  hipfftestimate1d
 Return an estimate of the work area size required for a 1D plan. More...
 
interface  hipfftestimate2d
 Return an estimate of the work area size required for a 2D plan. More...
 
interface  hipfftestimate3d
 Return an estimate of the work area size required for a 3D plan. More...
 
interface  hipfftestimatemany
 Return an estimate of the work area size required for a rank-dimensional plan. More...
 
interface  hipfftexecc2c
 Execute a (float) complex-to-complex FFT. More...
 
interface  hipfftexecc2r
 Execute a (float) complex-to-real FFT. More...
 
interface  hipfftexecd2z
 Execute a (double) real-to-complex FFT. More...
 
interface  hipfftexecr2c
 Execute a (float) real-to-complex FFT. More...
 
interface  hipfftexecz2d
 Execute a (double) complex-to-real FFT. More...
 
interface  hipfftexecz2z
 Execute a (double) complex-to-complex FFT. More...
 
interface  hipfftextplanscalefactor
 Set scaling factor. More...
 
interface  hipfftgetproperty
 Get library property. More...
 
interface  hipfftgetsize
 Return size of the work area size required for a rank-dimensional plan. More...
 
interface  hipfftgetsize1d
 Return size of the work area size required for a 1D plan. More...
 
interface  hipfftgetsize2d
 Return size of the work area size required for a 2D plan. More...
 
interface  hipfftgetsize3d
 Return size of the work area size required for a 3D plan. More...
 
interface  hipfftgetsizemany
 Return size of the work area size required for a rank-dimensional plan. More...
 
interface  hipfftgetsizemany64
 
interface  hipfftgetversion
 Get rocFFT/cuFFT version. More...
 
interface  hipfftmakeplan1d
 Initialize a new one-dimensional FFT plan. More...
 
interface  hipfftmakeplan2d
 Initialize a new two-dimensional FFT plan. More...
 
interface  hipfftmakeplan3d
 Initialize a new two-dimensional FFT plan. More...
 
interface  hipfftmakeplanmany
 Initialize a new batched rank-dimensional FFT plan with advanced data layout. More...
 
interface  hipfftmakeplanmany64
 
interface  hipfftplan1d
 Create a new one-dimensional FFT plan. More...
 
interface  hipfftplan2d
 Create a new two-dimensional FFT plan. More...
 
interface  hipfftplan3d
 Create a new three-dimensional FFT plan. More...
 
interface  hipfftplanmany
 Create a new batched rank-dimensional FFT plan with advanced data layout. More...
 
interface  hipfftsetautoallocation
 Set the plan's auto-allocation flag. More...
 
interface  hipfftsetstream
 Set HIP stream to execute plan on. More...
 
interface  hipfftsetworkarea
 Set the plan's work area. More...
 

Functions/Subroutines

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)
 
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)
 
integer(kind(hipfft_success)) function hipfftmakeplanmany64_rank_0 (plan, rank, n, inembed, istride, idist, onembed, ostride, odist, mytype, batch, worksize)
 
integer(kind(hipfft_success)) function hipfftmakeplanmany64_rank_1 (plan, rank, n, inembed, istride, idist, onembed, ostride, odist, mytype, batch, worksize)
 
integer(kind(hipfft_success)) function hipfftestimatemany_rank_0 (rank, n, inembed, istride, idist, onembed, ostride, odist, mytype, batch, worksize)
 
integer(kind(hipfft_success)) function hipfftestimatemany_rank_1 (rank, n, inembed, istride, idist, onembed, ostride, odist, mytype, batch, worksize)
 
integer(kind(hipfft_success)) function hipfftgetsizemany_rank_0 (plan, rank, n, inembed, istride, idist, onembed, ostride, odist, mytype, batch, worksize)
 
integer(kind(hipfft_success)) function hipfftgetsizemany_rank_1 (plan, rank, n, inembed, istride, idist, onembed, ostride, odist, mytype, batch, worksize)
 
integer(kind(hipfft_success)) function hipfftgetsizemany64_rank_0 (plan, rank, n, inembed, istride, idist, onembed, ostride, odist, mytype, batch, worksize)
 
integer(kind(hipfft_success)) function hipfftgetsizemany64_rank_1 (plan, rank, n, inembed, istride, idist, onembed, ostride, odist, mytype, batch, worksize)
 
integer(kind(hipfft_success)) function hipfftexecc2c_rank_0 (plan, idata, odata, direction)
 
integer(kind(hipfft_success)) function hipfftexecc2c_rank_1 (plan, idata, odata, direction)
 
integer(kind(hipfft_success)) function hipfftexecc2c_rank_2 (plan, idata, odata, direction)
 
integer(kind(hipfft_success)) function hipfftexecc2c_rank_3 (plan, idata, odata, direction)
 
integer(kind(hipfft_success)) function hipfftexecr2c_rank_0 (plan, idata, odata)
 
integer(kind(hipfft_success)) function hipfftexecr2c_rank_1 (plan, idata, odata)
 
integer(kind(hipfft_success)) function hipfftexecr2c_rank_2 (plan, idata, odata)
 
integer(kind(hipfft_success)) function hipfftexecr2c_rank_3 (plan, idata, odata)
 
integer(kind(hipfft_success)) function hipfftexecc2r_rank_0 (plan, idata, odata)
 
integer(kind(hipfft_success)) function hipfftexecc2r_rank_1 (plan, idata, odata)
 
integer(kind(hipfft_success)) function hipfftexecc2r_rank_2 (plan, idata, odata)
 
integer(kind(hipfft_success)) function hipfftexecc2r_rank_3 (plan, idata, odata)
 
integer(kind(hipfft_success)) function hipfftexecz2z_rank_0 (plan, idata, odata, direction)
 
integer(kind(hipfft_success)) function hipfftexecz2z_rank_1 (plan, idata, odata, direction)
 
integer(kind(hipfft_success)) function hipfftexecz2z_rank_2 (plan, idata, odata, direction)
 
integer(kind(hipfft_success)) function hipfftexecz2z_rank_3 (plan, idata, odata, direction)
 
integer(kind(hipfft_success)) function hipfftexecd2z_rank_0 (plan, idata, odata)
 
integer(kind(hipfft_success)) function hipfftexecd2z_rank_1 (plan, idata, odata)
 
integer(kind(hipfft_success)) function hipfftexecd2z_rank_2 (plan, idata, odata)
 
integer(kind(hipfft_success)) function hipfftexecd2z_rank_3 (plan, idata, odata)
 
integer(kind(hipfft_success)) function hipfftexecz2d_rank_0 (plan, idata, odata)
 
integer(kind(hipfft_success)) function hipfftexecz2d_rank_1 (plan, idata, odata)
 
integer(kind(hipfft_success)) function hipfftexecz2d_rank_2 (plan, idata, odata)
 
integer(kind(hipfft_success)) function hipfftexecz2d_rank_3 (plan, idata, odata)
 

Function/Subroutine Documentation

◆ hipfftestimatemany_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftestimatemany_rank_0 ( 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)  worksize 
)

◆ hipfftestimatemany_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftestimatemany_rank_1 ( 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)  worksize 
)

◆ hipfftexecc2c_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecc2c_rank_0 ( type(c_ptr)  plan,
complex(c_float_complex), target  idata,
complex(c_float_complex), target  odata,
integer(c_int)  direction 
)

◆ hipfftexecc2c_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecc2c_rank_1 ( type(c_ptr)  plan,
complex(c_float_complex), dimension(:), target  idata,
complex(c_float_complex), dimension(:), target  odata,
integer(c_int)  direction 
)

◆ hipfftexecc2c_rank_2()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecc2c_rank_2 ( type(c_ptr)  plan,
complex(c_float_complex), dimension(:,:), target  idata,
complex(c_float_complex), dimension(:,:), target  odata,
integer(c_int)  direction 
)

◆ hipfftexecc2c_rank_3()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecc2c_rank_3 ( type(c_ptr)  plan,
complex(c_float_complex), dimension(:,:,:), target  idata,
complex(c_float_complex), dimension(:,:,:), target  odata,
integer(c_int)  direction 
)

◆ hipfftexecc2r_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecc2r_rank_0 ( type(c_ptr)  plan,
complex(c_float_complex), target  idata,
real(c_float), target  odata 
)

◆ hipfftexecc2r_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecc2r_rank_1 ( type(c_ptr)  plan,
complex(c_float_complex), dimension(:), target  idata,
real(c_float), dimension(:), target  odata 
)

◆ hipfftexecc2r_rank_2()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecc2r_rank_2 ( type(c_ptr)  plan,
complex(c_float_complex), dimension(:,:), target  idata,
real(c_float), dimension(:,:), target  odata 
)

◆ hipfftexecc2r_rank_3()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecc2r_rank_3 ( type(c_ptr)  plan,
complex(c_float_complex), dimension(:,:,:), target  idata,
real(c_float), dimension(:,:,:), target  odata 
)

◆ hipfftexecd2z_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecd2z_rank_0 ( type(c_ptr)  plan,
real(c_double), target  idata,
complex(c_double_complex), target  odata 
)

◆ hipfftexecd2z_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecd2z_rank_1 ( type(c_ptr)  plan,
real(c_double), dimension(:), target  idata,
complex(c_double_complex), dimension(:), target  odata 
)

◆ hipfftexecd2z_rank_2()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecd2z_rank_2 ( type(c_ptr)  plan,
real(c_double), dimension(:,:), target  idata,
complex(c_double_complex), dimension(:,:), target  odata 
)

◆ hipfftexecd2z_rank_3()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecd2z_rank_3 ( type(c_ptr)  plan,
real(c_double), dimension(:,:,:), target  idata,
complex(c_double_complex), dimension(:,:,:), target  odata 
)

◆ hipfftexecr2c_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecr2c_rank_0 ( type(c_ptr)  plan,
real(c_float), target  idata,
complex(c_float_complex), target  odata 
)

◆ hipfftexecr2c_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecr2c_rank_1 ( type(c_ptr)  plan,
real(c_float), dimension(:), target  idata,
complex(c_float_complex), dimension(:), target  odata 
)

◆ hipfftexecr2c_rank_2()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecr2c_rank_2 ( type(c_ptr)  plan,
real(c_float), dimension(:,:), target  idata,
complex(c_float_complex), dimension(:,:), target  odata 
)

◆ hipfftexecr2c_rank_3()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecr2c_rank_3 ( type(c_ptr)  plan,
real(c_float), dimension(:,:,:), target  idata,
complex(c_float_complex), dimension(:,:,:), target  odata 
)

◆ hipfftexecz2d_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecz2d_rank_0 ( type(c_ptr)  plan,
complex(c_double_complex), target  idata,
real(c_double), target  odata 
)

◆ hipfftexecz2d_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecz2d_rank_1 ( type(c_ptr)  plan,
complex(c_double_complex), dimension(:), target  idata,
real(c_double), dimension(:), target  odata 
)

◆ hipfftexecz2d_rank_2()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecz2d_rank_2 ( type(c_ptr)  plan,
complex(c_double_complex), dimension(:,:), target  idata,
real(c_double), dimension(:,:), target  odata 
)

◆ hipfftexecz2d_rank_3()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecz2d_rank_3 ( type(c_ptr)  plan,
complex(c_double_complex), dimension(:,:,:), target  idata,
real(c_double), dimension(:,:,:), target  odata 
)

◆ hipfftexecz2z_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecz2z_rank_0 ( type(c_ptr)  plan,
complex(c_double_complex), target  idata,
complex(c_double_complex), target  odata,
integer(c_int)  direction 
)

◆ hipfftexecz2z_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecz2z_rank_1 ( type(c_ptr)  plan,
complex(c_double_complex), dimension(:), target  idata,
complex(c_double_complex), dimension(:), target  odata,
integer(c_int)  direction 
)

◆ hipfftexecz2z_rank_2()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecz2z_rank_2 ( type(c_ptr)  plan,
complex(c_double_complex), dimension(:,:), target  idata,
complex(c_double_complex), dimension(:,:), target  odata,
integer(c_int)  direction 
)

◆ hipfftexecz2z_rank_3()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftexecz2z_rank_3 ( type(c_ptr)  plan,
complex(c_double_complex), dimension(:,:,:), target  idata,
complex(c_double_complex), dimension(:,:,:), target  odata,
integer(c_int)  direction 
)

◆ hipfftgetsizemany64_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftgetsizemany64_rank_0 ( type(c_ptr)  plan,
integer(c_int)  rank,
integer(c_int64_t), target  n,
integer(c_int64_t), target  inembed,
integer(c_int64_t)  istride,
integer(c_int64_t)  idist,
integer(c_int64_t), target  onembed,
integer(c_int64_t)  ostride,
integer(c_int64_t)  odist,
integer(kind(hipfft_r2c))  mytype,
integer(c_int64_t)  batch,
integer(c_size_t)  worksize 
)

◆ hipfftgetsizemany64_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftgetsizemany64_rank_1 ( type(c_ptr)  plan,
integer(c_int)  rank,
integer(c_int64_t), dimension(:), target  n,
integer(c_int64_t), dimension(:), target  inembed,
integer(c_int64_t)  istride,
integer(c_int64_t)  idist,
integer(c_int64_t), dimension(:), target  onembed,
integer(c_int64_t)  ostride,
integer(c_int64_t)  odist,
integer(kind(hipfft_r2c))  mytype,
integer(c_int64_t)  batch,
integer(c_size_t)  worksize 
)

◆ hipfftgetsizemany_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftgetsizemany_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)  worksize 
)

◆ hipfftgetsizemany_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftgetsizemany_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)  worksize 
)

◆ hipfftmakeplanmany64_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftmakeplanmany64_rank_0 ( type(c_ptr)  plan,
integer(c_int)  rank,
integer(c_int64_t), target  n,
integer(c_int64_t), target  inembed,
integer(c_int64_t)  istride,
integer(c_int64_t)  idist,
integer(c_int64_t), target  onembed,
integer(c_int64_t)  ostride,
integer(c_int64_t)  odist,
integer(kind(hipfft_r2c))  mytype,
integer(c_int64_t)  batch,
integer(c_size_t)  worksize 
)

◆ hipfftmakeplanmany64_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftmakeplanmany64_rank_1 ( type(c_ptr)  plan,
integer(c_int)  rank,
integer(c_int64_t), dimension(:), target  n,
integer(c_int64_t), dimension(:), target  inembed,
integer(c_int64_t)  istride,
integer(c_int64_t)  idist,
integer(c_int64_t), dimension(:), target  onembed,
integer(c_int64_t)  ostride,
integer(c_int64_t)  odist,
integer(kind(hipfft_r2c))  mytype,
integer(c_int64_t)  batch,
integer(c_size_t)  worksize 
)

◆ hipfftmakeplanmany_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::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)  worksize 
)

◆ hipfftmakeplanmany_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::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)  worksize 
)

◆ hipfftplanmany_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::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_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 
)