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