comparison src/fftw-3.3.3/doc/fftw3.texi @ 95:89f5e221ed7b

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