Chris@10: .\" 
Chris@10: .\" Copyright (c) 2003, 2007-11 Matteo Frigo
Chris@10: .\" Copyright (c) 2003, 2007-11 Massachusetts Institute of Technology
Chris@10: .\" 
Chris@10: .\" This program is free software; you can redistribute it and/or modify
Chris@10: .\" it under the terms of the GNU General Public License as published by
Chris@10: .\" the Free Software Foundation; either version 2 of the License, or
Chris@10: .\" (at your option) any later version.
Chris@10: .\" 
Chris@10: .\" This program is distributed in the hope that it will be useful,
Chris@10: .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@10: .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@10: .\" GNU General Public License for more details.
Chris@10: .\" 
Chris@10: .\" You should have received a copy of the GNU General Public License
Chris@10: .\" along with this program; if not, write to the Free Software
Chris@10: .\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
Chris@10: .\"
Chris@10: .TH FFTW-WISDOM-TO-CONF 1 "February, 2003" "fftw" "fftw"
Chris@10: .SH NAME
Chris@10: fftw-wisdom-to-conf \- generate FFTW wisdom (pre-planned transforms)
Chris@10: .SH SYNOPSIS
Chris@10: \fBfftw-wisdom-to-conf\fR [< \fIINPUT\fR] [> \fIOUTPUT\fR]
Chris@10: .SH DESCRIPTION
Chris@10: .PP
Chris@10: ." Add any additional description here
Chris@10: .I fftw-wisdom-to-conf
Chris@10: is a utility to generate C
Chris@10: .B configuration
Chris@10: routines from FFTW
Chris@10: .B wisdom
Chris@10: files, where the latter contain saved information about how to
Chris@10: optimally compute (Fourier) transforms of various sizes.  A
Chris@10: configuration routine is a C subroutine that you link into your
Chris@10: program, replacing a routine of the same name in the FFTW library,
Chris@10: that determines which parts of FFTW are callable by your program.
Chris@10: 
Chris@10: The reason to do this is that, if you only need transforms of a
Chris@10: limited set of sizes and types, and if you are statically linking your
Chris@10: program, then using a configuration file generated from wisdom for
Chris@10: those types can substantially reduce the size of your executable.
Chris@10: (Otherwise, because of FFTW's dynamic nature, all of FFTW's transform
Chris@10: code must be linked into any program using FFTW.)
Chris@10: 
Chris@10: FFTW is a free library to compute discrete Fourier transforms in one
Chris@10: or more dimensions, for arbitrary sizes, and of both real and complex
Chris@10: data, among other related operations.  More information on FFTW can be
Chris@10: found at the FFTW home page:
Chris@10: .I http://www.fftw.org
Chris@10: 
Chris@10: .I fftw-wisdom-to-conf
Chris@10: reads wisdom from standard input and writes the configuration to
Chris@10: standard output.  It can easily be combined with the
Chris@10: .I fftw-wisdom
Chris@10: tool, for example:
Chris@10: 
Chris@10: fftw-wisdom -n cof1024 cob1024 -o wisdom
Chris@10: .br
Chris@10: fftw-wisdom-to-conf < wisdom > conf.c
Chris@10: 
Chris@10: will create a configuration "conf.c" containing only those parts of
Chris@10: FFTW needed for the optimized complex forwards and backwards
Chris@10: out-of-place transforms of size 1024 (also saving the wisdom itself in
Chris@10: "wisdom").
Chris@10: 
Chris@10: Alternatively, you can run your actual program, export wisdom for all
Chris@10: plans that were created (ideally in FFTW_PATIENT or FFTW_EXHAUSTIVE
Chris@10: mode), use this as input for \fIfftw-wisdom-to-conf\fR,
Chris@10: and then re-link your program with the resulting configuration routine.
Chris@10: 
Chris@10: Note that the configuration routine does not contain the wisdom, only
Chris@10: the routines necessary to implement the wisdom, so your program should
Chris@10: also import the wisdom in order to benefit from the pre-optimized
Chris@10: plans.
Chris@10: .SH OPTIONS
Chris@10: .TP
Chris@10: \fB\-h\fR, \fB\--help\fR
Chris@10: Display help on the command-line options and usage.
Chris@10: .TP
Chris@10: \fB\-V\fR, \fB\--version\fR
Chris@10: Print the version number and copyright information.
Chris@10: .SH BUGS
Chris@10: Send bug reports to fftw@fftw.org.
Chris@10: .SH AUTHORS
Chris@10: Written by Steven G. Johnson and Matteo Frigo.
Chris@10: 
Chris@10: Copyright (c) 2003, 2007-11 Matteo Frigo
Chris@10: .br
Chris@10: Copyright (c) 2003, 2007-11 Massachusetts Institute of Technology
Chris@10: .SH "SEE ALSO"
Chris@10: fftw-wisdom(1)