Mercurial > hg > sv-dependency-builds

annotate osx/include/fftw3.h @ 111:585a7be09763

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
FFTW
author Chris Cannam <cannam@all-day-breakfast.com>
date Fri, 04 Jul 2014 10:36:59 +0100
parents
children 879bdc878826
rev   line source
cannam@111 1 /*
cannam@111 2 * Copyright (c) 2003, 2007-11 Matteo Frigo
cannam@111 3 * Copyright (c) 2003, 2007-11 Massachusetts Institute of Technology
cannam@111 4 *
cannam@111 5 * The following statement of license applies *only* to this header file,
cannam@111 6 * and *not* to the other files distributed with FFTW or derived therefrom:
cannam@111 7 *
cannam@111 8 * Redistribution and use in source and binary forms, with or without
cannam@111 9 * modification, are permitted provided that the following conditions
cannam@111 10 * are met:
cannam@111 11 *
cannam@111 12 * 1. Redistributions of source code must retain the above copyright
cannam@111 13 * notice, this list of conditions and the following disclaimer.
cannam@111 14 *
cannam@111 15 * 2. Redistributions in binary form must reproduce the above copyright
cannam@111 16 * notice, this list of conditions and the following disclaimer in the
cannam@111 17 * documentation and/or other materials provided with the distribution.
cannam@111 18 *
cannam@111 19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
cannam@111 20 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
cannam@111 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
cannam@111 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
cannam@111 23 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
cannam@111 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
cannam@111 25 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
cannam@111 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
cannam@111 27 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
cannam@111 28 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
cannam@111 29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
cannam@111 30 */
cannam@111 31
cannam@111 32 /***************************** NOTE TO USERS *********************************
cannam@111 33 *
cannam@111 34 * THIS IS A HEADER FILE, NOT A MANUAL
cannam@111 35 *
cannam@111 36 * If you want to know how to use FFTW, please read the manual,
cannam@111 37 * online at http://www.fftw.org/doc/ and also included with FFTW.
cannam@111 38 * For a quick start, see the manual's tutorial section.
cannam@111 39 *
cannam@111 40 * (Reading header files to learn how to use a library is a habit
cannam@111 41 * stemming from code lacking a proper manual. Arguably, it's a
cannam@111 42 * *bad* habit in most cases, because header files can contain
cannam@111 43 * interfaces that are not part of the public, stable API.)
cannam@111 44 *
cannam@111 45 ****************************************************************************/
cannam@111 46
cannam@111 47 #ifndef FFTW3_H
cannam@111 48 #define FFTW3_H
cannam@111 49
cannam@111 50 #include <stdio.h>
cannam@111 51
cannam@111 52 #ifdef __cplusplus
cannam@111 53 extern "C"
cannam@111 54 {
cannam@111 55 #endif /* __cplusplus */
cannam@111 56
cannam@111 57 /* If <complex.h> is included, use the C99 complex type. Otherwise
cannam@111 58 define a type bit-compatible with C99 complex */
cannam@111 59 #if !defined(FFTW_NO_Complex) && defined(_Complex_I) && defined(complex) && defined(I)
cannam@111 60 # define FFTW_DEFINE_COMPLEX(R, C) typedef R _Complex C
cannam@111 61 #else
cannam@111 62 # define FFTW_DEFINE_COMPLEX(R, C) typedef R C[2]
cannam@111 63 #endif
cannam@111 64
cannam@111 65 #define FFTW_CONCAT(prefix, name) prefix ## name
cannam@111 66 #define FFTW_MANGLE_DOUBLE(name) FFTW_CONCAT(fftw_, name)
cannam@111 67 #define FFTW_MANGLE_FLOAT(name) FFTW_CONCAT(fftwf_, name)
cannam@111 68 #define FFTW_MANGLE_LONG_DOUBLE(name) FFTW_CONCAT(fftwl_, name)
cannam@111 69 #define FFTW_MANGLE_QUAD(name) FFTW_CONCAT(fftwq_, name)
cannam@111 70
cannam@111 71 /* IMPORTANT: for Windows compilers, you should add a line
cannam@111 72 #define FFTW_DLL
cannam@111 73 here and in kernel/ifftw.h if you are compiling/using FFTW as a
cannam@111 74 DLL, in order to do the proper importing/exporting, or
cannam@111 75 alternatively compile with -DFFTW_DLL or the equivalent
cannam@111 76 command-line flag. This is not necessary under MinGW/Cygwin, where
cannam@111 77 libtool does the imports/exports automatically. */
cannam@111 78 #if defined(FFTW_DLL) && (defined(_WIN32) || defined(__WIN32__))
cannam@111 79 /* annoying Windows syntax for shared-library declarations */
cannam@111 80 # if defined(COMPILING_FFTW) /* defined in api.h when compiling FFTW */
cannam@111 81 # define FFTW_EXTERN extern __declspec(dllexport)
cannam@111 82 # else /* user is calling FFTW; import symbol */
cannam@111 83 # define FFTW_EXTERN extern __declspec(dllimport)
cannam@111 84 # endif
cannam@111 85 #else
cannam@111 86 # define FFTW_EXTERN extern
cannam@111 87 #endif
cannam@111 88
cannam@111 89 enum fftw_r2r_kind_do_not_use_me {
cannam@111 90 FFTW_R2HC=0, FFTW_HC2R=1, FFTW_DHT=2,
cannam@111 91 FFTW_REDFT00=3, FFTW_REDFT01=4, FFTW_REDFT10=5, FFTW_REDFT11=6,
cannam@111 92 FFTW_RODFT00=7, FFTW_RODFT01=8, FFTW_RODFT10=9, FFTW_RODFT11=10
cannam@111 93 };
cannam@111 94
cannam@111 95 struct fftw_iodim_do_not_use_me {
cannam@111 96 int n; /* dimension size */
cannam@111 97 int is; /* input stride */
cannam@111 98 int os; /* output stride */
cannam@111 99 };
cannam@111 100
cannam@111 101 #include <stddef.h> /* for ptrdiff_t */
cannam@111 102 struct fftw_iodim64_do_not_use_me {
cannam@111 103 ptrdiff_t n; /* dimension size */
cannam@111 104 ptrdiff_t is; /* input stride */
cannam@111 105 ptrdiff_t os; /* output stride */
cannam@111 106 };
cannam@111 107
cannam@111 108 typedef void (*fftw_write_char_func_do_not_use_me)(char c, void *);
cannam@111 109 typedef int (*fftw_read_char_func_do_not_use_me)(void *);
cannam@111 110
cannam@111 111 /*
cannam@111 112 huge second-order macro that defines prototypes for all API
cannam@111 113 functions. We expand this macro for each supported precision
cannam@111 114
cannam@111 115 X: name-mangling macro
cannam@111 116 R: real data type
cannam@111 117 C: complex data type
cannam@111 118 */
cannam@111 119
cannam@111 120 #define FFTW_DEFINE_API(X, R, C) \
cannam@111 121 \
cannam@111 122 FFTW_DEFINE_COMPLEX(R, C); \
cannam@111 123 \
cannam@111 124 typedef struct X(plan_s) *X(plan); \
cannam@111 125 \
cannam@111 126 typedef struct fftw_iodim_do_not_use_me X(iodim); \
cannam@111 127 typedef struct fftw_iodim64_do_not_use_me X(iodim64); \
cannam@111 128 \
cannam@111 129 typedef enum fftw_r2r_kind_do_not_use_me X(r2r_kind); \
cannam@111 130 \
cannam@111 131 typedef fftw_write_char_func_do_not_use_me X(write_char_func); \
cannam@111 132 typedef fftw_read_char_func_do_not_use_me X(read_char_func); \
cannam@111 133 \
cannam@111 134 FFTW_EXTERN void X(execute)(const X(plan) p); \
cannam@111 135 \
cannam@111 136 FFTW_EXTERN X(plan) X(plan_dft)(int rank, const int *n, \
cannam@111 137 C *in, C *out, int sign, unsigned flags); \
cannam@111 138 \
cannam@111 139 FFTW_EXTERN X(plan) X(plan_dft_1d)(int n, C *in, C *out, int sign, \
cannam@111 140 unsigned flags); \
cannam@111 141 FFTW_EXTERN X(plan) X(plan_dft_2d)(int n0, int n1, \
cannam@111 142 C *in, C *out, int sign, unsigned flags); \
cannam@111 143 FFTW_EXTERN X(plan) X(plan_dft_3d)(int n0, int n1, int n2, \
cannam@111 144 C *in, C *out, int sign, unsigned flags); \
cannam@111 145 \
cannam@111 146 FFTW_EXTERN X(plan) X(plan_many_dft)(int rank, const int *n, \
cannam@111 147 int howmany, \
cannam@111 148 C *in, const int *inembed, \
cannam@111 149 int istride, int idist, \
cannam@111 150 C *out, const int *onembed, \
cannam@111 151 int ostride, int odist, \
cannam@111 152 int sign, unsigned flags); \
cannam@111 153 \
cannam@111 154 FFTW_EXTERN X(plan) X(plan_guru_dft)(int rank, const X(iodim) *dims, \
cannam@111 155 int howmany_rank, \
cannam@111 156 const X(iodim) *howmany_dims, \
cannam@111 157 C *in, C *out, \
cannam@111 158 int sign, unsigned flags); \
cannam@111 159 FFTW_EXTERN X(plan) X(plan_guru_split_dft)(int rank, const X(iodim) *dims, \
cannam@111 160 int howmany_rank, \
cannam@111 161 const X(iodim) *howmany_dims, \
cannam@111 162 R *ri, R *ii, R *ro, R *io, \
cannam@111 163 unsigned flags); \
cannam@111 164 \
cannam@111 165 FFTW_EXTERN X(plan) X(plan_guru64_dft)(int rank, \
cannam@111 166 const X(iodim64) *dims, \
cannam@111 167 int howmany_rank, \
cannam@111 168 const X(iodim64) *howmany_dims, \
cannam@111 169 C *in, C *out, \
cannam@111 170 int sign, unsigned flags); \
cannam@111 171 FFTW_EXTERN X(plan) X(plan_guru64_split_dft)(int rank, \
cannam@111 172 const X(iodim64) *dims, \
cannam@111 173 int howmany_rank, \
cannam@111 174 const X(iodim64) *howmany_dims, \
cannam@111 175 R *ri, R *ii, R *ro, R *io, \
cannam@111 176 unsigned flags); \
cannam@111 177 \
cannam@111 178 FFTW_EXTERN void X(execute_dft)(const X(plan) p, C *in, C *out); \
cannam@111 179 FFTW_EXTERN void X(execute_split_dft)(const X(plan) p, R *ri, R *ii, \
cannam@111 180 R *ro, R *io); \
cannam@111 181 \
cannam@111 182 FFTW_EXTERN X(plan) X(plan_many_dft_r2c)(int rank, const int *n, \
cannam@111 183 int howmany, \
cannam@111 184 R *in, const int *inembed, \
cannam@111 185 int istride, int idist, \
cannam@111 186 C *out, const int *onembed, \
cannam@111 187 int ostride, int odist, \
cannam@111 188 unsigned flags); \
cannam@111 189 \
cannam@111 190 FFTW_EXTERN X(plan) X(plan_dft_r2c)(int rank, const int *n, \
cannam@111 191 R *in, C *out, unsigned flags); \
cannam@111 192 \
cannam@111 193 FFTW_EXTERN X(plan) X(plan_dft_r2c_1d)(int n,R *in,C *out,unsigned flags); \
cannam@111 194 FFTW_EXTERN X(plan) X(plan_dft_r2c_2d)(int n0, int n1, \
cannam@111 195 R *in, C *out, unsigned flags); \
cannam@111 196 FFTW_EXTERN X(plan) X(plan_dft_r2c_3d)(int n0, int n1, \
cannam@111 197 int n2, \
cannam@111 198 R *in, C *out, unsigned flags); \
cannam@111 199 \
cannam@111 200 \
cannam@111 201 FFTW_EXTERN X(plan) X(plan_many_dft_c2r)(int rank, const int *n, \
cannam@111 202 int howmany, \
cannam@111 203 C *in, const int *inembed, \
cannam@111 204 int istride, int idist, \
cannam@111 205 R *out, const int *onembed, \
cannam@111 206 int ostride, int odist, \
cannam@111 207 unsigned flags); \
cannam@111 208 \
cannam@111 209 FFTW_EXTERN X(plan) X(plan_dft_c2r)(int rank, const int *n, \
cannam@111 210 C *in, R *out, unsigned flags); \
cannam@111 211 \
cannam@111 212 FFTW_EXTERN X(plan) X(plan_dft_c2r_1d)(int n,C *in,R *out,unsigned flags); \
cannam@111 213 FFTW_EXTERN X(plan) X(plan_dft_c2r_2d)(int n0, int n1, \
cannam@111 214 C *in, R *out, unsigned flags); \
cannam@111 215 FFTW_EXTERN X(plan) X(plan_dft_c2r_3d)(int n0, int n1, \
cannam@111 216 int n2, \
cannam@111 217 C *in, R *out, unsigned flags); \
cannam@111 218 \
cannam@111 219 FFTW_EXTERN X(plan) X(plan_guru_dft_r2c)(int rank, const X(iodim) *dims, \
cannam@111 220 int howmany_rank, \
cannam@111 221 const X(iodim) *howmany_dims, \
cannam@111 222 R *in, C *out, \
cannam@111 223 unsigned flags); \
cannam@111 224 FFTW_EXTERN X(plan) X(plan_guru_dft_c2r)(int rank, const X(iodim) *dims, \
cannam@111 225 int howmany_rank, \
cannam@111 226 const X(iodim) *howmany_dims, \
cannam@111 227 C *in, R *out, \
cannam@111 228 unsigned flags); \
cannam@111 229 \
cannam@111 230 FFTW_EXTERN X(plan) X(plan_guru_split_dft_r2c)( \
cannam@111 231 int rank, const X(iodim) *dims, \
cannam@111 232 int howmany_rank, \
cannam@111 233 const X(iodim) *howmany_dims, \
cannam@111 234 R *in, R *ro, R *io, \
cannam@111 235 unsigned flags); \
cannam@111 236 FFTW_EXTERN X(plan) X(plan_guru_split_dft_c2r)( \
cannam@111 237 int rank, const X(iodim) *dims, \
cannam@111 238 int howmany_rank, \
cannam@111 239 const X(iodim) *howmany_dims, \
cannam@111 240 R *ri, R *ii, R *out, \
cannam@111 241 unsigned flags); \
cannam@111 242 \
cannam@111 243 FFTW_EXTERN X(plan) X(plan_guru64_dft_r2c)(int rank, \
cannam@111 244 const X(iodim64) *dims, \
cannam@111 245 int howmany_rank, \
cannam@111 246 const X(iodim64) *howmany_dims, \
cannam@111 247 R *in, C *out, \
cannam@111 248 unsigned flags); \
cannam@111 249 FFTW_EXTERN X(plan) X(plan_guru64_dft_c2r)(int rank, \
cannam@111 250 const X(iodim64) *dims, \
cannam@111 251 int howmany_rank, \
cannam@111 252 const X(iodim64) *howmany_dims, \
cannam@111 253 C *in, R *out, \
cannam@111 254 unsigned flags); \
cannam@111 255 \
cannam@111 256 FFTW_EXTERN X(plan) X(plan_guru64_split_dft_r2c)( \
cannam@111 257 int rank, const X(iodim64) *dims, \
cannam@111 258 int howmany_rank, \
cannam@111 259 const X(iodim64) *howmany_dims, \
cannam@111 260 R *in, R *ro, R *io, \
cannam@111 261 unsigned flags); \
cannam@111 262 FFTW_EXTERN X(plan) X(plan_guru64_split_dft_c2r)( \
cannam@111 263 int rank, const X(iodim64) *dims, \
cannam@111 264 int howmany_rank, \
cannam@111 265 const X(iodim64) *howmany_dims, \
cannam@111 266 R *ri, R *ii, R *out, \
cannam@111 267 unsigned flags); \
cannam@111 268 \
cannam@111 269 FFTW_EXTERN void X(execute_dft_r2c)(const X(plan) p, R *in, C *out); \
cannam@111 270 FFTW_EXTERN void X(execute_dft_c2r)(const X(plan) p, C *in, R *out); \
cannam@111 271 \
cannam@111 272 FFTW_EXTERN void X(execute_split_dft_r2c)(const X(plan) p, \
cannam@111 273 R *in, R *ro, R *io); \
cannam@111 274 FFTW_EXTERN void X(execute_split_dft_c2r)(const X(plan) p, \
cannam@111 275 R *ri, R *ii, R *out); \
cannam@111 276 \
cannam@111 277 FFTW_EXTERN X(plan) X(plan_many_r2r)(int rank, const int *n, \
cannam@111 278 int howmany, \
cannam@111 279 R *in, const int *inembed, \
cannam@111 280 int istride, int idist, \
cannam@111 281 R *out, const int *onembed, \
cannam@111 282 int ostride, int odist, \
cannam@111 283 const X(r2r_kind) *kind, unsigned flags); \
cannam@111 284 \
cannam@111 285 FFTW_EXTERN X(plan) X(plan_r2r)(int rank, const int *n, R *in, R *out, \
cannam@111 286 const X(r2r_kind) *kind, unsigned flags); \
cannam@111 287 \
cannam@111 288 FFTW_EXTERN X(plan) X(plan_r2r_1d)(int n, R *in, R *out, \
cannam@111 289 X(r2r_kind) kind, unsigned flags); \
cannam@111 290 FFTW_EXTERN X(plan) X(plan_r2r_2d)(int n0, int n1, R *in, R *out, \
cannam@111 291 X(r2r_kind) kind0, X(r2r_kind) kind1, \
cannam@111 292 unsigned flags); \
cannam@111 293 FFTW_EXTERN X(plan) X(plan_r2r_3d)(int n0, int n1, int n2, \
cannam@111 294 R *in, R *out, X(r2r_kind) kind0, \
cannam@111 295 X(r2r_kind) kind1, X(r2r_kind) kind2, \
cannam@111 296 unsigned flags); \
cannam@111 297 \
cannam@111 298 FFTW_EXTERN X(plan) X(plan_guru_r2r)(int rank, const X(iodim) *dims, \
cannam@111 299 int howmany_rank, \
cannam@111 300 const X(iodim) *howmany_dims, \
cannam@111 301 R *in, R *out, \
cannam@111 302 const X(r2r_kind) *kind, unsigned flags); \
cannam@111 303 \
cannam@111 304 FFTW_EXTERN X(plan) X(plan_guru64_r2r)(int rank, const X(iodim64) *dims, \
cannam@111 305 int howmany_rank, \
cannam@111 306 const X(iodim64) *howmany_dims, \
cannam@111 307 R *in, R *out, \
cannam@111 308 const X(r2r_kind) *kind, unsigned flags); \
cannam@111 309 \
cannam@111 310 FFTW_EXTERN void X(execute_r2r)(const X(plan) p, R *in, R *out); \
cannam@111 311 \
cannam@111 312 FFTW_EXTERN void X(destroy_plan)(X(plan) p); \
cannam@111 313 FFTW_EXTERN void X(forget_wisdom)(void); \
cannam@111 314 FFTW_EXTERN void X(cleanup)(void); \
cannam@111 315 \
cannam@111 316 FFTW_EXTERN void X(set_timelimit)(double t); \
cannam@111 317 \
cannam@111 318 FFTW_EXTERN void X(plan_with_nthreads)(int nthreads); \
cannam@111 319 FFTW_EXTERN int X(init_threads)(void); \
cannam@111 320 FFTW_EXTERN void X(cleanup_threads)(void); \
cannam@111 321 \
cannam@111 322 FFTW_EXTERN int X(export_wisdom_to_filename)(const char *filename); \
cannam@111 323 FFTW_EXTERN void X(export_wisdom_to_file)(FILE *output_file); \
cannam@111 324 FFTW_EXTERN char *X(export_wisdom_to_string)(void); \
cannam@111 325 FFTW_EXTERN void X(export_wisdom)(X(write_char_func) write_char, \
cannam@111 326 void *data); \
cannam@111 327 FFTW_EXTERN int X(import_system_wisdom)(void); \
cannam@111 328 FFTW_EXTERN int X(import_wisdom_from_filename)(const char *filename); \
cannam@111 329 FFTW_EXTERN int X(import_wisdom_from_file)(FILE *input_file); \
cannam@111 330 FFTW_EXTERN int X(import_wisdom_from_string)(const char *input_string); \
cannam@111 331 FFTW_EXTERN int X(import_wisdom)(X(read_char_func) read_char, void *data); \
cannam@111 332 \
cannam@111 333 FFTW_EXTERN void X(fprint_plan)(const X(plan) p, FILE *output_file); \
cannam@111 334 FFTW_EXTERN void X(print_plan)(const X(plan) p); \
cannam@111 335 \
cannam@111 336 FFTW_EXTERN void *X(malloc)(size_t n); \
cannam@111 337 FFTW_EXTERN R *X(alloc_real)(size_t n); \
cannam@111 338 FFTW_EXTERN C *X(alloc_complex)(size_t n); \
cannam@111 339 FFTW_EXTERN void X(free)(void *p); \
cannam@111 340 \
cannam@111 341 FFTW_EXTERN void X(flops)(const X(plan) p, \
cannam@111 342 double *add, double *mul, double *fmas); \
cannam@111 343 FFTW_EXTERN double X(estimate_cost)(const X(plan) p); \
cannam@111 344 FFTW_EXTERN double X(cost)(const X(plan) p); \
cannam@111 345 \
cannam@111 346 FFTW_EXTERN const char X(version)[]; \
cannam@111 347 FFTW_EXTERN const char X(cc)[]; \
cannam@111 348 FFTW_EXTERN const char X(codelet_optim)[];
cannam@111 349
cannam@111 350
cannam@111 351 /* end of FFTW_DEFINE_API macro */
cannam@111 352
cannam@111 353 FFTW_DEFINE_API(FFTW_MANGLE_DOUBLE, double, fftw_complex)
cannam@111 354 FFTW_DEFINE_API(FFTW_MANGLE_FLOAT, float, fftwf_complex)
cannam@111 355 FFTW_DEFINE_API(FFTW_MANGLE_LONG_DOUBLE, long double, fftwl_complex)
cannam@111 356
cannam@111 357 /* __float128 (quad precision) is a gcc extension on i386, x86_64, and ia64
cannam@111 358 for gcc >= 4.6 (compiled in FFTW with --enable-quad-precision) */
cannam@111 359 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)) \
cannam@111 360 && !(defined(__ICC) || defined(__INTEL_COMPILER)) \
cannam@111 361 && (defined(__i386__) || defined(__x86_64__) || defined(__ia64__))
cannam@111 362 # if !defined(FFTW_NO_Complex) && defined(_Complex_I) && defined(complex) && defined(I)
cannam@111 363 /* note: __float128 is a typedef, which is not supported with the _Complex
cannam@111 364 keyword in gcc, so instead we use this ugly __attribute__ version.
cannam@111 365 However, we can't simply pass the __attribute__ version to
cannam@111 366 FFTW_DEFINE_API because the __attribute__ confuses gcc in pointer
cannam@111 367 types. Hence redefining FFTW_DEFINE_COMPLEX. Ugh. */
cannam@111 368 # undef FFTW_DEFINE_COMPLEX
cannam@111 369 # define FFTW_DEFINE_COMPLEX(R, C) typedef _Complex float __attribute__((mode(TC))) C
cannam@111 370 # endif
cannam@111 371 FFTW_DEFINE_API(FFTW_MANGLE_QUAD, __float128, fftwq_complex)
cannam@111 372 #endif
cannam@111 373
cannam@111 374 #define FFTW_FORWARD (-1)
cannam@111 375 #define FFTW_BACKWARD (+1)
cannam@111 376
cannam@111 377 #define FFTW_NO_TIMELIMIT (-1.0)
cannam@111 378
cannam@111 379 /* documented flags */
cannam@111 380 #define FFTW_MEASURE (0U)
cannam@111 381 #define FFTW_DESTROY_INPUT (1U << 0)
cannam@111 382 #define FFTW_UNALIGNED (1U << 1)
cannam@111 383 #define FFTW_CONSERVE_MEMORY (1U << 2)
cannam@111 384 #define FFTW_EXHAUSTIVE (1U << 3) /* NO_EXHAUSTIVE is default */
cannam@111 385 #define FFTW_PRESERVE_INPUT (1U << 4) /* cancels FFTW_DESTROY_INPUT */
cannam@111 386 #define FFTW_PATIENT (1U << 5) /* IMPATIENT is default */
cannam@111 387 #define FFTW_ESTIMATE (1U << 6)
cannam@111 388 #define FFTW_WISDOM_ONLY (1U << 21)
cannam@111 389
cannam@111 390 /* undocumented beyond-guru flags */
cannam@111 391 #define FFTW_ESTIMATE_PATIENT (1U << 7)
cannam@111 392 #define FFTW_BELIEVE_PCOST (1U << 8)
cannam@111 393 #define FFTW_NO_DFT_R2HC (1U << 9)
cannam@111 394 #define FFTW_NO_NONTHREADED (1U << 10)
cannam@111 395 #define FFTW_NO_BUFFERING (1U << 11)
cannam@111 396 #define FFTW_NO_INDIRECT_OP (1U << 12)
cannam@111 397 #define FFTW_ALLOW_LARGE_GENERIC (1U << 13) /* NO_LARGE_GENERIC is default */
cannam@111 398 #define FFTW_NO_RANK_SPLITS (1U << 14)
cannam@111 399 #define FFTW_NO_VRANK_SPLITS (1U << 15)
cannam@111 400 #define FFTW_NO_VRECURSE (1U << 16)
cannam@111 401 #define FFTW_NO_SIMD (1U << 17)
cannam@111 402 #define FFTW_NO_SLOW (1U << 18)
cannam@111 403 #define FFTW_NO_FIXED_RADIX_LARGE_N (1U << 19)
cannam@111 404 #define FFTW_ALLOW_PRUNING (1U << 20)
cannam@111 405
cannam@111 406 #ifdef __cplusplus
cannam@111 407 } /* extern "C" */
cannam@111 408 #endif /* __cplusplus */
cannam@111 409
cannam@111 410 #endif /* FFTW3_H */