Chris@10: Next: Real-data DFTs, Chris@10: Previous: Complex DFTs, Chris@10: Up: Basic Interface Chris@10:
All of the planner routines in FFTW accept an integer flags
Chris@10: argument, which is a bitwise OR (‘|’) of zero or more of the flag
Chris@10: constants defined below. These flags control the rigor (and time) of
Chris@10: the planning process, and can also impose (or lift) restrictions on the
Chris@10: type of transform algorithm that is employed.
Chris@10:
Chris@10:
Important: the planner overwrites the input array during
Chris@10: planning unless a saved plan (see Wisdom) is available for that
Chris@10: problem, so you should initialize your input data after creating the
Chris@10: plan. The only exceptions to this are the FFTW_ESTIMATE and
Chris@10: FFTW_WISDOM_ONLY flags, as mentioned below.
Chris@10:
Chris@10:
In all cases, if wisdom is available for the given problem that was
Chris@10: created with equal-or-greater planning rigor, then the more rigorous
Chris@10: wisdom is used. For example, in FFTW_ESTIMATE mode any available
Chris@10: wisdom is used, whereas in FFTW_PATIENT mode only wisdom created
Chris@10: in patient or exhaustive mode can be used. See Words of Wisdom-Saving Plans.
Chris@10:
Chris@10:
FFTW_ESTIMATE specifies that, instead of actual measurements of
Chris@10: different algorithms, a simple heuristic is used to pick a (probably
Chris@10: sub-optimal) plan quickly. With this flag, the input/output arrays are
Chris@10: not overwritten during planning.
Chris@10:
Chris@10: FFTW_MEASURE tells FFTW to find an optimized plan by actually
Chris@10: computing several FFTs and measuring their execution time.
Chris@10: Depending on your machine, this can take some time (often a few
Chris@10: seconds). FFTW_MEASURE is the default planning option.
Chris@10:
Chris@10: FFTW_PATIENT is like FFTW_MEASURE, but considers a wider
Chris@10: range of algorithms and often produces a “more optimal” plan
Chris@10: (especially for large transforms), but at the expense of several times
Chris@10: longer planning time (especially for large transforms).
Chris@10:
Chris@10: FFTW_EXHAUSTIVE is like FFTW_PATIENT, but considers an
Chris@10: even wider range of algorithms, including many that we think are
Chris@10: unlikely to be fast, to produce the most optimal plan but with a
Chris@10: substantially increased planning time.
Chris@10:
Chris@10: FFTW_WISDOM_ONLY is a special planning mode in which the plan
Chris@10: is only created if wisdom is available for the given problem, and
Chris@10: otherwise a NULL plan is returned. This can be combined with
Chris@10: other flags, e.g. ‘FFTW_WISDOM_ONLY | FFTW_PATIENT’ creates a
Chris@10: plan only if wisdom is available that was created in
Chris@10: FFTW_PATIENT or FFTW_EXHAUSTIVE mode. The
Chris@10: FFTW_WISDOM_ONLY flag is intended for users who need to detect
Chris@10: whether wisdom is available; for example, if wisdom is not available
Chris@10: one may wish to allocate new arrays for planning so that user data is
Chris@10: not overwritten.
Chris@10:
Chris@10: FFTW_DESTROY_INPUT specifies that an out-of-place transform is
Chris@10: allowed to overwrite its input array with arbitrary data; this
Chris@10: can sometimes allow more efficient algorithms to be employed.
Chris@10:
Chris@10: FFTW_PRESERVE_INPUT specifies that an out-of-place transform must
Chris@10: not change its input array. This is ordinarily the
Chris@10: default, except for c2r and hc2r (i.e. complex-to-real)
Chris@10: transforms for which FFTW_DESTROY_INPUT is the default. In the
Chris@10: latter cases, passing FFTW_PRESERVE_INPUT will attempt to use
Chris@10: algorithms that do not destroy the input, at the expense of worse
Chris@10: performance; for multi-dimensional c2r transforms, however, no
Chris@10: input-preserving algorithms are implemented and the planner will return
Chris@10: NULL if one is requested.
Chris@10:
Chris@10: FFTW_UNALIGNED specifies that the algorithm may not impose any
Chris@10: unusual alignment requirements on the input/output arrays (i.e. no
Chris@10: SIMD may be used). This flag is normally not necessary, since
Chris@10: the planner automatically detects misaligned arrays. The only use for
Chris@10: this flag is if you want to use the new-array execute interface to
Chris@10: execute a given plan on a different array that may not be aligned like
Chris@10: the original. (Using fftw_malloc makes this flag unnecessary
Chris@10: even then.)
Chris@10:
Chris@10: extern void fftw_set_timelimit(double seconds); Chris@10:Chris@10:
Chris@10: This function instructs FFTW to spend at most seconds seconds
Chris@10: (approximately) in the planner. If seconds ==
Chris@10: FFTW_NO_TIMELIMIT (the default value, which is negative), then
Chris@10: planning time is unbounded. Otherwise, FFTW plans with a
Chris@10: progressively wider range of algorithms until the the given time limit
Chris@10: is reached or the given range of algorithms is explored, returning the
Chris@10: best available plan.
Chris@10:
Chris@10:
Chris@10:
For example, specifying FFTW_PATIENT first plans in
Chris@10: FFTW_ESTIMATE mode, then in FFTW_MEASURE mode, then
Chris@10: finally (time permitting) in FFTW_PATIENT. If
Chris@10: FFTW_EXHAUSTIVE is specified instead, the planner will further
Chris@10: progress to FFTW_EXHAUSTIVE mode.
Chris@10:
Chris@10:
Note that the seconds argument specifies only a rough limit; in
Chris@10: practice, the planner may use somewhat more time if the time limit is
Chris@10: reached when the planner is in the middle of an operation that cannot
Chris@10: be interrupted. At the very least, the planner will complete planning
Chris@10: in FFTW_ESTIMATE mode (which is thus equivalent to a time limit
Chris@10: of 0).
Chris@10:
Chris@10:
Chris@10:
Chris@10: