Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.5/doc/fftw3.texi @ 73:02caadb7509e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Rebuild with --disable-stack-protector for mingw32
author Chris Cannam
date Fri, 25 Jan 2019 14:31:07 +0000
parents 2cd0e3b3e1fd
children
rev   line source
Chris@42 1 \input texinfo @c -*-texinfo-*-
Chris@42 2 @c Update by C-x C-e on: (texinfo-multiple-files-update "fftw3.texi" nil t)
Chris@42 3 @setfilename fftw3.info
Chris@42 4 @include version.texi
Chris@42 5 @settitle FFTW @value{VERSION}
Chris@42 6 @setchapternewpage odd
Chris@42 7 @c define constant index (ct)
Chris@42 8 @defcodeindex ct
Chris@42 9 @syncodeindex ct fn
Chris@42 10 @syncodeindex vr fn
Chris@42 11 @syncodeindex pg fn
Chris@42 12 @syncodeindex tp fn
Chris@42 13 @c define foreign function index (ff)
Chris@42 14 @defcodeindex ff
Chris@42 15 @syncodeindex ff cp
Chris@42 16 @c define foreign constant index (fc)
Chris@42 17 @defcodeindex fc
Chris@42 18 @syncodeindex fc cp
Chris@42 19 @c define foreign program index (fp)
Chris@42 20 @defcodeindex fp
Chris@42 21 @syncodeindex fp cp
Chris@42 22 @comment %**end of header
Chris@42 23
Chris@42 24 @iftex
Chris@42 25 @paragraphindent 0
Chris@42 26 @parskip=@medskipamount
Chris@42 27 @end iftex
Chris@42 28
Chris@42 29 @c
Chris@42 30 @c The following macros are coded in a weird way:
Chris@42 31
Chris@42 32 @c @macro FOO
Chris@42 33 @c @noindent
Chris@42 34 @c <STUFF>
Chris@42 35 @c @refill
Chris@42 36 @c @end macro
Chris@42 37
Chris@42 38 @c The @noindent/@refill stuff is not necessary in texinfo up to version
Chris@42 39 @c 4, but it is a hack necessary to make texinfo-5 work.
Chris@42 40
Chris@42 41 @c Texinfo has been stable for the first 15 years of FFTW's history.
Chris@42 42 @c Then some genius, with too much time in his hands and on a mission to
Chris@42 43 @c deliver the world from the evil of the C language, decided to rewrite
Chris@42 44 @c makeinfo in Perl, the old C version of makeinfo being, as I said,
Chris@42 45 @c evil. The official excuse for the rewrite was that now I can have my
Chris@42 46 @c manual in XML format, as if XML were a feature.
Chris@42 47
Chris@42 48 @c The result of this stroke of genius is that texinfo-5 has different
Chris@42 49 @c rules for macro expansion than texinfo-4 does, specifically regarding
Chris@42 50 @c whether or not spaces after a macro are ignored. Texinfo-4 had weird
Chris@42 51 @c rules, but at least they were constant and internally more or less
Chris@42 52 @c consistent. Texinfo-5 has different rules, and even worse the rules
Chris@42 53 @c in texinfo-5 are inconsistent between the TeX and HTML output
Chris@42 54 @c processors. This situation makes it almost impossible for us to
Chris@42 55 @c produce a manual that works with both texinfo 4 and 5 in all modes
Chris@42 56 @c (TeX, info, and html). The @noindent/@refill hack is my best shot at
Chris@42 57 @c patching this situation.
Chris@42 58
Chris@42 59 @c "@noindent" has two effects: First, it makes texinfo-5 believe that
Chris@42 60 @c the next "@ifinfo" is on a new line, otherwise texinfo-5 complains
Chris@42 61 @c that it is not (even though it obviously is). Second, "@noindent" is
Chris@42 62 @c a macro that eats extra space, and we want this effect because somehow
Chris@42 63 @c macro expansion in texinfo-5 inserts extra spaces that were not there
Chris@42 64 @c in texinfo-4.
Chris@42 65
Chris@42 66 @c "@refill" stops texinfo-5 from interpreting the rest of the line after
Chris@42 67 @c a macro invocation as an argument to "@end tex". For example, in
Chris@42 68 @c "FFTW uses @Onlogn algorithms", somehow texinfo-5 thinks that
Chris@42 69 @c "algorithms" is an argument to "@end tex". "@noindent" would have the
Chris@42 70 @c same effect (as would any other macro invocation, I think), but,
Chris@42 71 @c unlike "@noindent", "@refill" does not eat spaces and does not scan
Chris@42 72 @c the rest of the input file for macro arguments. However, "@refill" is
Chris@42 73 @c deemed "obsolete" in the texinfo-5 source code, so expect this to
Chris@42 74 @c break at some point.
Chris@42 75
Chris@42 76 @c This situation is wholly unsatisfactory, and the GNU project is
Chris@42 77 @c obviously out of control. If this nonsense persists, we will abandon
Chris@42 78 @c texinfo and produce a latex-only version of the manual.
Chris@42 79
Chris@42 80
Chris@42 81 @macro Onlogn
Chris@42 82 @noindent
Chris@42 83 @ifinfo
Chris@42 84 O(n log n)
Chris@42 85 @end ifinfo
Chris@42 86 @html
Chris@42 87 <i>O</i>(<i>n</i>&nbsp;log&nbsp;<i>n</i>)
Chris@42 88 @end html
Chris@42 89 @tex
Chris@42 90 $O(n \\log n)$
Chris@42 91 @end tex
Chris@42 92 @refill
Chris@42 93 @end macro
Chris@42 94
Chris@42 95 @macro ndims
Chris@42 96 @noindent
Chris@42 97 @ifinfo
Chris@42 98 n[0] x n[1] x n[2] x ... x n[d-1]
Chris@42 99 @end ifinfo
Chris@42 100 @html
Chris@42 101 n<sub>0</sub>&nbsp;&times;&nbsp;n<sub>1</sub>&nbsp;&times;&nbsp;n<sub>2</sub>&nbsp;&times;&nbsp;&hellip;&nbsp;&times;&nbsp;n<sub>d-1</sub>
Chris@42 102 @end html
Chris@42 103 @tex
Chris@42 104 $n_0 \\times n_1 \\times n_2 \\times \\cdots \\times n_{d-1}$
Chris@42 105 @end tex
Chris@42 106 @refill
Chris@42 107 @end macro
Chris@42 108
Chris@42 109 @macro ndimshalf
Chris@42 110 @noindent
Chris@42 111 @ifinfo
Chris@42 112 n[0] x n[1] x n[2] x ... x (n[d-1]/2 + 1)
Chris@42 113 @end ifinfo
Chris@42 114 @html
Chris@42 115 n<sub>0</sub>&nbsp;&times;&nbsp;n<sub>1</sub>&nbsp;&times;&nbsp;n<sub>2</sub>&nbsp;&times;&nbsp;&hellip;&nbsp;&times;&nbsp;(n<sub>d-1</sub>/2 + 1)
Chris@42 116 @end html
Chris@42 117 @tex
Chris@42 118 $n_0 \\times n_1 \\times n_2 \\times \\cdots \\times (n_{d-1}/2 + 1)$
Chris@42 119 @end tex
Chris@42 120 @refill
Chris@42 121 @end macro
Chris@42 122
Chris@42 123 @macro ndimspad
Chris@42 124 @noindent
Chris@42 125 @ifinfo
Chris@42 126 n[0] x n[1] x n[2] x ... x [2 (n[d-1]/2 + 1)]
Chris@42 127 @end ifinfo
Chris@42 128 @html
Chris@42 129 n<sub>0</sub>&nbsp;&times;&nbsp;n<sub>1</sub>&nbsp;&times;&nbsp;n<sub>2</sub>&nbsp;&times;&nbsp;&hellip;&nbsp;&times;&nbsp;[2&nbsp;(n<sub>d-1</sub>/2 + 1)]
Chris@42 130 @end html
Chris@42 131 @tex
Chris@42 132 $n_0 \\times n_1 \\times n_2 \\times \\cdots \\times [2(n_{d-1}/2 + 1)]$
Chris@42 133 @end tex
Chris@42 134 @refill
Chris@42 135 @end macro
Chris@42 136
Chris@42 137 @macro twodims{d1, d2}
Chris@42 138 @noindent
Chris@42 139 @ifinfo
Chris@42 140 \d1\ x \d2\
Chris@42 141 @end ifinfo
Chris@42 142 @html
Chris@42 143 \d1\&nbsp;&times;&nbsp;\d2\
Chris@42 144 @end html
Chris@42 145 @tex
Chris@42 146 $\d1\ \\times \d2\$
Chris@42 147 @end tex
Chris@42 148 @refill
Chris@42 149 @end macro
Chris@42 150
Chris@42 151 @macro threedims{d1, d2, d3}
Chris@42 152 @noindent
Chris@42 153 @ifinfo
Chris@42 154 \d1\ x \d2\ x \d3\
Chris@42 155 @end ifinfo
Chris@42 156 @html
Chris@42 157 \d1\&nbsp;&times;&nbsp;\d2\&nbsp;&times;&nbsp;\d3\
Chris@42 158 @end html
Chris@42 159 @tex
Chris@42 160 $\d1\ \\times \d2\ \\times \d3\$
Chris@42 161 @end tex
Chris@42 162 @refill
Chris@42 163 @end macro
Chris@42 164
Chris@42 165 @macro dimk{k}
Chris@42 166 @noindent
Chris@42 167 @ifinfo
Chris@42 168 n[\k\]
Chris@42 169 @end ifinfo
Chris@42 170 @html
Chris@42 171 n<sub>\k\</sub>
Chris@42 172 @end html
Chris@42 173 @tex
Chris@42 174 $n_\k\$
Chris@42 175 @end tex
Chris@42 176 @refill
Chris@42 177 @end macro
Chris@42 178
Chris@42 179
Chris@42 180 @macro ndimstrans
Chris@42 181 @noindent
Chris@42 182 @ifinfo
Chris@42 183 n[1] x n[0] x n[2] x ... x n[d-1]
Chris@42 184 @end ifinfo
Chris@42 185 @html
Chris@42 186 n<sub>1</sub>&nbsp;&times;&nbsp;n<sub>0</sub>&nbsp;&times;&nbsp;n<sub>2</sub>&nbsp;&times;&hellip;&times;&nbsp;n<sub>d-1</sub>
Chris@42 187 @end html
Chris@42 188 @tex
Chris@42 189 $n_1 \\times n_0 \\times n_2 \\times \\cdots \\times n_{d-1}$
Chris@42 190 @end tex
Chris@42 191 @refill
Chris@42 192 @end macro
Chris@42 193
Chris@42 194 @copying
Chris@42 195 This manual is for FFTW
Chris@42 196 (version @value{VERSION}, @value{UPDATED}).
Chris@42 197
Chris@42 198 Copyright @copyright{} 2003 Matteo Frigo.
Chris@42 199
Chris@42 200 Copyright @copyright{} 2003 Massachusetts Institute of Technology.
Chris@42 201
Chris@42 202 @quotation
Chris@42 203 Permission is granted to make and distribute verbatim copies of this
Chris@42 204 manual provided the copyright notice and this permission notice are
Chris@42 205 preserved on all copies.
Chris@42 206
Chris@42 207 Permission is granted to copy and distribute modified versions of this
Chris@42 208 manual under the conditions for verbatim copying, provided that the
Chris@42 209 entire resulting derived work is distributed under the terms of a
Chris@42 210 permission notice identical to this one.
Chris@42 211
Chris@42 212 Permission is granted to copy and distribute translations of this manual
Chris@42 213 into another language, under the above conditions for modified versions,
Chris@42 214 except that this permission notice may be stated in a translation
Chris@42 215 approved by the Free Software Foundation.
Chris@42 216 @end quotation
Chris@42 217 @end copying
Chris@42 218
Chris@42 219 @dircategory Development
Chris@42 220 @direntry
Chris@42 221 * fftw3: (fftw3). FFTW User's Manual.
Chris@42 222 @end direntry
Chris@42 223
Chris@42 224 @titlepage
Chris@42 225 @title FFTW
Chris@42 226 @subtitle for version @value{VERSION}, @value{UPDATED}
Chris@42 227 @author Matteo Frigo
Chris@42 228 @author Steven G. Johnson
Chris@42 229 @page
Chris@42 230 @vskip 0pt plus 1filll
Chris@42 231 @insertcopying
Chris@42 232 @end titlepage
Chris@42 233
Chris@42 234 @contents
Chris@42 235
Chris@42 236 @ifnottex
Chris@42 237 @node Top, Introduction, (dir), (dir)
Chris@42 238 @top FFTW User Manual
Chris@42 239 Welcome to FFTW, the Fastest Fourier Transform in the West. FFTW is a
Chris@42 240 collection of fast C routines to compute the discrete Fourier transform.
Chris@42 241 This manual documents FFTW version @value{VERSION}.
Chris@42 242 @end ifnottex
Chris@42 243
Chris@42 244 @menu
Chris@42 245 * Introduction::
Chris@42 246 * Tutorial::
Chris@42 247 * Other Important Topics::
Chris@42 248 * FFTW Reference::
Chris@42 249 * Multi-threaded FFTW::
Chris@42 250 * Distributed-memory FFTW with MPI::
Chris@42 251 * Calling FFTW from Modern Fortran::
Chris@42 252 * Calling FFTW from Legacy Fortran::
Chris@42 253 * Upgrading from FFTW version 2::
Chris@42 254 * Installation and Customization::
Chris@42 255 * Acknowledgments::
Chris@42 256 * License and Copyright::
Chris@42 257 * Concept Index::
Chris@42 258 * Library Index::
Chris@42 259 @end menu
Chris@42 260
Chris@42 261 @c ************************************************************
Chris@42 262 @include intro.texi
Chris@42 263 @include tutorial.texi
Chris@42 264 @include other.texi
Chris@42 265 @include reference.texi
Chris@42 266 @include threads.texi
Chris@42 267 @include mpi.texi
Chris@42 268 @include modern-fortran.texi
Chris@42 269 @include legacy-fortran.texi
Chris@42 270 @include upgrading.texi
Chris@42 271 @include install.texi
Chris@42 272 @include acknowledgements.texi
Chris@42 273 @include license.texi
Chris@42 274 @include cindex.texi
Chris@42 275 @include findex.texi
Chris@42 276 @c ************************************************************
Chris@42 277
Chris@42 278 @bye