annotate src/fftw-3.3.3/doc/html/64_002dbit-Guru-Interface.html @ 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 <html lang="en">
Chris@10 2 <head>
Chris@10 3 <title>64-bit Guru Interface - FFTW 3.3.3</title>
Chris@10 4 <meta http-equiv="Content-Type" content="text/html">
Chris@10 5 <meta name="description" content="FFTW 3.3.3">
Chris@10 6 <meta name="generator" content="makeinfo 4.13">
Chris@10 7 <link title="Top" rel="start" href="index.html#Top">
Chris@10 8 <link rel="up" href="Guru-Interface.html#Guru-Interface" title="Guru Interface">
Chris@10 9 <link rel="prev" href="Guru-Real_002dto_002dreal-Transforms.html#Guru-Real_002dto_002dreal-Transforms" title="Guru Real-to-real Transforms">
Chris@10 10 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
Chris@10 11 <!--
Chris@10 12 This manual is for FFTW
Chris@10 13 (version 3.3.3, 25 November 2012).
Chris@10 14
Chris@10 15 Copyright (C) 2003 Matteo Frigo.
Chris@10 16
Chris@10 17 Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@10 18
Chris@10 19 Permission is granted to make and distribute verbatim copies of
Chris@10 20 this manual provided the copyright notice and this permission
Chris@10 21 notice are preserved on all copies.
Chris@10 22
Chris@10 23 Permission is granted to copy and distribute modified versions of
Chris@10 24 this manual under the conditions for verbatim copying, provided
Chris@10 25 that the entire resulting derived work is distributed under the
Chris@10 26 terms of a permission notice identical to this one.
Chris@10 27
Chris@10 28 Permission is granted to copy and distribute translations of this
Chris@10 29 manual into another language, under the above conditions for
Chris@10 30 modified versions, except that this permission notice may be
Chris@10 31 stated in a translation approved by the Free Software Foundation.
Chris@10 32 -->
Chris@10 33 <meta http-equiv="Content-Style-Type" content="text/css">
Chris@10 34 <style type="text/css"><!--
Chris@10 35 pre.display { font-family:inherit }
Chris@10 36 pre.format { font-family:inherit }
Chris@10 37 pre.smalldisplay { font-family:inherit; font-size:smaller }
Chris@10 38 pre.smallformat { font-family:inherit; font-size:smaller }
Chris@10 39 pre.smallexample { font-size:smaller }
Chris@10 40 pre.smalllisp { font-size:smaller }
Chris@10 41 span.sc { font-variant:small-caps }
Chris@10 42 span.roman { font-family:serif; font-weight:normal; }
Chris@10 43 span.sansserif { font-family:sans-serif; font-weight:normal; }
Chris@10 44 --></style>
Chris@10 45 </head>
Chris@10 46 <body>
Chris@10 47 <div class="node">
Chris@10 48 <a name="64-bit-Guru-Interface"></a>
Chris@10 49 <a name="g_t64_002dbit-Guru-Interface"></a>
Chris@10 50 <p>
Chris@10 51 Previous:&nbsp;<a rel="previous" accesskey="p" href="Guru-Real_002dto_002dreal-Transforms.html#Guru-Real_002dto_002dreal-Transforms">Guru Real-to-real Transforms</a>,
Chris@10 52 Up:&nbsp;<a rel="up" accesskey="u" href="Guru-Interface.html#Guru-Interface">Guru Interface</a>
Chris@10 53 <hr>
Chris@10 54 </div>
Chris@10 55
Chris@10 56 <h4 class="subsection">4.5.6 64-bit Guru Interface</h4>
Chris@10 57
Chris@10 58 <p><a name="index-g_t64_002dbit-architecture-260"></a>
Chris@10 59 When compiled in 64-bit mode on a 64-bit architecture (where addresses
Chris@10 60 are 64 bits wide), FFTW uses 64-bit quantities internally for all
Chris@10 61 transform sizes, strides, and so on&mdash;you don't have to do anything
Chris@10 62 special to exploit this. However, in the ordinary FFTW interfaces,
Chris@10 63 you specify the transform size by an <code>int</code> quantity, which is
Chris@10 64 normally only 32 bits wide. This means that, even though FFTW is
Chris@10 65 using 64-bit sizes internally, you cannot specify a single transform
Chris@10 66 dimension larger than
Chris@10 67 2<sup><small>31</small></sup>&minus;1numbers.
Chris@10 68
Chris@10 69 <p>We expect that few users will require transforms larger than this, but,
Chris@10 70 for those who do, we provide a 64-bit version of the guru interface in
Chris@10 71 which all sizes are specified as integers of type <code>ptrdiff_t</code>
Chris@10 72 instead of <code>int</code>. (<code>ptrdiff_t</code> is a signed integer type
Chris@10 73 defined by the C standard to be wide enough to represent address
Chris@10 74 differences, and thus must be at least 64 bits wide on a 64-bit
Chris@10 75 machine.) We stress that there is <em>no performance advantage</em> to
Chris@10 76 using this interface&mdash;the same internal FFTW code is employed
Chris@10 77 regardless&mdash;and it is only necessary if you want to specify very
Chris@10 78 large transform sizes.
Chris@10 79 <a name="index-ptrdiff_005ft-261"></a>
Chris@10 80
Chris@10 81 <p>In particular, the 64-bit guru interface is a set of planner routines
Chris@10 82 that are exactly the same as the guru planner routines, except that
Chris@10 83 they are named with &lsquo;<samp><span class="samp">guru64</span></samp>&rsquo; instead of &lsquo;<samp><span class="samp">guru</span></samp>&rsquo; and they take
Chris@10 84 arguments of type <code>fftw_iodim64</code> instead of <code>fftw_iodim</code>.
Chris@10 85 For example, instead of <code>fftw_plan_guru_dft</code>, we have
Chris@10 86 <code>fftw_plan_guru64_dft</code>.
Chris@10 87
Chris@10 88 <pre class="example"> fftw_plan fftw_plan_guru64_dft(
Chris@10 89 int rank, const fftw_iodim64 *dims,
Chris@10 90 int howmany_rank, const fftw_iodim64 *howmany_dims,
Chris@10 91 fftw_complex *in, fftw_complex *out,
Chris@10 92 int sign, unsigned flags);
Chris@10 93 </pre>
Chris@10 94 <p><a name="index-fftw_005fplan_005fguru64_005fdft-262"></a>
Chris@10 95 The <code>fftw_iodim64</code> type is similar to <code>fftw_iodim</code>, with the
Chris@10 96 same interpretation, except that it uses type <code>ptrdiff_t</code> instead
Chris@10 97 of type <code>int</code>.
Chris@10 98
Chris@10 99 <pre class="example"> typedef struct {
Chris@10 100 ptrdiff_t n;
Chris@10 101 ptrdiff_t is;
Chris@10 102 ptrdiff_t os;
Chris@10 103 } fftw_iodim64;
Chris@10 104 </pre>
Chris@10 105 <p><a name="index-fftw_005fiodim64-263"></a>
Chris@10 106 Every other &lsquo;<samp><span class="samp">fftw_plan_guru</span></samp>&rsquo; function also has a
Chris@10 107 &lsquo;<samp><span class="samp">fftw_plan_guru64</span></samp>&rsquo; equivalent, but we do not repeat their
Chris@10 108 documentation here since they are identical to the 32-bit versions
Chris@10 109 except as noted above.
Chris@10 110
Chris@10 111 <!-- -->
Chris@10 112 </body></html>
Chris@10 113