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