hipfftxtgetsizemany Interface Reference

hipfftxtgetsizemany Interface Reference#

hipFORT API Reference: hipfort_hipfftxt::hipfftxtgetsizemany Interface Reference
hipfort_hipfftxt::hipfftxtgetsizemany Interface Reference

Return size of the work area size required for a rank-dimensional plan, with specified input, output, execution data types. More...

Public Member Functions

integer(c_int) function hipfftxtgetsizemany_ (plan, rank, n, inembed, istride, idist, inputtype, onembed, ostride, odist, outputtype, batch, worksize, executiontype)
 
integer(kind(hipfft_success)) function hipfftxtgetsizemany_typed (plan, rank, n, inembed, istride, idist, inputtype, onembed, ostride, odist, outputtype, batch, worksize, executiontype)
 
integer(kind(hipfft_success)) function hipfftxtgetsizemany_rank_0 (plan, rank, n, inembed, istride, idist, inputtype, onembed, ostride, odist, outputtype, batch, worksize, executiontype)
 
integer(kind(hipfft_success)) function hipfftxtgetsizemany_rank_1 (plan, rank, n, inembed, istride, idist, inputtype, onembed, ostride, odist, outputtype, batch, worksize, executiontype)
 

Detailed Description

Return size of the work area size required for a rank-dimensional plan, with specified input, output, execution data types.

See hipfftXtMakePlanMany for restrictions on inputType, outputType, executionType parameters.

Parameters
[in]plan- Pointer to the FFT plan.
[in]rank- Dimension of FFT transform (1, 2, or 3).
[in]n- Number of elements in the x/y/z directions.
[in]inembed- Number of elements in the input data in the x/y/z directions.
[in]istride- Distance between two successive elements in the input data.
[in]idist- Distance between input batches.
[in]inputType- Format of FFT input.
[in]onembed- Number of elements in the output data in the x/y/z directions.
[in]ostride- Distance between two successive elements in the output data.
[in]odist- Distance between output batches.
[in]outputType- Format of FFT output.
[in]batch- Number of batched transforms to perform.
[out]workSize- Pointer to work area size (returned value).
[in]executionType- Internal data format used by the library during computation.

Member Function/Subroutine Documentation

◆ hipfftxtgetsizemany_()

integer(c_int) function hipfort_hipfftxt::hipfftxtgetsizemany::hipfftxtgetsizemany_ ( type(c_ptr), value  plan,
integer(c_int), value  rank,
type(c_ptr), value  n,
type(c_ptr), value  inembed,
integer(c_int64_t), value  istride,
integer(c_int64_t), value  idist,
integer(c_int), value  inputtype,
type(c_ptr), value  onembed,
integer(c_int64_t), value  ostride,
integer(c_int64_t), value  odist,
integer(c_int), value  outputtype,
integer(c_int64_t), value  batch,
type(c_ptr), value  worksize,
integer(c_int), value  executiontype 
)

◆ hipfftxtgetsizemany_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfftxt::hipfftxtgetsizemany::hipfftxtgetsizemany_rank_0 ( type(c_ptr), value  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_int)  inputtype,
integer(c_int64_t), target  onembed,
integer(c_int64_t)  ostride,
integer(c_int64_t)  odist,
integer(c_int)  outputtype,
integer(c_int64_t)  batch,
integer(c_size_t), target  worksize,
integer(c_int)  executiontype 
)

◆ hipfftxtgetsizemany_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfftxt::hipfftxtgetsizemany::hipfftxtgetsizemany_rank_1 ( type(c_ptr), value  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_int)  inputtype,
integer(c_int64_t), dimension(:), target  onembed,
integer(c_int64_t)  ostride,
integer(c_int64_t)  odist,
integer(c_int)  outputtype,
integer(c_int64_t)  batch,
integer(c_size_t), target  worksize,
integer(c_int)  executiontype 
)

◆ hipfftxtgetsizemany_typed()

integer(kind(hipfft_success)) function hipfort_hipfftxt::hipfftxtgetsizemany::hipfftxtgetsizemany_typed ( type(c_ptr), value  plan,
integer(c_int)  rank,
type(c_ptr)  n,
type(c_ptr)  inembed,
integer(c_int64_t)  istride,
integer(c_int64_t)  idist,
integer(c_int)  inputtype,
type(c_ptr)  onembed,
integer(c_int64_t)  ostride,
integer(c_int64_t)  odist,
integer(c_int)  outputtype,
integer(c_int64_t)  batch,
integer(c_size_t), target  worksize,
integer(c_int)  executiontype 
)

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