cannam@127: \input texinfo @c -*-texinfo-*- cannam@127: @c Update by C-x C-e on: (texinfo-multiple-files-update "fftw3.texi" nil t) cannam@127: @setfilename fftw3.info cannam@127: @include version.texi cannam@127: @settitle FFTW @value{VERSION} cannam@127: @setchapternewpage odd cannam@127: @c define constant index (ct) cannam@127: @defcodeindex ct cannam@127: @syncodeindex ct fn cannam@127: @syncodeindex vr fn cannam@127: @syncodeindex pg fn cannam@127: @syncodeindex tp fn cannam@127: @c define foreign function index (ff) cannam@127: @defcodeindex ff cannam@127: @syncodeindex ff cp cannam@127: @c define foreign constant index (fc) cannam@127: @defcodeindex fc cannam@127: @syncodeindex fc cp cannam@127: @c define foreign program index (fp) cannam@127: @defcodeindex fp cannam@127: @syncodeindex fp cp cannam@127: @comment %**end of header cannam@127: cannam@127: @iftex cannam@127: @paragraphindent 0 cannam@127: @parskip=@medskipamount cannam@127: @end iftex cannam@127: cannam@127: @c cannam@127: @c The following macros are coded in a weird way: cannam@127: cannam@127: @c @macro FOO cannam@127: @c @noindent cannam@127: @c cannam@127: @c @refill cannam@127: @c @end macro cannam@127: cannam@127: @c The @noindent/@refill stuff is not necessary in texinfo up to version cannam@127: @c 4, but it is a hack necessary to make texinfo-5 work. cannam@127: cannam@127: @c Texinfo has been stable for the first 15 years of FFTW's history. cannam@127: @c Then some genius, with too much time in his hands and on a mission to cannam@127: @c deliver the world from the evil of the C language, decided to rewrite cannam@127: @c makeinfo in Perl, the old C version of makeinfo being, as I said, cannam@127: @c evil. The official excuse for the rewrite was that now I can have my cannam@127: @c manual in XML format, as if XML were a feature. cannam@127: cannam@127: @c The result of this stroke of genius is that texinfo-5 has different cannam@127: @c rules for macro expansion than texinfo-4 does, specifically regarding cannam@127: @c whether or not spaces after a macro are ignored. Texinfo-4 had weird cannam@127: @c rules, but at least they were constant and internally more or less cannam@127: @c consistent. Texinfo-5 has different rules, and even worse the rules cannam@127: @c in texinfo-5 are inconsistent between the TeX and HTML output cannam@127: @c processors. This situation makes it almost impossible for us to cannam@127: @c produce a manual that works with both texinfo 4 and 5 in all modes cannam@127: @c (TeX, info, and html). The @noindent/@refill hack is my best shot at cannam@127: @c patching this situation. cannam@127: cannam@127: @c "@noindent" has two effects: First, it makes texinfo-5 believe that cannam@127: @c the next "@ifinfo" is on a new line, otherwise texinfo-5 complains cannam@127: @c that it is not (even though it obviously is). Second, "@noindent" is cannam@127: @c a macro that eats extra space, and we want this effect because somehow cannam@127: @c macro expansion in texinfo-5 inserts extra spaces that were not there cannam@127: @c in texinfo-4. cannam@127: cannam@127: @c "@refill" stops texinfo-5 from interpreting the rest of the line after cannam@127: @c a macro invocation as an argument to "@end tex". For example, in cannam@127: @c "FFTW uses @Onlogn algorithms", somehow texinfo-5 thinks that cannam@127: @c "algorithms" is an argument to "@end tex". "@noindent" would have the cannam@127: @c same effect (as would any other macro invocation, I think), but, cannam@127: @c unlike "@noindent", "@refill" does not eat spaces and does not scan cannam@127: @c the rest of the input file for macro arguments. However, "@refill" is cannam@127: @c deemed "obsolete" in the texinfo-5 source code, so expect this to cannam@127: @c break at some point. cannam@127: cannam@127: @c This situation is wholly unsatisfactory, and the GNU project is cannam@127: @c obviously out of control. If this nonsense persists, we will abandon cannam@127: @c texinfo and produce a latex-only version of the manual. cannam@127: cannam@127: cannam@127: @macro Onlogn cannam@127: @noindent cannam@127: @ifinfo cannam@127: O(n log n) cannam@127: @end ifinfo cannam@127: @html cannam@127: O(n log n) cannam@127: @end html cannam@127: @tex cannam@127: $O(n \\log n)$ cannam@127: @end tex cannam@127: @refill cannam@127: @end macro cannam@127: cannam@127: @macro ndims cannam@127: @noindent cannam@127: @ifinfo cannam@127: n[0] x n[1] x n[2] x ... x n[d-1] cannam@127: @end ifinfo cannam@127: @html cannam@127: n0 × n1 × n2 × … × nd-1 cannam@127: @end html cannam@127: @tex cannam@127: $n_0 \\times n_1 \\times n_2 \\times \\cdots \\times n_{d-1}$ cannam@127: @end tex cannam@127: @refill cannam@127: @end macro cannam@127: cannam@127: @macro ndimshalf cannam@127: @noindent cannam@127: @ifinfo cannam@127: n[0] x n[1] x n[2] x ... x (n[d-1]/2 + 1) cannam@127: @end ifinfo cannam@127: @html cannam@127: n0 × n1 × n2 × … × (nd-1/2 + 1) cannam@127: @end html cannam@127: @tex cannam@127: $n_0 \\times n_1 \\times n_2 \\times \\cdots \\times (n_{d-1}/2 + 1)$ cannam@127: @end tex cannam@127: @refill cannam@127: @end macro cannam@127: cannam@127: @macro ndimspad cannam@127: @noindent cannam@127: @ifinfo cannam@127: n[0] x n[1] x n[2] x ... x [2 (n[d-1]/2 + 1)] cannam@127: @end ifinfo cannam@127: @html cannam@127: n0 × n1 × n2 × … × [2 (nd-1/2 + 1)] cannam@127: @end html cannam@127: @tex cannam@127: $n_0 \\times n_1 \\times n_2 \\times \\cdots \\times [2(n_{d-1}/2 + 1)]$ cannam@127: @end tex cannam@127: @refill cannam@127: @end macro cannam@127: cannam@127: @macro twodims{d1, d2} cannam@127: @noindent cannam@127: @ifinfo cannam@127: \d1\ x \d2\ cannam@127: @end ifinfo cannam@127: @html cannam@127: \d1\ × \d2\ cannam@127: @end html cannam@127: @tex cannam@127: $\d1\ \\times \d2\$ cannam@127: @end tex cannam@127: @refill cannam@127: @end macro cannam@127: cannam@127: @macro threedims{d1, d2, d3} cannam@127: @noindent cannam@127: @ifinfo cannam@127: \d1\ x \d2\ x \d3\ cannam@127: @end ifinfo cannam@127: @html cannam@127: \d1\ × \d2\ × \d3\ cannam@127: @end html cannam@127: @tex cannam@127: $\d1\ \\times \d2\ \\times \d3\$ cannam@127: @end tex cannam@127: @refill cannam@127: @end macro cannam@127: cannam@127: @macro dimk{k} cannam@127: @noindent cannam@127: @ifinfo cannam@127: n[\k\] cannam@127: @end ifinfo cannam@127: @html cannam@127: n\k\ cannam@127: @end html cannam@127: @tex cannam@127: $n_\k\$ cannam@127: @end tex cannam@127: @refill cannam@127: @end macro cannam@127: cannam@127: cannam@127: @macro ndimstrans cannam@127: @noindent cannam@127: @ifinfo cannam@127: n[1] x n[0] x n[2] x ... x n[d-1] cannam@127: @end ifinfo cannam@127: @html cannam@127: n1 × n0 × n2 ×…× nd-1 cannam@127: @end html cannam@127: @tex cannam@127: $n_1 \\times n_0 \\times n_2 \\times \\cdots \\times n_{d-1}$ cannam@127: @end tex cannam@127: @refill cannam@127: @end macro cannam@127: cannam@127: @copying cannam@127: This manual is for FFTW cannam@127: (version @value{VERSION}, @value{UPDATED}). cannam@127: cannam@127: Copyright @copyright{} 2003 Matteo Frigo. cannam@127: cannam@127: Copyright @copyright{} 2003 Massachusetts Institute of Technology. cannam@127: cannam@127: @quotation cannam@127: Permission is granted to make and distribute verbatim copies of this cannam@127: manual provided the copyright notice and this permission notice are cannam@127: preserved on all copies. cannam@127: cannam@127: Permission is granted to copy and distribute modified versions of this cannam@127: manual under the conditions for verbatim copying, provided that the cannam@127: entire resulting derived work is distributed under the terms of a cannam@127: permission notice identical to this one. cannam@127: cannam@127: Permission is granted to copy and distribute translations of this manual cannam@127: into another language, under the above conditions for modified versions, cannam@127: except that this permission notice may be stated in a translation cannam@127: approved by the Free Software Foundation. cannam@127: @end quotation cannam@127: @end copying cannam@127: cannam@127: @dircategory Development cannam@127: @direntry cannam@127: * fftw3: (fftw3). FFTW User's Manual. cannam@127: @end direntry cannam@127: cannam@127: @titlepage cannam@127: @title FFTW cannam@127: @subtitle for version @value{VERSION}, @value{UPDATED} cannam@127: @author Matteo Frigo cannam@127: @author Steven G. Johnson cannam@127: @page cannam@127: @vskip 0pt plus 1filll cannam@127: @insertcopying cannam@127: @end titlepage cannam@127: cannam@127: @contents cannam@127: cannam@127: @ifnottex cannam@127: @node Top, Introduction, (dir), (dir) cannam@127: @top FFTW User Manual cannam@127: Welcome to FFTW, the Fastest Fourier Transform in the West. FFTW is a cannam@127: collection of fast C routines to compute the discrete Fourier transform. cannam@127: This manual documents FFTW version @value{VERSION}. cannam@127: @end ifnottex cannam@127: cannam@127: @menu cannam@127: * Introduction:: cannam@127: * Tutorial:: cannam@127: * Other Important Topics:: cannam@127: * FFTW Reference:: cannam@127: * Multi-threaded FFTW:: cannam@127: * Distributed-memory FFTW with MPI:: cannam@127: * Calling FFTW from Modern Fortran:: cannam@127: * Calling FFTW from Legacy Fortran:: cannam@127: * Upgrading from FFTW version 2:: cannam@127: * Installation and Customization:: cannam@127: * Acknowledgments:: cannam@127: * License and Copyright:: cannam@127: * Concept Index:: cannam@127: * Library Index:: cannam@127: @end menu cannam@127: cannam@127: @c ************************************************************ cannam@127: @include intro.texi cannam@127: @include tutorial.texi cannam@127: @include other.texi cannam@127: @include reference.texi cannam@127: @include threads.texi cannam@127: @include mpi.texi cannam@127: @include modern-fortran.texi cannam@127: @include legacy-fortran.texi cannam@127: @include upgrading.texi cannam@127: @include install.texi cannam@127: @include acknowledgements.texi cannam@127: @include license.texi cannam@127: @include cindex.texi cannam@127: @include findex.texi cannam@127: @c ************************************************************ cannam@127: cannam@127: @bye