2
.\" Copyright (c) 2003, 2007-11 Matteo Frigo
3
.\" Copyright (c) 2003, 2007-11 Massachusetts Institute of Technology
5
.\" This program is free software; you can redistribute it and/or modify
6
.\" it under the terms of the GNU General Public License as published by
7
.\" the Free Software Foundation; either version 2 of the License, or
8
.\" (at your option) any later version.
10
.\" This program is distributed in the hope that it will be useful,
11
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
12
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
.\" GNU General Public License for more details.
15
.\" You should have received a copy of the GNU General Public License
16
.\" along with this program; if not, write to the Free Software
17
.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
.TH FFTW-WISDOM-TO-CONF 1 "February, 2003" "fftw" "fftw"
21
fftw-wisdom-to-conf \- generate FFTW wisdom (pre-planned transforms)
23
\fBfftw-wisdom-to-conf\fR [< \fIINPUT\fR] [> \fIOUTPUT\fR]
26
." Add any additional description here
27
.I fftw-wisdom-to-conf
28
is a utility to generate C
32
files, where the latter contain saved information about how to
33
optimally compute (Fourier) transforms of various sizes. A
34
configuration routine is a C subroutine that you link into your
35
program, replacing a routine of the same name in the FFTW library,
36
that determines which parts of FFTW are callable by your program.
38
The reason to do this is that, if you only need transforms of a
39
limited set of sizes and types, and if you are statically linking your
40
program, then using a configuration file generated from wisdom for
41
those types can substantially reduce the size of your executable.
42
(Otherwise, because of FFTW's dynamic nature, all of FFTW's transform
43
code must be linked into any program using FFTW.)
45
FFTW is a free library to compute discrete Fourier transforms in one
46
or more dimensions, for arbitrary sizes, and of both real and complex
47
data, among other related operations. More information on FFTW can be
48
found at the FFTW home page:
49
.I http://www.fftw.org
51
.I fftw-wisdom-to-conf
52
reads wisdom from standard input and writes the configuration to
53
standard output. It can easily be combined with the
57
fftw-wisdom -n cof1024 cob1024 -o wisdom
59
fftw-wisdom-to-conf < wisdom > conf.c
61
will create a configuration "conf.c" containing only those parts of
62
FFTW needed for the optimized complex forwards and backwards
63
out-of-place transforms of size 1024 (also saving the wisdom itself in
66
Alternatively, you can run your actual program, export wisdom for all
67
plans that were created (ideally in FFTW_PATIENT or FFTW_EXHAUSTIVE
68
mode), use this as input for \fIfftw-wisdom-to-conf\fR,
69
and then re-link your program with the resulting configuration routine.
71
Note that the configuration routine does not contain the wisdom, only
72
the routines necessary to implement the wisdom, so your program should
73
also import the wisdom in order to benefit from the pre-optimized
77
\fB\-h\fR, \fB\--help\fR
78
Display help on the command-line options and usage.
80
\fB\-V\fR, \fB\--version\fR
81
Print the version number and copyright information.
83
Send bug reports to fftw@fftw.org.
85
Written by Steven G. Johnson and Matteo Frigo.
87
Copyright (c) 2003, 2007-11 Matteo Frigo
89
Copyright (c) 2003, 2007-11 Massachusetts Institute of Technology
added
removed
.pc/03_fix_manpages.diff/tools/fftw-wisdom-to-conf.1
