FFTW 3.3.5: Guru Real-data DFTs

Chris@42:

fftw_plan fftw_plan_guru_dft_r2c(
Chris@42:      int rank, const fftw_iodim *dims,
Chris@42:      int howmany_rank, const fftw_iodim *howmany_dims,
Chris@42:      double *in, fftw_complex *out,
Chris@42:      unsigned flags);
Chris@42: 
Chris@42: fftw_plan fftw_plan_guru_split_dft_r2c(
Chris@42:      int rank, const fftw_iodim *dims,
Chris@42:      int howmany_rank, const fftw_iodim *howmany_dims,
Chris@42:      double *in, double *ro, double *io,
Chris@42:      unsigned flags);
Chris@42: 
Chris@42: fftw_plan fftw_plan_guru_dft_c2r(
Chris@42:      int rank, const fftw_iodim *dims,
Chris@42:      int howmany_rank, const fftw_iodim *howmany_dims,
Chris@42:      fftw_complex *in, double *out,
Chris@42:      unsigned flags);
Chris@42: 
Chris@42: fftw_plan fftw_plan_guru_split_dft_c2r(
Chris@42:      int rank, const fftw_iodim *dims,
Chris@42:      int howmany_rank, const fftw_iodim *howmany_dims,
Chris@42:      double *ri, double *ii, double *out,
Chris@42:      unsigned flags);
Chris@42:

Plan a real-input (r2c) or real-output (c2r), multi-dimensional DFT with Chris@42: transform dimensions given by (rank, dims) over a Chris@42: multi-dimensional vector (loop) of dimensions (howmany_rank, Chris@42: howmany_dims). dims and howmany_dims should point Chris@42: to fftw_iodim arrays of length rank and Chris@42: howmany_rank, respectively. As for the basic and advanced Chris@42: interfaces, an r2c transform is FFTW_FORWARD and a c2r transform Chris@42: is FFTW_BACKWARD. Chris@42:

The last dimension of dims is interpreted specially: Chris@42: that dimension of the real array has size dims[rank-1].n, but Chris@42: that dimension of the complex array has size dims[rank-1].n/2+1 Chris@42: (division rounded down). The strides, on the other hand, are taken to Chris@42: be exactly as specified. It is up to the user to specify the strides Chris@42: appropriately for the peculiar dimensions of the data, and we do not Chris@42: guarantee that the planner will succeed (return non-NULL) for Chris@42: any dimensions other than those described in Real-data DFT Array Format and generalized in Advanced Real-data DFTs. (That is, Chris@42: for an in-place transform, each individual dimension should be able to Chris@42: operate in place.) Chris@42: Chris@42:

in and out point to the input and output arrays for r2c Chris@42: and c2r transforms, respectively. For split arrays, ri and Chris@42: ii point to the real and imaginary input arrays for a c2r Chris@42: transform, and ro and io point to the real and imaginary Chris@42: output arrays for an r2c transform. in and ro or Chris@42: ri and out may be the same, indicating an in-place Chris@42: transform. (In-place transforms where in and io or Chris@42: ii and out are the same are not currently supported.) Chris@42:

flags is a bitwise OR (‘|’) of zero or more planner flags, Chris@42: as defined in Planner Flags. Chris@42:

In-place transforms of rank greater than 1 are currently only Chris@42: supported for interleaved arrays. For split arrays, the planner will Chris@42: return NULL. Chris@42: Chris@42:

4.5.4 Guru Real-data DFTs