Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.5/doc/html/Guru-vector-and-transform-sizes.html @ 83:ae30d91d2ffe

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 2cd0e3b3e1fd
children
rev   line source
Chris@42 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
Chris@42 2 <html>
Chris@42 3 <!-- This manual is for FFTW
Chris@42 4 (version 3.3.5, 30 July 2016).
Chris@42 5
Chris@42 6 Copyright (C) 2003 Matteo Frigo.
Chris@42 7
Chris@42 8 Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@42 9
Chris@42 10 Permission is granted to make and distribute verbatim copies of this
Chris@42 11 manual provided the copyright notice and this permission notice are
Chris@42 12 preserved on all copies.
Chris@42 13
Chris@42 14 Permission is granted to copy and distribute modified versions of this
Chris@42 15 manual under the conditions for verbatim copying, provided that the
Chris@42 16 entire resulting derived work is distributed under the terms of a
Chris@42 17 permission notice identical to this one.
Chris@42 18
Chris@42 19 Permission is granted to copy and distribute translations of this manual
Chris@42 20 into another language, under the above conditions for modified versions,
Chris@42 21 except that this permission notice may be stated in a translation
Chris@42 22 approved by the Free Software Foundation. -->
Chris@42 23 <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
Chris@42 24 <head>
Chris@42 25 <title>FFTW 3.3.5: Guru vector and transform sizes</title>
Chris@42 26
Chris@42 27 <meta name="description" content="FFTW 3.3.5: Guru vector and transform sizes">
Chris@42 28 <meta name="keywords" content="FFTW 3.3.5: Guru vector and transform sizes">
Chris@42 29 <meta name="resource-type" content="document">
Chris@42 30 <meta name="distribution" content="global">
Chris@42 31 <meta name="Generator" content="makeinfo">
Chris@42 32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Chris@42 33 <link href="index.html#Top" rel="start" title="Top">
Chris@42 34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
Chris@42 35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
Chris@42 36 <link href="Guru-Interface.html#Guru-Interface" rel="up" title="Guru Interface">
Chris@42 37 <link href="Guru-Complex-DFTs.html#Guru-Complex-DFTs" rel="next" title="Guru Complex DFTs">
Chris@42 38 <link href="Interleaved-and-split-arrays.html#Interleaved-and-split-arrays" rel="prev" title="Interleaved and split arrays">
Chris@42 39 <style type="text/css">
Chris@42 40 <!--
Chris@42 41 a.summary-letter {text-decoration: none}
Chris@42 42 blockquote.smallquotation {font-size: smaller}
Chris@42 43 div.display {margin-left: 3.2em}
Chris@42 44 div.example {margin-left: 3.2em}
Chris@42 45 div.indentedblock {margin-left: 3.2em}
Chris@42 46 div.lisp {margin-left: 3.2em}
Chris@42 47 div.smalldisplay {margin-left: 3.2em}
Chris@42 48 div.smallexample {margin-left: 3.2em}
Chris@42 49 div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
Chris@42 50 div.smalllisp {margin-left: 3.2em}
Chris@42 51 kbd {font-style:oblique}
Chris@42 52 pre.display {font-family: inherit}
Chris@42 53 pre.format {font-family: inherit}
Chris@42 54 pre.menu-comment {font-family: serif}
Chris@42 55 pre.menu-preformatted {font-family: serif}
Chris@42 56 pre.smalldisplay {font-family: inherit; font-size: smaller}
Chris@42 57 pre.smallexample {font-size: smaller}
Chris@42 58 pre.smallformat {font-family: inherit; font-size: smaller}
Chris@42 59 pre.smalllisp {font-size: smaller}
Chris@42 60 span.nocodebreak {white-space:nowrap}
Chris@42 61 span.nolinebreak {white-space:nowrap}
Chris@42 62 span.roman {font-family:serif; font-weight:normal}
Chris@42 63 span.sansserif {font-family:sans-serif; font-weight:normal}
Chris@42 64 ul.no-bullet {list-style: none}
Chris@42 65 -->
Chris@42 66 </style>
Chris@42 67
Chris@42 68
Chris@42 69 </head>
Chris@42 70
Chris@42 71 <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
Chris@42 72 <a name="Guru-vector-and-transform-sizes"></a>
Chris@42 73 <div class="header">
Chris@42 74 <p>
Chris@42 75 Next: <a href="Guru-Complex-DFTs.html#Guru-Complex-DFTs" accesskey="n" rel="next">Guru Complex DFTs</a>, Previous: <a href="Interleaved-and-split-arrays.html#Interleaved-and-split-arrays" accesskey="p" rel="prev">Interleaved and split arrays</a>, Up: <a href="Guru-Interface.html#Guru-Interface" accesskey="u" rel="up">Guru Interface</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
Chris@42 76 </div>
Chris@42 77 <hr>
Chris@42 78 <a name="Guru-vector-and-transform-sizes-1"></a>
Chris@42 79 <h4 class="subsection">4.5.2 Guru vector and transform sizes</h4>
Chris@42 80
Chris@42 81 <p>The guru interface introduces one basic new data structure,
Chris@42 82 <code>fftw_iodim</code>, that is used to specify sizes and strides for
Chris@42 83 multi-dimensional transforms and vectors:
Chris@42 84 </p>
Chris@42 85 <div class="example">
Chris@42 86 <pre class="example">typedef struct {
Chris@42 87 int n;
Chris@42 88 int is;
Chris@42 89 int os;
Chris@42 90 } fftw_iodim;
Chris@42 91 </pre></div>
Chris@42 92 <a name="index-fftw_005fiodim"></a>
Chris@42 93
Chris@42 94 <p>Here, <code>n</code> is the size of the dimension, and <code>is</code> and <code>os</code>
Chris@42 95 are the strides of that dimension for the input and output arrays. (The
Chris@42 96 stride is the separation of consecutive elements along this dimension.)
Chris@42 97 </p>
Chris@42 98 <p>The meaning of the stride parameter depends on the type of the array
Chris@42 99 that the stride refers to. <em>If the array is interleaved complex,
Chris@42 100 strides are expressed in units of complex numbers
Chris@42 101 (<code>fftw_complex</code>). If the array is split complex or real, strides
Chris@42 102 are expressed in units of real numbers (<code>double</code>).</em> This
Chris@42 103 convention is consistent with the usual pointer arithmetic in the C
Chris@42 104 language. An interleaved array is denoted by a pointer <code>p</code> to
Chris@42 105 <code>fftw_complex</code>, so that <code>p+1</code> points to the next complex
Chris@42 106 number. Split arrays are denoted by pointers to <code>double</code>, in
Chris@42 107 which case pointer arithmetic operates in units of
Chris@42 108 <code>sizeof(double)</code>.
Chris@42 109 <a name="index-stride-2"></a>
Chris@42 110 </p>
Chris@42 111
Chris@42 112 <p>The guru planner interfaces all take a (<code>rank</code>, <code>dims[rank]</code>)
Chris@42 113 pair describing the transform size, and a (<code>howmany_rank</code>,
Chris@42 114 <code>howmany_dims[howmany_rank]</code>) pair describing the &ldquo;vector&rdquo; size (a
Chris@42 115 multi-dimensional loop of transforms to perform), where <code>dims</code> and
Chris@42 116 <code>howmany_dims</code> are arrays of <code>fftw_iodim</code>.
Chris@42 117 </p>
Chris@42 118 <p>For example, the <code>howmany</code> parameter in the advanced complex-DFT
Chris@42 119 interface corresponds to <code>howmany_rank</code> = 1,
Chris@42 120 <code>howmany_dims[0].n</code> = <code>howmany</code>, <code>howmany_dims[0].is</code> =
Chris@42 121 <code>idist</code>, and <code>howmany_dims[0].os</code> = <code>odist</code>.
Chris@42 122 <a name="index-howmany-loop"></a>
Chris@42 123 <a name="index-dist-1"></a>
Chris@42 124 (To compute a single transform, you can just use <code>howmany_rank</code> = 0.)
Chris@42 125 </p>
Chris@42 126
Chris@42 127 <p>A row-major multidimensional array with dimensions <code>n[rank]</code>
Chris@42 128 (see <a href="Row_002dmajor-Format.html#Row_002dmajor-Format">Row-major Format</a>) corresponds to <code>dims[i].n</code> =
Chris@42 129 <code>n[i]</code> and the recurrence <code>dims[i].is</code> = <code>n[i+1] *
Chris@42 130 dims[i+1].is</code> (similarly for <code>os</code>). The stride of the last
Chris@42 131 (<code>i=rank-1</code>) dimension is the overall stride of the array.
Chris@42 132 e.g. to be equivalent to the advanced complex-DFT interface, you would
Chris@42 133 have <code>dims[rank-1].is</code> = <code>istride</code> and
Chris@42 134 <code>dims[rank-1].os</code> = <code>ostride</code>.
Chris@42 135 <a name="index-row_002dmajor-3"></a>
Chris@42 136 </p>
Chris@42 137
Chris@42 138 <p>In general, we only guarantee FFTW to return a non-<code>NULL</code> plan if
Chris@42 139 the vector and transform dimensions correspond to a set of distinct
Chris@42 140 indices, and for in-place transforms the input/output strides should
Chris@42 141 be the same.
Chris@42 142 </p>
Chris@42 143 <hr>
Chris@42 144 <div class="header">
Chris@42 145 <p>
Chris@42 146 Next: <a href="Guru-Complex-DFTs.html#Guru-Complex-DFTs" accesskey="n" rel="next">Guru Complex DFTs</a>, Previous: <a href="Interleaved-and-split-arrays.html#Interleaved-and-split-arrays" accesskey="p" rel="prev">Interleaved and split arrays</a>, Up: <a href="Guru-Interface.html#Guru-Interface" accesskey="u" rel="up">Guru Interface</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
Chris@42 147 </div>
Chris@42 148
Chris@42 149
Chris@42 150
Chris@42 151 </body>
Chris@42 152 </html>