Mercurial > hg > sv-dependency-builds

comparison src/fftw-3.3.8/doc/html/Guru-vector-and-transform-sizes.html @ 82:d0c2a83c1364

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