|
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: Memory Allocation</title>
|
|
Chris@42
|
26
|
|
Chris@42
|
27 <meta name="description" content="FFTW 3.3.5: Memory Allocation">
|
|
Chris@42
|
28 <meta name="keywords" content="FFTW 3.3.5: Memory Allocation">
|
|
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="Data-Types-and-Files.html#Data-Types-and-Files" rel="up" title="Data Types and Files">
|
|
Chris@42
|
37 <link href="Using-Plans.html#Using-Plans" rel="next" title="Using Plans">
|
|
Chris@42
|
38 <link href="Precision.html#Precision" rel="prev" title="Precision">
|
|
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="Memory-Allocation"></a>
|
|
Chris@42
|
73 <div class="header">
|
|
Chris@42
|
74 <p>
|
|
Chris@42
|
75 Previous: <a href="Precision.html#Precision" accesskey="p" rel="prev">Precision</a>, Up: <a href="Data-Types-and-Files.html#Data-Types-and-Files" accesskey="u" rel="up">Data Types and Files</a> [<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="Memory-Allocation-1"></a>
|
|
Chris@42
|
79 <h4 class="subsection">4.1.3 Memory Allocation</h4>
|
|
Chris@42
|
80
|
|
Chris@42
|
81 <div class="example">
|
|
Chris@42
|
82 <pre class="example">void *fftw_malloc(size_t n);
|
|
Chris@42
|
83 void fftw_free(void *p);
|
|
Chris@42
|
84 </pre></div>
|
|
Chris@42
|
85 <a name="index-fftw_005fmalloc-3"></a>
|
|
Chris@42
|
86 <a name="index-fftw_005ffree-2"></a>
|
|
Chris@42
|
87
|
|
Chris@42
|
88 <p>These are functions that behave identically to <code>malloc</code> and
|
|
Chris@42
|
89 <code>free</code>, except that they guarantee that the returned pointer obeys
|
|
Chris@42
|
90 any special alignment restrictions imposed by any algorithm in FFTW
|
|
Chris@42
|
91 (e.g. for SIMD acceleration). See <a href="SIMD-alignment-and-fftw_005fmalloc.html#SIMD-alignment-and-fftw_005fmalloc">SIMD alignment and fftw_malloc</a>.
|
|
Chris@42
|
92 <a name="index-alignment"></a>
|
|
Chris@42
|
93 </p>
|
|
Chris@42
|
94
|
|
Chris@42
|
95 <p>Data allocated by <code>fftw_malloc</code> <em>must</em> be deallocated by
|
|
Chris@42
|
96 <code>fftw_free</code> and not by the ordinary <code>free</code>.
|
|
Chris@42
|
97 </p>
|
|
Chris@42
|
98 <p>These routines simply call through to your operating system’s
|
|
Chris@42
|
99 <code>malloc</code> or, if necessary, its aligned equivalent
|
|
Chris@42
|
100 (e.g. <code>memalign</code>), so you normally need not worry about any
|
|
Chris@42
|
101 significant time or space overhead. You are <em>not required</em> to use
|
|
Chris@42
|
102 them to allocate your data, but we strongly recommend it.
|
|
Chris@42
|
103 </p>
|
|
Chris@42
|
104 <p>Note: in C++, just as with ordinary <code>malloc</code>, you must typecast
|
|
Chris@42
|
105 the output of <code>fftw_malloc</code> to whatever pointer type you are
|
|
Chris@42
|
106 allocating.
|
|
Chris@42
|
107 <a name="index-C_002b_002b-4"></a>
|
|
Chris@42
|
108 </p>
|
|
Chris@42
|
109
|
|
Chris@42
|
110 <p>We also provide the following two convenience functions to allocate
|
|
Chris@42
|
111 real and complex arrays with <code>n</code> elements, which are equivalent
|
|
Chris@42
|
112 to <code>(double *) fftw_malloc(sizeof(double) * n)</code> and
|
|
Chris@42
|
113 <code>(fftw_complex *) fftw_malloc(sizeof(fftw_complex) * n)</code>,
|
|
Chris@42
|
114 respectively:
|
|
Chris@42
|
115 </p>
|
|
Chris@42
|
116 <div class="example">
|
|
Chris@42
|
117 <pre class="example">double *fftw_alloc_real(size_t n);
|
|
Chris@42
|
118 fftw_complex *fftw_alloc_complex(size_t n);
|
|
Chris@42
|
119 </pre></div>
|
|
Chris@42
|
120 <a name="index-fftw_005falloc_005freal-1"></a>
|
|
Chris@42
|
121 <a name="index-fftw_005falloc_005fcomplex-2"></a>
|
|
Chris@42
|
122
|
|
Chris@42
|
123 <p>The equivalent functions in other precisions allocate arrays of <code>n</code>
|
|
Chris@42
|
124 elements in that precision. e.g. <code>fftwf_alloc_real(n)</code> is
|
|
Chris@42
|
125 equivalent to <code>(float *) fftwf_malloc(sizeof(float) * n)</code>.
|
|
Chris@42
|
126 <a name="index-precision-4"></a>
|
|
Chris@42
|
127 </p>
|
|
Chris@42
|
128
|
|
Chris@42
|
129
|
|
Chris@42
|
130
|
|
Chris@42
|
131 </body>
|
|
Chris@42
|
132 </html>
|
