annotate src/fftw-3.3.5/doc/html/Generating-your-own-code.html @ 42:2cd0e3b3e1fd

Current fftw source
author Chris Cannam
date Tue, 18 Oct 2016 13:40:26 +0100
parents
children
rev   line source
Chris@42 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
Chris@42 2 <html>
Chris@42 3 <!-- This manual is for FFTW
Chris@42 4 (version 3.3.5, 30 July 2016).
Chris@42 5
Chris@42 6 Copyright (C) 2003 Matteo Frigo.
Chris@42 7
Chris@42 8 Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@42 9
Chris@42 10 Permission is granted to make and distribute verbatim copies of this
Chris@42 11 manual provided the copyright notice and this permission notice are
Chris@42 12 preserved on all copies.
Chris@42 13
Chris@42 14 Permission is granted to copy and distribute modified versions of this
Chris@42 15 manual under the conditions for verbatim copying, provided that the
Chris@42 16 entire resulting derived work is distributed under the terms of a
Chris@42 17 permission notice identical to this one.
Chris@42 18
Chris@42 19 Permission is granted to copy and distribute translations of this manual
Chris@42 20 into another language, under the above conditions for modified versions,
Chris@42 21 except that this permission notice may be stated in a translation
Chris@42 22 approved by the Free Software Foundation. -->
Chris@42 23 <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
Chris@42 24 <head>
Chris@42 25 <title>FFTW 3.3.5: Generating your own code</title>
Chris@42 26
Chris@42 27 <meta name="description" content="FFTW 3.3.5: Generating your own code">
Chris@42 28 <meta name="keywords" content="FFTW 3.3.5: Generating your own code">
Chris@42 29 <meta name="resource-type" content="document">
Chris@42 30 <meta name="distribution" content="global">
Chris@42 31 <meta name="Generator" content="makeinfo">
Chris@42 32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Chris@42 33 <link href="index.html#Top" rel="start" title="Top">
Chris@42 34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
Chris@42 35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
Chris@42 36 <link href="Installation-and-Customization.html#Installation-and-Customization" rel="up" title="Installation and Customization">
Chris@42 37 <link href="Acknowledgments.html#Acknowledgments" rel="next" title="Acknowledgments">
Chris@42 38 <link href="Cycle-Counters.html#Cycle-Counters" rel="prev" title="Cycle Counters">
Chris@42 39 <style type="text/css">
Chris@42 40 <!--
Chris@42 41 a.summary-letter {text-decoration: none}
Chris@42 42 blockquote.smallquotation {font-size: smaller}
Chris@42 43 div.display {margin-left: 3.2em}
Chris@42 44 div.example {margin-left: 3.2em}
Chris@42 45 div.indentedblock {margin-left: 3.2em}
Chris@42 46 div.lisp {margin-left: 3.2em}
Chris@42 47 div.smalldisplay {margin-left: 3.2em}
Chris@42 48 div.smallexample {margin-left: 3.2em}
Chris@42 49 div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
Chris@42 50 div.smalllisp {margin-left: 3.2em}
Chris@42 51 kbd {font-style:oblique}
Chris@42 52 pre.display {font-family: inherit}
Chris@42 53 pre.format {font-family: inherit}
Chris@42 54 pre.menu-comment {font-family: serif}
Chris@42 55 pre.menu-preformatted {font-family: serif}
Chris@42 56 pre.smalldisplay {font-family: inherit; font-size: smaller}
Chris@42 57 pre.smallexample {font-size: smaller}
Chris@42 58 pre.smallformat {font-family: inherit; font-size: smaller}
Chris@42 59 pre.smalllisp {font-size: smaller}
Chris@42 60 span.nocodebreak {white-space:nowrap}
Chris@42 61 span.nolinebreak {white-space:nowrap}
Chris@42 62 span.roman {font-family:serif; font-weight:normal}
Chris@42 63 span.sansserif {font-family:sans-serif; font-weight:normal}
Chris@42 64 ul.no-bullet {list-style: none}
Chris@42 65 -->
Chris@42 66 </style>
Chris@42 67
Chris@42 68
Chris@42 69 </head>
Chris@42 70
Chris@42 71 <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
Chris@42 72 <a name="Generating-your-own-code"></a>
Chris@42 73 <div class="header">
Chris@42 74 <p>
Chris@42 75 Previous: <a href="Cycle-Counters.html#Cycle-Counters" accesskey="p" rel="prev">Cycle Counters</a>, Up: <a href="Installation-and-Customization.html#Installation-and-Customization" accesskey="u" rel="up">Installation and Customization</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
Chris@42 76 </div>
Chris@42 77 <hr>
Chris@42 78 <a name="Generating-your-own-code-1"></a>
Chris@42 79 <h3 class="section">10.4 Generating your own code</h3>
Chris@42 80 <a name="index-code-generator-1"></a>
Chris@42 81
Chris@42 82 <p>The directory <code>genfft</code> contains the programs that were used to
Chris@42 83 generate FFTW&rsquo;s &ldquo;codelets,&rdquo; which are hard-coded transforms of small
Chris@42 84 sizes.
Chris@42 85 <a name="index-codelet-2"></a>
Chris@42 86 We do not expect casual users to employ the generator, which is a rather
Chris@42 87 sophisticated program that generates directed acyclic graphs of FFT
Chris@42 88 algorithms and performs algebraic simplifications on them. It was
Chris@42 89 written in Objective Caml, a dialect of ML, which is available at
Chris@42 90 <a href="http://caml.inria.fr/ocaml/index.en.html">http://caml.inria.fr/ocaml/index.en.html</a>.
Chris@42 91 <a name="index-Caml"></a>
Chris@42 92 </p>
Chris@42 93
Chris@42 94 <p>If you have Objective Caml installed (along with recent versions of
Chris@42 95 GNU <code>autoconf</code>, <code>automake</code>, and <code>libtool</code>), then you
Chris@42 96 can change the set of codelets that are generated or play with the
Chris@42 97 generation options. The set of generated codelets is specified by the
Chris@42 98 <code>{dft,rdft}/{codelets,simd}/*/Makefile.am</code> files. For example, you can add
Chris@42 99 efficient REDFT codelets of small sizes by modifying
Chris@42 100 <code>rdft/codelets/r2r/Makefile.am</code>.
Chris@42 101 <a name="index-REDFT-2"></a>
Chris@42 102 After you modify any <code>Makefile.am</code> files, you can type <code>sh
Chris@42 103 bootstrap.sh</code> in the top-level directory followed by <code>make</code> to
Chris@42 104 re-generate the files.
Chris@42 105 </p>
Chris@42 106 <p>We do not provide more details about the code-generation process, since
Chris@42 107 we do not expect that most users will need to generate their own code.
Chris@42 108 However, feel free to contact us at <a href="mailto:fftw@fftw.org">fftw@fftw.org</a> if
Chris@42 109 you are interested in the subject.
Chris@42 110 </p>
Chris@42 111 <a name="index-monadic-programming"></a>
Chris@42 112 <p>You might find it interesting to learn Caml and/or some modern
Chris@42 113 programming techniques that we used in the generator (including monadic
Chris@42 114 programming), especially if you heard the rumor that Java and
Chris@42 115 object-oriented programming are the latest advancement in the field.
Chris@42 116 The internal operation of the codelet generator is described in the
Chris@42 117 paper, &ldquo;A Fast Fourier Transform Compiler,&rdquo; by M. Frigo, which is
Chris@42 118 available from the <a href="http://www.fftw.org">FFTW home page</a> and also
Chris@42 119 appeared in the <cite>Proceedings of the 1999 ACM SIGPLAN Conference on
Chris@42 120 Programming Language Design and Implementation (PLDI)</cite>.
Chris@42 121 </p>
Chris@42 122 <hr>
Chris@42 123 <div class="header">
Chris@42 124 <p>
Chris@42 125 Previous: <a href="Cycle-Counters.html#Cycle-Counters" accesskey="p" rel="prev">Cycle Counters</a>, Up: <a href="Installation-and-Customization.html#Installation-and-Customization" accesskey="u" rel="up">Installation and Customization</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
Chris@42 126 </div>
Chris@42 127
Chris@42 128
Chris@42 129
Chris@42 130 </body>
Chris@42 131 </html>