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