This file is indexed.

/usr/share/doc/libfftw3-doc/html/Generating-your-own-code.html is in libfftw3-doc 3.3.3-7ubuntu3.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for FFTW
(version 3.3.3, 25 November 2012).

Copyright (C) 2003 Matteo Frigo.

Copyright (C) 2003 Massachusetts Institute of Technology.

Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.

Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>FFTW 3.3.3: Generating your own code</title>

<meta name="description" content="FFTW 3.3.3: Generating your own code">
<meta name="keywords" content="FFTW 3.3.3: Generating your own code">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Installation-and-Customization.html#Installation-and-Customization" rel="up" title="Installation and Customization">
<link href="Acknowledgments.html#Acknowledgments" rel="next" title="Acknowledgments">
<link href="Cycle-Counters.html#Cycle-Counters" rel="prev" title="Cycle Counters">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Generating-your-own-code"></a>
<div class="header">
<p>
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>
</div>
<hr>
<a name="Generating-your-own-code-1"></a>
<h3 class="section">10.4 Generating your own code</h3>
<a name="index-code-generator-1"></a>

<p>The directory <code>genfft</code> contains the programs that were used to
generate FFTW&rsquo;s &ldquo;codelets,&rdquo; which are hard-coded transforms of small
sizes.
<a name="index-codelet-2"></a>
We do not expect casual users to employ the generator, which is a rather
sophisticated program that generates directed acyclic graphs of FFT
algorithms and performs algebraic simplifications on them.  It was
written in Objective Caml, a dialect of ML, which is available at
<a href="http://caml.inria.fr/ocaml/index.en.html">http://caml.inria.fr/ocaml/index.en.html</a>.
<a name="index-Caml"></a>
</p>

<p>If you have Objective Caml installed (along with recent versions of
GNU <code>autoconf</code>, <code>automake</code>, and <code>libtool</code>), then you
can change the set of codelets that are generated or play with the
generation options.  The set of generated codelets is specified by the
<code>{dft,rdft}/{codelets,simd}/*/Makefile.am</code> files.  For example, you can add
efficient REDFT codelets of small sizes by modifying
<code>rdft/codelets/r2r/Makefile.am</code>.
<a name="index-REDFT-2"></a>
After you modify any <code>Makefile.am</code> files, you can type <code>sh
bootstrap.sh</code> in the top-level directory followed by <code>make</code> to
re-generate the files.
</p>
<p>We do not provide more details about the code-generation process, since
we do not expect that most users will need to generate their own code.
However, feel free to contact us at <a href="mailto:fftw@fftw.org">fftw@fftw.org</a> if
you are interested in the subject.
</p>
<a name="index-monadic-programming"></a>
<p>You might find it interesting to learn Caml and/or some modern
programming techniques that we used in the generator (including monadic
programming), especially if you heard the rumor that Java and
object-oriented programming are the latest advancement in the field.
The internal operation of the codelet generator is described in the
paper, &ldquo;A Fast Fourier Transform Compiler,&rdquo; by M. Frigo, which is
available from the <a href="http://www.fftw.org">FFTW home page</a> and also
appeared in the <cite>Proceedings of the 1999 ACM SIGPLAN Conference on
Programming Language Design and Implementation (PLDI)</cite>.
</p>
<hr>
<div class="header">
<p>
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>
</div>



</body>
</html>