annotate src/fftw-3.3.3/doc/fftw3.texi @ 83:ae30d91d2ffe

Replace these with versions built using an older toolset (so as to avoid ABI compatibilities when linking on Ubuntu 14.04 for packaging purposes)
author Chris Cannam
date Fri, 07 Feb 2020 11:51:13 +0000
parents 37bf6b4a2645
children
rev   line source
Chris@10 1 \input texinfo @c -*-texinfo-*-
Chris@10 2 @c Update by C-x C-e on: (texinfo-multiple-files-update "fftw3.texi" nil t)
Chris@10 3 @setfilename fftw3.info
Chris@10 4 @include version.texi
Chris@10 5 @settitle FFTW @value{VERSION}
Chris@10 6 @setchapternewpage odd
Chris@10 7 @c define constant index (ct)
Chris@10 8 @defcodeindex ct
Chris@10 9 @syncodeindex ct fn
Chris@10 10 @syncodeindex vr fn
Chris@10 11 @syncodeindex pg fn
Chris@10 12 @syncodeindex tp fn
Chris@10 13 @c define foreign function index (ff)
Chris@10 14 @defcodeindex ff
Chris@10 15 @syncodeindex ff cp
Chris@10 16 @c define foreign constant index (fc)
Chris@10 17 @defcodeindex fc
Chris@10 18 @syncodeindex fc cp
Chris@10 19 @c define foreign program index (fp)
Chris@10 20 @defcodeindex fp
Chris@10 21 @syncodeindex fp cp
Chris@10 22 @comment %**end of header
Chris@10 23
Chris@10 24 @iftex
Chris@10 25 @paragraphindent 0
Chris@10 26 @parskip=@medskipamount
Chris@10 27 @end iftex
Chris@10 28
Chris@10 29 @macro Onlogn
Chris@10 30 @ifinfo
Chris@10 31 O(n log n)
Chris@10 32 @end ifinfo
Chris@10 33 @html
Chris@10 34 <i>O</i>(<i>n</i>&nbsp;log&nbsp;<i>n</i>)
Chris@10 35 @end html
Chris@10 36 @tex
Chris@10 37 $O(n \\log n)$
Chris@10 38 @end tex
Chris@10 39 @end macro
Chris@10 40
Chris@10 41 @macro ndims
Chris@10 42 @ifinfo
Chris@10 43 n[0] x n[1] x n[2] x ... x n[d-1]
Chris@10 44 @end ifinfo
Chris@10 45 @html
Chris@10 46 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@10 47 @end html
Chris@10 48 @tex
Chris@10 49 $n_0 \\times n_1 \\times n_2 \\times \\cdots \\times n_{d-1}$
Chris@10 50 @end tex
Chris@10 51 @end macro
Chris@10 52
Chris@10 53 @macro ndimshalf
Chris@10 54 @ifinfo
Chris@10 55 n[0] x n[1] x n[2] x ... x (n[d-1]/2 + 1)
Chris@10 56 @end ifinfo
Chris@10 57 @html
Chris@10 58 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@10 59 @end html
Chris@10 60 @tex
Chris@10 61 $n_0 \\times n_1 \\times n_2 \\times \\cdots \\times (n_{d-1}/2 + 1)$
Chris@10 62 @end tex
Chris@10 63 @end macro
Chris@10 64
Chris@10 65 @macro ndimspad
Chris@10 66 @ifinfo
Chris@10 67 n[0] x n[1] x n[2] x ... x [2 (n[d-1]/2 + 1)]
Chris@10 68 @end ifinfo
Chris@10 69 @html
Chris@10 70 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@10 71 @end html
Chris@10 72 @tex
Chris@10 73 $n_0 \\times n_1 \\times n_2 \\times \\cdots \\times [2(n_{d-1}/2 + 1)]$
Chris@10 74 @end tex
Chris@10 75 @end macro
Chris@10 76
Chris@10 77 @macro twodims{d1, d2}
Chris@10 78 @ifinfo
Chris@10 79 \d1\ x \d2\
Chris@10 80 @end ifinfo
Chris@10 81 @html
Chris@10 82 \d1\&nbsp;&times;&nbsp;\d2\
Chris@10 83 @end html
Chris@10 84 @tex
Chris@10 85 $\d1\ \\times \d2\$
Chris@10 86 @end tex
Chris@10 87 @end macro
Chris@10 88
Chris@10 89 @macro threedims{d1, d2, d3}
Chris@10 90 @ifinfo
Chris@10 91 \d1\ x \d2\ x \d3\
Chris@10 92 @end ifinfo
Chris@10 93 @html
Chris@10 94 \d1\&nbsp;&times;&nbsp;\d2\&nbsp;&times;&nbsp;\d3\
Chris@10 95 @end html
Chris@10 96 @tex
Chris@10 97 $\d1\ \\times \d2\ \\times \d3\$
Chris@10 98 @end tex
Chris@10 99 @end macro
Chris@10 100
Chris@10 101 @macro dimk{k}
Chris@10 102 @ifinfo
Chris@10 103 n[\k\]
Chris@10 104 @end ifinfo
Chris@10 105 @html
Chris@10 106 n<sub>\k\</sub>
Chris@10 107 @end html
Chris@10 108 @tex
Chris@10 109 $n_\k\$
Chris@10 110 @end tex
Chris@10 111 @end macro
Chris@10 112
Chris@10 113
Chris@10 114 @macro ndimstrans
Chris@10 115 @ifinfo
Chris@10 116 n[1] x n[0] x n[2] x ... x n[d-1]
Chris@10 117 @end ifinfo
Chris@10 118 @html
Chris@10 119 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@10 120 @end html
Chris@10 121 @tex
Chris@10 122 $n_1 \\times n_0 \\times n_2 \\times \\cdots \\times n_{d-1}$
Chris@10 123 @end tex
Chris@10 124 @end macro
Chris@10 125
Chris@10 126 @copying
Chris@10 127 This manual is for FFTW
Chris@10 128 (version @value{VERSION}, @value{UPDATED}).
Chris@10 129
Chris@10 130 Copyright @copyright{} 2003 Matteo Frigo.
Chris@10 131
Chris@10 132 Copyright @copyright{} 2003 Massachusetts Institute of Technology.
Chris@10 133
Chris@10 134 @quotation
Chris@10 135 Permission is granted to make and distribute verbatim copies of this
Chris@10 136 manual provided the copyright notice and this permission notice are
Chris@10 137 preserved on all copies.
Chris@10 138
Chris@10 139 Permission is granted to copy and distribute modified versions of this
Chris@10 140 manual under the conditions for verbatim copying, provided that the
Chris@10 141 entire resulting derived work is distributed under the terms of a
Chris@10 142 permission notice identical to this one.
Chris@10 143
Chris@10 144 Permission is granted to copy and distribute translations of this manual
Chris@10 145 into another language, under the above conditions for modified versions,
Chris@10 146 except that this permission notice may be stated in a translation
Chris@10 147 approved by the Free Software Foundation.
Chris@10 148 @end quotation
Chris@10 149 @end copying
Chris@10 150
Chris@10 151 @dircategory Texinfo documentation system
Chris@10 152 @direntry
Chris@10 153 * fftw3: (fftw3). FFTW User's Manual.
Chris@10 154 @end direntry
Chris@10 155
Chris@10 156 @titlepage
Chris@10 157 @title FFTW
Chris@10 158 @subtitle for version @value{VERSION}, @value{UPDATED}
Chris@10 159 @author{Matteo Frigo}
Chris@10 160 @author{Steven G. Johnson}
Chris@10 161 @page
Chris@10 162 @vskip 0pt plus 1filll
Chris@10 163 @insertcopying
Chris@10 164 @end titlepage
Chris@10 165
Chris@10 166 @contents
Chris@10 167
Chris@10 168 @ifnottex
Chris@10 169 @node Top, Introduction, (dir), (dir)
Chris@10 170 @top FFTW User Manual
Chris@10 171 Welcome to FFTW, the Fastest Fourier Transform in the West. FFTW is a
Chris@10 172 collection of fast C routines to compute the discrete Fourier transform.
Chris@10 173 This manual documents FFTW version @value{VERSION}.
Chris@10 174 @end ifnottex
Chris@10 175
Chris@10 176 @menu
Chris@10 177 * Introduction::
Chris@10 178 * Tutorial::
Chris@10 179 * Other Important Topics::
Chris@10 180 * FFTW Reference::
Chris@10 181 * Multi-threaded FFTW::
Chris@10 182 * Distributed-memory FFTW with MPI::
Chris@10 183 * Calling FFTW from Modern Fortran::
Chris@10 184 * Calling FFTW from Legacy Fortran::
Chris@10 185 * Upgrading from FFTW version 2::
Chris@10 186 * Installation and Customization::
Chris@10 187 * Acknowledgments::
Chris@10 188 * License and Copyright::
Chris@10 189 * Concept Index::
Chris@10 190 * Library Index::
Chris@10 191 @end menu
Chris@10 192
Chris@10 193 @c ************************************************************
Chris@10 194 @include intro.texi
Chris@10 195 @include tutorial.texi
Chris@10 196 @include other.texi
Chris@10 197 @include reference.texi
Chris@10 198 @include threads.texi
Chris@10 199 @include mpi.texi
Chris@10 200 @include modern-fortran.texi
Chris@10 201 @include legacy-fortran.texi
Chris@10 202 @include upgrading.texi
Chris@10 203 @include install.texi
Chris@10 204 @include acknowledgements.texi
Chris@10 205 @include license.texi
Chris@10 206 @include cindex.texi
Chris@10 207 @include findex.texi
Chris@10 208 @c ************************************************************
Chris@10 209
Chris@10 210 @bye