annotate src/fftw-3.3.3/doc/html/Generating-your-own-code.html @ 10:37bf6b4a2645

Add FFTW3
author Chris Cannam
date Wed, 20 Mar 2013 15:35:50 +0000
parents
children
rev   line source
Chris@10 1 <html lang="en">
Chris@10 2 <head>
Chris@10 3 <title>Generating your own code - FFTW 3.3.3</title>
Chris@10 4 <meta http-equiv="Content-Type" content="text/html">
Chris@10 5 <meta name="description" content="FFTW 3.3.3">
Chris@10 6 <meta name="generator" content="makeinfo 4.13">
Chris@10 7 <link title="Top" rel="start" href="index.html#Top">
Chris@10 8 <link rel="up" href="Installation-and-Customization.html#Installation-and-Customization" title="Installation and Customization">
Chris@10 9 <link rel="prev" href="Cycle-Counters.html#Cycle-Counters" title="Cycle Counters">
Chris@10 10 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
Chris@10 11 <!--
Chris@10 12 This manual is for FFTW
Chris@10 13 (version 3.3.3, 25 November 2012).
Chris@10 14
Chris@10 15 Copyright (C) 2003 Matteo Frigo.
Chris@10 16
Chris@10 17 Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@10 18
Chris@10 19 Permission is granted to make and distribute verbatim copies of
Chris@10 20 this manual provided the copyright notice and this permission
Chris@10 21 notice are preserved on all copies.
Chris@10 22
Chris@10 23 Permission is granted to copy and distribute modified versions of
Chris@10 24 this manual under the conditions for verbatim copying, provided
Chris@10 25 that the entire resulting derived work is distributed under the
Chris@10 26 terms of a permission notice identical to this one.
Chris@10 27
Chris@10 28 Permission is granted to copy and distribute translations of this
Chris@10 29 manual into another language, under the above conditions for
Chris@10 30 modified versions, except that this permission notice may be
Chris@10 31 stated in a translation approved by the Free Software Foundation.
Chris@10 32 -->
Chris@10 33 <meta http-equiv="Content-Style-Type" content="text/css">
Chris@10 34 <style type="text/css"><!--
Chris@10 35 pre.display { font-family:inherit }
Chris@10 36 pre.format { font-family:inherit }
Chris@10 37 pre.smalldisplay { font-family:inherit; font-size:smaller }
Chris@10 38 pre.smallformat { font-family:inherit; font-size:smaller }
Chris@10 39 pre.smallexample { font-size:smaller }
Chris@10 40 pre.smalllisp { font-size:smaller }
Chris@10 41 span.sc { font-variant:small-caps }
Chris@10 42 span.roman { font-family:serif; font-weight:normal; }
Chris@10 43 span.sansserif { font-family:sans-serif; font-weight:normal; }
Chris@10 44 --></style>
Chris@10 45 </head>
Chris@10 46 <body>
Chris@10 47 <div class="node">
Chris@10 48 <a name="Generating-your-own-code"></a>
Chris@10 49 <p>
Chris@10 50 Previous:&nbsp;<a rel="previous" accesskey="p" href="Cycle-Counters.html#Cycle-Counters">Cycle Counters</a>,
Chris@10 51 Up:&nbsp;<a rel="up" accesskey="u" href="Installation-and-Customization.html#Installation-and-Customization">Installation and Customization</a>
Chris@10 52 <hr>
Chris@10 53 </div>
Chris@10 54
Chris@10 55 <h3 class="section">10.4 Generating your own code</h3>
Chris@10 56
Chris@10 57 <p><a name="index-code-generator-622"></a>
Chris@10 58 The directory <code>genfft</code> contains the programs that were used to
Chris@10 59 generate FFTW's &ldquo;codelets,&rdquo; which are hard-coded transforms of small
Chris@10 60 sizes.
Chris@10 61 <a name="index-codelet-623"></a>We do not expect casual users to employ the generator, which is a rather
Chris@10 62 sophisticated program that generates directed acyclic graphs of FFT
Chris@10 63 algorithms and performs algebraic simplifications on them. It was
Chris@10 64 written in Objective Caml, a dialect of ML, which is available at
Chris@10 65 <a href="http://caml.inria.fr/ocaml/index.en.html">http://caml.inria.fr/ocaml/index.en.html</a>.
Chris@10 66 <a name="index-Caml-624"></a>
Chris@10 67
Chris@10 68 <p>If you have Objective Caml installed (along with recent versions of
Chris@10 69 GNU <code>autoconf</code>, <code>automake</code>, and <code>libtool</code>), then you
Chris@10 70 can change the set of codelets that are generated or play with the
Chris@10 71 generation options. The set of generated codelets is specified by the
Chris@10 72 <code>{dft,rdft}/{codelets,simd}/*/Makefile.am</code> files. For example, you can add
Chris@10 73 efficient REDFT codelets of small sizes by modifying
Chris@10 74 <code>rdft/codelets/r2r/Makefile.am</code>.
Chris@10 75 <a name="index-REDFT-625"></a>After you modify any <code>Makefile.am</code> files, you can type <code>sh
Chris@10 76 bootstrap.sh</code> in the top-level directory followed by <code>make</code> to
Chris@10 77 re-generate the files.
Chris@10 78
Chris@10 79 <p>We do not provide more details about the code-generation process, since
Chris@10 80 we do not expect that most users will need to generate their own code.
Chris@10 81 However, feel free to contact us at <a href="mailto:fftw@fftw.org">fftw@fftw.org</a> if
Chris@10 82 you are interested in the subject.
Chris@10 83
Chris@10 84 <p><a name="index-monadic-programming-626"></a>You might find it interesting to learn Caml and/or some modern
Chris@10 85 programming techniques that we used in the generator (including monadic
Chris@10 86 programming), especially if you heard the rumor that Java and
Chris@10 87 object-oriented programming are the latest advancement in the field.
Chris@10 88 The internal operation of the codelet generator is described in the
Chris@10 89 paper, &ldquo;A Fast Fourier Transform Compiler,&rdquo; by M. Frigo, which is
Chris@10 90 available from the <a href="http://www.fftw.org">FFTW home page</a> and also
Chris@10 91 appeared in the <cite>Proceedings of the 1999 ACM SIGPLAN Conference on
Chris@10 92 Programming Language Design and Implementation (PLDI)</cite>.
Chris@10 93
Chris@10 94 </body></html>
Chris@10 95