cufftPlanMany Interface

interface

Creates a FFT plan configuration of dimension rank, with sizes specified in the array n.


Called by

interface~~cufftplanmany~~CalledByGraph interface~cufftplanmany cufftPlanMany proc~create cufft_executor%create proc~create->interface~cufftplanmany

public function cufftPlanMany(plan, rank, n, inembed, istride, idist, onembed, ostride, odist, ffttype, batch) result(cufftResult) bind(C, name="cufftPlanMany")

Arguments

Type IntentOptional Attributes Name
type(c_ptr) :: plan

Pointer to an uninitialized cufftHandle object.

integer(kind=c_int), value :: rank

Dimensionality of the transform (1, 2, or 3).

integer(kind=c_int) :: n(*)

Array of size rank, describing the size of each dimension, n[0] being the size of the outermost and n[rank-1] innermost (contiguous) dimension of a transform.

integer(kind=c_int) :: inembed(*)

Pointer of size rank that indicates the storage dimensions of the input data in memory. If set to NULL, all other advanced data layout parameters are ignored.

integer(kind=c_int), value :: istride

Indicates the distance between two successive input elements in the least significant (i.e., innermost) dimension.

integer(kind=c_int), value :: idist

Indicates the distance between the first element of two consecutive signals in a batch of the input data.

integer(kind=c_int) :: onembed(*)

Pointer of size rank that indicates the storage dimensions of the output data in memory. If set to NULL, all other advanced data layout parameters are ignored.

integer(kind=c_int), value :: ostride

Indicates the distance between two successive output elements in the output array in the least significant (i.e., innermost) dimension.

integer(kind=c_int), value :: odist

Indicates the distance between the first element of two consecutive signals in a batch of the output data.

integer(kind=c_int), value :: ffttype

The transform data type (e.g., CUFFT_R2C for single precision real to complex).

integer(kind=c_int), value :: batch

Batch size for this transform.

Return Value integer(kind=c_int)

The enumerated type cufftResult defines API call result codes.