annotate Lib/fftw-3.2.1/doc/html/.svn/text-base/Complex-numbers.html.svn-base @ 13:a64055168b9b

Added XML Support
author Geogaddi\David <d.m.ronan@qmul.ac.uk>
date Fri, 05 Feb 2016 19:21:42 +0000
parents 25bf17994ef1
children
rev   line source
d@0 1 <html lang="en">
d@0 2 <head>
d@0 3 <title>Complex numbers - FFTW 3.2.1</title>
d@0 4 <meta http-equiv="Content-Type" content="text/html">
d@0 5 <meta name="description" content="FFTW 3.2.1">
d@0 6 <meta name="generator" content="makeinfo 4.8">
d@0 7 <link title="Top" rel="start" href="index.html#Top">
d@0 8 <link rel="up" href="Data-Types-and-Files.html#Data-Types-and-Files" title="Data Types and Files">
d@0 9 <link rel="prev" href="Data-Types-and-Files.html#Data-Types-and-Files" title="Data Types and Files">
d@0 10 <link rel="next" href="Precision.html#Precision" title="Precision">
d@0 11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
d@0 12 <!--
d@0 13 This manual is for FFTW
d@0 14 (version 3.2.1, 5 February 2009).
d@0 15
d@0 16 Copyright (C) 2003 Matteo Frigo.
d@0 17
d@0 18 Copyright (C) 2003 Massachusetts Institute of Technology.
d@0 19
d@0 20 Permission is granted to make and distribute verbatim copies of
d@0 21 this manual provided the copyright notice and this permission
d@0 22 notice are preserved on all copies.
d@0 23
d@0 24 Permission is granted to copy and distribute modified versions of
d@0 25 this manual under the conditions for verbatim copying, provided
d@0 26 that the entire resulting derived work is distributed under the
d@0 27 terms of a permission notice identical to this one.
d@0 28
d@0 29 Permission is granted to copy and distribute translations of this
d@0 30 manual into another language, under the above conditions for
d@0 31 modified versions, except that this permission notice may be
d@0 32 stated in a translation approved by the Free Software Foundation.
d@0 33 -->
d@0 34 <meta http-equiv="Content-Style-Type" content="text/css">
d@0 35 <style type="text/css"><!--
d@0 36 pre.display { font-family:inherit }
d@0 37 pre.format { font-family:inherit }
d@0 38 pre.smalldisplay { font-family:inherit; font-size:smaller }
d@0 39 pre.smallformat { font-family:inherit; font-size:smaller }
d@0 40 pre.smallexample { font-size:smaller }
d@0 41 pre.smalllisp { font-size:smaller }
d@0 42 span.sc { font-variant:small-caps }
d@0 43 span.roman { font-family:serif; font-weight:normal; }
d@0 44 span.sansserif { font-family:sans-serif; font-weight:normal; }
d@0 45 --></style>
d@0 46 </head>
d@0 47 <body>
d@0 48 <div class="node">
d@0 49 <p>
d@0 50 <a name="Complex-numbers"></a>
d@0 51 Next:&nbsp;<a rel="next" accesskey="n" href="Precision.html#Precision">Precision</a>,
d@0 52 Previous:&nbsp;<a rel="previous" accesskey="p" href="Data-Types-and-Files.html#Data-Types-and-Files">Data Types and Files</a>,
d@0 53 Up:&nbsp;<a rel="up" accesskey="u" href="Data-Types-and-Files.html#Data-Types-and-Files">Data Types and Files</a>
d@0 54 <hr>
d@0 55 </div>
d@0 56
d@0 57 <h4 class="subsection">4.1.1 Complex numbers</h4>
d@0 58
d@0 59 <p>The default FFTW interface uses <code>double</code> precision for all
d@0 60 floating-point numbers, and defines a <code>fftw_complex</code> type to hold
d@0 61 complex numbers as:
d@0 62
d@0 63 <pre class="example"> typedef double fftw_complex[2];
d@0 64 </pre>
d@0 65 <p><a name="index-fftw_005fcomplex-136"></a>
d@0 66 Here, the <code>[0]</code> element holds the real part and the <code>[1]</code>
d@0 67 element holds the imaginary part.
d@0 68
d@0 69 <p>Alternatively, if you have a C compiler (such as <code>gcc</code>) that
d@0 70 supports the C99 revision of the ANSI C standard, you can use C's new
d@0 71 native complex type (which is binary-compatible with the typedef above).
d@0 72 In particular, if you <code>#include &lt;complex.h&gt;</code> <em>before</em>
d@0 73 <code>&lt;fftw3.h&gt;</code>, then <code>fftw_complex</code> is defined to be the native
d@0 74 complex type and you can manipulate it with ordinary arithmetic
d@0 75 (e.g. <code>x = y * (3+4*I)</code>, where <code>x</code> and <code>y</code> are
d@0 76 <code>fftw_complex</code> and <code>I</code> is the standard symbol for the
d@0 77 imaginary unit);
d@0 78 <a name="index-C99-137"></a>
d@0 79 C++ has its own <code>complex&lt;T&gt;</code> template class, defined in the
d@0 80 standard <code>&lt;complex&gt;</code> header file. Reportedly, the C++ standards
d@0 81 committee has recently agreed to mandate that the storage format used
d@0 82 for this type be binary-compatible with the C99 type, i.e. an array
d@0 83 <code>T[2]</code> with consecutive real <code>[0]</code> and imaginary <code>[1]</code>
d@0 84 parts. (See report
d@0 85 <a href="http://anubis.dkuug.dk/JTC1/SC22/WG21/docs/papers/2002/1388.pdf">WG21/N1388</a>.) Although not part of the official standard as of this
d@0 86 writing, the proposal stated that: &ldquo;This solution has been tested with
d@0 87 all current major implementations of the standard library and shown to
d@0 88 be working.&rdquo; To the extent that this is true, if you have a variable
d@0 89 <code>complex&lt;double&gt; *x</code>, you can pass it directly to FFTW via
d@0 90 <code>reinterpret_cast&lt;fftw_complex*&gt;(x)</code>.
d@0 91 <a name="index-C_002b_002b-138"></a><a name="index-portability-139"></a>
d@0 92 <!-- =========> -->
d@0 93
d@0 94 </body></html>
d@0 95