andrew@0: /* andrew@0: * Copyright (c) 2003, 2007-8 Matteo Frigo andrew@0: * Copyright (c) 2003, 2007-8 Massachusetts Institute of Technology andrew@0: * andrew@0: * The following statement of license applies *only* to this header file, andrew@0: * and *not* to the other files distributed with FFTW or derived therefrom: andrew@0: * andrew@0: * Redistribution and use in source and binary forms, with or without andrew@0: * modification, are permitted provided that the following conditions andrew@0: * are met: andrew@0: * andrew@0: * 1. Redistributions of source code must retain the above copyright andrew@0: * notice, this list of conditions and the following disclaimer. andrew@0: * andrew@0: * 2. Redistributions in binary form must reproduce the above copyright andrew@0: * notice, this list of conditions and the following disclaimer in the andrew@0: * documentation and/or other materials provided with the distribution. andrew@0: * andrew@0: * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS andrew@0: * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED andrew@0: * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE andrew@0: * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY andrew@0: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL andrew@0: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE andrew@0: * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS andrew@0: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, andrew@0: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING andrew@0: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS andrew@0: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. andrew@0: */ andrew@0: andrew@0: /***************************** NOTE TO USERS ********************************* andrew@0: * andrew@0: * THIS IS A HEADER FILE, NOT A MANUAL andrew@0: * andrew@0: * If you want to know how to use FFTW, please read the manual, andrew@0: * online at http://www.fftw.org/doc/ and also included with FFTW. andrew@0: * For a quick start, see the manual's tutorial section. andrew@0: * andrew@0: * (Reading header files to learn how to use a library is a habit andrew@0: * stemming from code lacking a proper manual. Arguably, it's a andrew@0: * *bad* habit in most cases, because header files can contain andrew@0: * interfaces that are not part of the public, stable API.) andrew@0: * andrew@0: ****************************************************************************/ andrew@0: andrew@0: #ifndef FFTW3_H andrew@0: #define FFTW3_H andrew@0: andrew@0: #include andrew@0: andrew@0: #ifdef __cplusplus andrew@0: extern "C" andrew@0: { andrew@0: #endif /* __cplusplus */ andrew@0: andrew@0: /* If is included, use the C99 complex type. Otherwise andrew@0: define a type bit-compatible with C99 complex */ andrew@0: #if !defined(FFTW_NO_Complex) && defined(_Complex_I) && defined(complex) && defined(I) andrew@0: # define FFTW_DEFINE_COMPLEX(R, C) typedef R _Complex C andrew@0: #else andrew@0: # define FFTW_DEFINE_COMPLEX(R, C) typedef R C[2] andrew@0: #endif andrew@0: andrew@0: #define FFTW_CONCAT(prefix, name) prefix ## name andrew@0: #define FFTW_MANGLE_DOUBLE(name) FFTW_CONCAT(fftw_, name) andrew@0: #define FFTW_MANGLE_FLOAT(name) FFTW_CONCAT(fftwf_, name) andrew@0: #define FFTW_MANGLE_LONG_DOUBLE(name) FFTW_CONCAT(fftwl_, name) andrew@0: andrew@0: /* IMPORTANT: for Windows compilers, you should add a line andrew@0: #define FFTW_DLL andrew@0: here and in kernel/ifftw.h if you are compiling/using FFTW as a andrew@0: DLL, in order to do the proper importing/exporting, or andrew@0: alternatively compile with -DFFTW_DLL or the equivalent andrew@0: command-line flag. This is not necessary under MinGW/Cygwin, where andrew@0: libtool does the imports/exports automatically. */ andrew@0: #if defined(FFTW_DLL) && (defined(_WIN32) || defined(__WIN32__)) andrew@0: /* annoying Windows syntax for shared-library declarations */ andrew@0: # if defined(COMPILING_FFTW) /* defined in api.h when compiling FFTW */ andrew@0: # define FFTW_EXTERN extern __declspec(dllexport) andrew@0: # else /* user is calling FFTW; import symbol */ andrew@0: # define FFTW_EXTERN extern __declspec(dllimport) andrew@0: # endif andrew@0: #else andrew@0: # define FFTW_EXTERN extern andrew@0: #endif andrew@0: andrew@0: enum fftw_r2r_kind_do_not_use_me { andrew@0: FFTW_R2HC=0, FFTW_HC2R=1, FFTW_DHT=2, andrew@0: FFTW_REDFT00=3, FFTW_REDFT01=4, FFTW_REDFT10=5, FFTW_REDFT11=6, andrew@0: FFTW_RODFT00=7, FFTW_RODFT01=8, FFTW_RODFT10=9, FFTW_RODFT11=10 andrew@0: }; andrew@0: andrew@0: struct fftw_iodim_do_not_use_me { andrew@0: int n; /* dimension size */ andrew@0: int is; /* input stride */ andrew@0: int os; /* output stride */ andrew@0: }; andrew@0: andrew@0: #include /* for ptrdiff_t */ andrew@0: struct fftw_iodim64_do_not_use_me { andrew@0: ptrdiff_t n; /* dimension size */ andrew@0: ptrdiff_t is; /* input stride */ andrew@0: ptrdiff_t os; /* output stride */ andrew@0: }; andrew@0: andrew@0: /* andrew@0: huge second-order macro that defines prototypes for all API andrew@0: functions. We expand this macro for each supported precision andrew@0: andrew@0: X: name-mangling macro andrew@0: R: real data type andrew@0: C: complex data type andrew@0: */ andrew@0: andrew@0: #define FFTW_DEFINE_API(X, R, C) \ andrew@0: \ andrew@0: FFTW_DEFINE_COMPLEX(R, C); \ andrew@0: \ andrew@0: typedef struct X(plan_s) *X(plan); \ andrew@0: \ andrew@0: typedef struct fftw_iodim_do_not_use_me X(iodim); \ andrew@0: typedef struct fftw_iodim64_do_not_use_me X(iodim64); \ andrew@0: \ andrew@0: typedef enum fftw_r2r_kind_do_not_use_me X(r2r_kind); \ andrew@0: \ andrew@0: FFTW_EXTERN void X(execute)(const X(plan) p); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_dft)(int rank, const int *n, \ andrew@0: C *in, C *out, int sign, unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_dft_1d)(int n, C *in, C *out, int sign, \ andrew@0: unsigned flags); \ andrew@0: FFTW_EXTERN X(plan) X(plan_dft_2d)(int n0, int n1, \ andrew@0: C *in, C *out, int sign, unsigned flags); \ andrew@0: FFTW_EXTERN X(plan) X(plan_dft_3d)(int n0, int n1, int n2, \ andrew@0: C *in, C *out, int sign, unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_many_dft)(int rank, const int *n, \ andrew@0: int howmany, \ andrew@0: C *in, const int *inembed, \ andrew@0: int istride, int idist, \ andrew@0: C *out, const int *onembed, \ andrew@0: int ostride, int odist, \ andrew@0: int sign, unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_guru_dft)(int rank, const X(iodim) *dims, \ andrew@0: int howmany_rank, \ andrew@0: const X(iodim) *howmany_dims, \ andrew@0: C *in, C *out, \ andrew@0: int sign, unsigned flags); \ andrew@0: FFTW_EXTERN X(plan) X(plan_guru_split_dft)(int rank, const X(iodim) *dims, \ andrew@0: int howmany_rank, \ andrew@0: const X(iodim) *howmany_dims, \ andrew@0: R *ri, R *ii, R *ro, R *io, \ andrew@0: unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_guru64_dft)(int rank, \ andrew@0: const X(iodim64) *dims, \ andrew@0: int howmany_rank, \ andrew@0: const X(iodim64) *howmany_dims, \ andrew@0: C *in, C *out, \ andrew@0: int sign, unsigned flags); \ andrew@0: FFTW_EXTERN X(plan) X(plan_guru64_split_dft)(int rank, \ andrew@0: const X(iodim64) *dims, \ andrew@0: int howmany_rank, \ andrew@0: const X(iodim64) *howmany_dims, \ andrew@0: R *ri, R *ii, R *ro, R *io, \ andrew@0: unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN void X(execute_dft)(const X(plan) p, C *in, C *out); \ andrew@0: FFTW_EXTERN void X(execute_split_dft)(const X(plan) p, R *ri, R *ii, \ andrew@0: R *ro, R *io); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_many_dft_r2c)(int rank, const int *n, \ andrew@0: int howmany, \ andrew@0: R *in, const int *inembed, \ andrew@0: int istride, int idist, \ andrew@0: C *out, const int *onembed, \ andrew@0: int ostride, int odist, \ andrew@0: unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_dft_r2c)(int rank, const int *n, \ andrew@0: R *in, C *out, unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_dft_r2c_1d)(int n,R *in,C *out,unsigned flags); \ andrew@0: FFTW_EXTERN X(plan) X(plan_dft_r2c_2d)(int n0, int n1, \ andrew@0: R *in, C *out, unsigned flags); \ andrew@0: FFTW_EXTERN X(plan) X(plan_dft_r2c_3d)(int n0, int n1, \ andrew@0: int n2, \ andrew@0: R *in, C *out, unsigned flags); \ andrew@0: \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_many_dft_c2r)(int rank, const int *n, \ andrew@0: int howmany, \ andrew@0: C *in, const int *inembed, \ andrew@0: int istride, int idist, \ andrew@0: R *out, const int *onembed, \ andrew@0: int ostride, int odist, \ andrew@0: unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_dft_c2r)(int rank, const int *n, \ andrew@0: C *in, R *out, unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_dft_c2r_1d)(int n,C *in,R *out,unsigned flags); \ andrew@0: FFTW_EXTERN X(plan) X(plan_dft_c2r_2d)(int n0, int n1, \ andrew@0: C *in, R *out, unsigned flags); \ andrew@0: FFTW_EXTERN X(plan) X(plan_dft_c2r_3d)(int n0, int n1, \ andrew@0: int n2, \ andrew@0: C *in, R *out, unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_guru_dft_r2c)(int rank, const X(iodim) *dims, \ andrew@0: int howmany_rank, \ andrew@0: const X(iodim) *howmany_dims, \ andrew@0: R *in, C *out, \ andrew@0: unsigned flags); \ andrew@0: FFTW_EXTERN X(plan) X(plan_guru_dft_c2r)(int rank, const X(iodim) *dims, \ andrew@0: int howmany_rank, \ andrew@0: const X(iodim) *howmany_dims, \ andrew@0: C *in, R *out, \ andrew@0: unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_guru_split_dft_r2c)( \ andrew@0: int rank, const X(iodim) *dims, \ andrew@0: int howmany_rank, \ andrew@0: const X(iodim) *howmany_dims, \ andrew@0: R *in, R *ro, R *io, \ andrew@0: unsigned flags); \ andrew@0: FFTW_EXTERN X(plan) X(plan_guru_split_dft_c2r)( \ andrew@0: int rank, const X(iodim) *dims, \ andrew@0: int howmany_rank, \ andrew@0: const X(iodim) *howmany_dims, \ andrew@0: R *ri, R *ii, R *out, \ andrew@0: unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_guru64_dft_r2c)(int rank, \ andrew@0: const X(iodim64) *dims, \ andrew@0: int howmany_rank, \ andrew@0: const X(iodim64) *howmany_dims, \ andrew@0: R *in, C *out, \ andrew@0: unsigned flags); \ andrew@0: FFTW_EXTERN X(plan) X(plan_guru64_dft_c2r)(int rank, \ andrew@0: const X(iodim64) *dims, \ andrew@0: int howmany_rank, \ andrew@0: const X(iodim64) *howmany_dims, \ andrew@0: C *in, R *out, \ andrew@0: unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_guru64_split_dft_r2c)( \ andrew@0: int rank, const X(iodim64) *dims, \ andrew@0: int howmany_rank, \ andrew@0: const X(iodim64) *howmany_dims, \ andrew@0: R *in, R *ro, R *io, \ andrew@0: unsigned flags); \ andrew@0: FFTW_EXTERN X(plan) X(plan_guru64_split_dft_c2r)( \ andrew@0: int rank, const X(iodim64) *dims, \ andrew@0: int howmany_rank, \ andrew@0: const X(iodim64) *howmany_dims, \ andrew@0: R *ri, R *ii, R *out, \ andrew@0: unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN void X(execute_dft_r2c)(const X(plan) p, R *in, C *out); \ andrew@0: FFTW_EXTERN void X(execute_dft_c2r)(const X(plan) p, C *in, R *out); \ andrew@0: \ andrew@0: FFTW_EXTERN void X(execute_split_dft_r2c)(const X(plan) p, \ andrew@0: R *in, R *ro, R *io); \ andrew@0: FFTW_EXTERN void X(execute_split_dft_c2r)(const X(plan) p, \ andrew@0: R *ri, R *ii, R *out); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_many_r2r)(int rank, const int *n, \ andrew@0: int howmany, \ andrew@0: R *in, const int *inembed, \ andrew@0: int istride, int idist, \ andrew@0: R *out, const int *onembed, \ andrew@0: int ostride, int odist, \ andrew@0: const X(r2r_kind) *kind, unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_r2r)(int rank, const int *n, R *in, R *out, \ andrew@0: const X(r2r_kind) *kind, unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_r2r_1d)(int n, R *in, R *out, \ andrew@0: X(r2r_kind) kind, unsigned flags); \ andrew@0: FFTW_EXTERN X(plan) X(plan_r2r_2d)(int n0, int n1, R *in, R *out, \ andrew@0: X(r2r_kind) kind0, X(r2r_kind) kind1, \ andrew@0: unsigned flags); \ andrew@0: FFTW_EXTERN X(plan) X(plan_r2r_3d)(int n0, int n1, int n2, \ andrew@0: R *in, R *out, X(r2r_kind) kind0, \ andrew@0: X(r2r_kind) kind1, X(r2r_kind) kind2, \ andrew@0: unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_guru_r2r)(int rank, const X(iodim) *dims, \ andrew@0: int howmany_rank, \ andrew@0: const X(iodim) *howmany_dims, \ andrew@0: R *in, R *out, \ andrew@0: const X(r2r_kind) *kind, unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN X(plan) X(plan_guru64_r2r)(int rank, const X(iodim64) *dims, \ andrew@0: int howmany_rank, \ andrew@0: const X(iodim64) *howmany_dims, \ andrew@0: R *in, R *out, \ andrew@0: const X(r2r_kind) *kind, unsigned flags); \ andrew@0: \ andrew@0: FFTW_EXTERN void X(execute_r2r)(const X(plan) p, R *in, R *out); \ andrew@0: \ andrew@0: FFTW_EXTERN void X(destroy_plan)(X(plan) p); \ andrew@0: FFTW_EXTERN void X(forget_wisdom)(void); \ andrew@0: FFTW_EXTERN void X(cleanup)(void); \ andrew@0: \ andrew@0: FFTW_EXTERN void X(set_timelimit)(double); \ andrew@0: \ andrew@0: FFTW_EXTERN void X(plan_with_nthreads)(int nthreads); \ andrew@0: FFTW_EXTERN int X(init_threads)(void); \ andrew@0: FFTW_EXTERN void X(cleanup_threads)(void); \ andrew@0: \ andrew@0: FFTW_EXTERN void X(export_wisdom_to_file)(FILE *output_file); \ andrew@0: FFTW_EXTERN char *X(export_wisdom_to_string)(void); \ andrew@0: FFTW_EXTERN void X(export_wisdom)(void (*write_char)(char c, void *), \ andrew@0: void *data); \ andrew@0: FFTW_EXTERN int X(import_system_wisdom)(void); \ andrew@0: FFTW_EXTERN int X(import_wisdom_from_file)(FILE *input_file); \ andrew@0: FFTW_EXTERN int X(import_wisdom_from_string)(const char *input_string); \ andrew@0: FFTW_EXTERN int X(import_wisdom)(int (*read_char)(void *), void *data); \ andrew@0: \ andrew@0: FFTW_EXTERN void X(fprint_plan)(const X(plan) p, FILE *output_file); \ andrew@0: FFTW_EXTERN void X(print_plan)(const X(plan) p); \ andrew@0: \ andrew@0: FFTW_EXTERN void *X(malloc)(size_t n); \ andrew@0: FFTW_EXTERN void X(free)(void *p); \ andrew@0: \ andrew@0: FFTW_EXTERN void X(flops)(const X(plan) p, \ andrew@0: double *add, double *mul, double *fmas); \ andrew@0: FFTW_EXTERN double X(estimate_cost)(const X(plan) p); \ andrew@0: \ andrew@0: FFTW_EXTERN const char X(version)[]; \ andrew@0: FFTW_EXTERN const char X(cc)[]; \ andrew@0: FFTW_EXTERN const char X(codelet_optim)[]; andrew@0: andrew@0: andrew@0: /* end of FFTW_DEFINE_API macro */ andrew@0: andrew@0: FFTW_DEFINE_API(FFTW_MANGLE_DOUBLE, double, fftw_complex) andrew@0: FFTW_DEFINE_API(FFTW_MANGLE_FLOAT, float, fftwf_complex) andrew@0: FFTW_DEFINE_API(FFTW_MANGLE_LONG_DOUBLE, long double, fftwl_complex) andrew@0: andrew@0: #define FFTW_FORWARD (-1) andrew@0: #define FFTW_BACKWARD (+1) andrew@0: andrew@0: #define FFTW_NO_TIMELIMIT (-1.0) andrew@0: andrew@0: /* documented flags */ andrew@0: #define FFTW_MEASURE (0U) andrew@0: #define FFTW_DESTROY_INPUT (1U << 0) andrew@0: #define FFTW_UNALIGNED (1U << 1) andrew@0: #define FFTW_CONSERVE_MEMORY (1U << 2) andrew@0: #define FFTW_EXHAUSTIVE (1U << 3) /* NO_EXHAUSTIVE is default */ andrew@0: #define FFTW_PRESERVE_INPUT (1U << 4) /* cancels FFTW_DESTROY_INPUT */ andrew@0: #define FFTW_PATIENT (1U << 5) /* IMPATIENT is default */ andrew@0: #define FFTW_ESTIMATE (1U << 6) andrew@0: andrew@0: /* undocumented beyond-guru flags */ andrew@0: #define FFTW_ESTIMATE_PATIENT (1U << 7) andrew@0: #define FFTW_BELIEVE_PCOST (1U << 8) andrew@0: #define FFTW_NO_DFT_R2HC (1U << 9) andrew@0: #define FFTW_NO_NONTHREADED (1U << 10) andrew@0: #define FFTW_NO_BUFFERING (1U << 11) andrew@0: #define FFTW_NO_INDIRECT_OP (1U << 12) andrew@0: #define FFTW_ALLOW_LARGE_GENERIC (1U << 13) /* NO_LARGE_GENERIC is default */ andrew@0: #define FFTW_NO_RANK_SPLITS (1U << 14) andrew@0: #define FFTW_NO_VRANK_SPLITS (1U << 15) andrew@0: #define FFTW_NO_VRECURSE (1U << 16) andrew@0: #define FFTW_NO_SIMD (1U << 17) andrew@0: #define FFTW_NO_SLOW (1U << 18) andrew@0: #define FFTW_NO_FIXED_RADIX_LARGE_N (1U << 19) andrew@0: #define FFTW_ALLOW_PRUNING (1U << 20) andrew@0: #define FFTW_WISDOM_ONLY (1U << 21) andrew@0: andrew@0: #ifdef __cplusplus andrew@0: } /* extern "C" */ andrew@0: #endif /* __cplusplus */ andrew@0: andrew@0: #endif /* FFTW3_H */