annotate src/fftw-3.3.5/doc/html/Generating-your-own-code.html @ 127:7867fa7e1b6b

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