diff src/fftw-3.3.3/doc/fftw3.texi @ 10:37bf6b4a2645

Add FFTW3
author Chris Cannam
date Wed, 20 Mar 2013 15:35:50 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/fftw-3.3.3/doc/fftw3.texi	Wed Mar 20 15:35:50 2013 +0000
@@ -0,0 +1,210 @@
+\input texinfo    @c -*-texinfo-*-
+@c Update by C-x C-e on: (texinfo-multiple-files-update "fftw3.texi" nil t)
+@setfilename fftw3.info
+@include version.texi
+@settitle FFTW @value{VERSION}
+@setchapternewpage odd
+@c define constant index (ct)
+@defcodeindex ct
+@syncodeindex ct fn
+@syncodeindex vr fn
+@syncodeindex pg fn
+@syncodeindex tp fn
+@c define foreign function index (ff)
+@defcodeindex ff
+@syncodeindex ff cp
+@c define foreign constant index (fc)
+@defcodeindex fc
+@syncodeindex fc cp
+@c define foreign program index (fp)
+@defcodeindex fp
+@syncodeindex fp cp
+@comment %**end of header
+
+@iftex
+@paragraphindent 0
+@parskip=@medskipamount
+@end iftex
+
+@macro Onlogn
+@ifinfo
+O(n log n)
+@end ifinfo
+@html
+<i>O</i>(<i>n</i>&nbsp;log&nbsp;<i>n</i>)
+@end html
+@tex
+$O(n \\log n)$
+@end tex
+@end macro
+
+@macro ndims
+@ifinfo
+n[0] x n[1] x n[2] x ... x n[d-1]
+@end ifinfo
+@html
+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>
+@end html
+@tex
+$n_0 \\times n_1 \\times n_2 \\times \\cdots \\times n_{d-1}$
+@end tex
+@end macro
+
+@macro ndimshalf
+@ifinfo
+n[0] x n[1] x n[2] x ... x (n[d-1]/2 + 1)
+@end ifinfo
+@html
+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)
+@end html
+@tex
+$n_0 \\times n_1 \\times n_2 \\times \\cdots \\times (n_{d-1}/2 + 1)$
+@end tex
+@end macro
+
+@macro ndimspad
+@ifinfo
+n[0] x n[1] x n[2] x ... x [2 (n[d-1]/2 + 1)]
+@end ifinfo
+@html
+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)]
+@end html
+@tex
+$n_0 \\times n_1 \\times n_2 \\times \\cdots \\times [2(n_{d-1}/2 + 1)]$
+@end tex
+@end macro
+
+@macro twodims{d1, d2}
+@ifinfo
+\d1\ x \d2\
+@end ifinfo
+@html
+\d1\&nbsp;&times;&nbsp;\d2\
+@end html
+@tex
+$\d1\ \\times \d2\$
+@end tex
+@end macro
+
+@macro threedims{d1, d2, d3}
+@ifinfo
+\d1\ x \d2\ x \d3\
+@end ifinfo
+@html
+\d1\&nbsp;&times;&nbsp;\d2\&nbsp;&times;&nbsp;\d3\
+@end html
+@tex
+$\d1\ \\times \d2\ \\times \d3\$
+@end tex
+@end macro
+
+@macro dimk{k}
+@ifinfo
+n[\k\]
+@end ifinfo
+@html
+n<sub>\k\</sub>
+@end html
+@tex
+$n_\k\$
+@end tex
+@end macro
+
+
+@macro ndimstrans
+@ifinfo
+n[1] x n[0] x n[2] x ... x n[d-1]
+@end ifinfo
+@html
+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>
+@end html
+@tex
+$n_1 \\times n_0 \\times n_2 \\times \\cdots \\times n_{d-1}$
+@end tex
+@end macro
+
+@copying
+This manual is for FFTW
+(version @value{VERSION}, @value{UPDATED}).
+
+Copyright @copyright{} 2003 Matteo Frigo.
+
+Copyright @copyright{} 2003 Massachusetts Institute of Technology.
+
+@quotation
+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.
+@end quotation
+@end copying
+
+@dircategory Texinfo documentation system
+@direntry
+* fftw3: (fftw3).	FFTW User's Manual.
+@end direntry
+
+@titlepage
+@title FFTW
+@subtitle for version @value{VERSION}, @value{UPDATED}
+@author{Matteo Frigo}
+@author{Steven G. Johnson}
+@page
+@vskip 0pt plus 1filll
+@insertcopying
+@end titlepage
+
+@contents
+
+@ifnottex
+@node Top, Introduction, (dir), (dir)
+@top FFTW User Manual
+Welcome to FFTW, the Fastest Fourier Transform in the West.  FFTW is a
+collection of fast C routines to compute the discrete Fourier transform.
+This manual documents FFTW version @value{VERSION}.
+@end ifnottex
+
+@menu
+* Introduction::                
+* Tutorial::                    
+* Other Important Topics::      
+* FFTW Reference::              
+* Multi-threaded FFTW::         
+* Distributed-memory FFTW with MPI::  
+* Calling FFTW from Modern Fortran::  
+* Calling FFTW from Legacy Fortran::  
+* Upgrading from FFTW version 2::  
+* Installation and Customization::  
+* Acknowledgments::             
+* License and Copyright::       
+* Concept Index::               
+* Library Index::               
+@end menu
+
+@c ************************************************************
+@include intro.texi
+@include tutorial.texi
+@include other.texi
+@include reference.texi
+@include threads.texi
+@include mpi.texi
+@include modern-fortran.texi
+@include legacy-fortran.texi
+@include upgrading.texi
+@include install.texi
+@include acknowledgements.texi
+@include license.texi
+@include cindex.texi
+@include findex.texi
+@c ************************************************************
+
+@bye