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