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