comparison Lib/fftw-3.2.1/doc/html/.svn/text-base/Memory-Allocation.html.svn-base @ 15:585caf503ef5 tip

Tidy up for ROLI
author Geogaddi\David <d.m.ronan@qmul.ac.uk>
date Tue, 17 May 2016 18:50:19 +0100
parents 636c989477e7
children
comparison
equal deleted inserted replaced
14:636c989477e7 15:585caf503ef5
1 <html lang="en">
2 <head>
3 <title>Memory Allocation - FFTW 3.2.1</title>
4 <meta http-equiv="Content-Type" content="text/html">
5 <meta name="description" content="FFTW 3.2.1">
6 <meta name="generator" content="makeinfo 4.8">
7 <link title="Top" rel="start" href="index.html#Top">
8 <link rel="up" href="Data-Types-and-Files.html#Data-Types-and-Files" title="Data Types and Files">
9 <link rel="prev" href="Precision.html#Precision" title="Precision">
10 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
11 <!--
12 This manual is for FFTW
13 (version 3.2.1, 5 February 2009).
14
15 Copyright (C) 2003 Matteo Frigo.
16
17 Copyright (C) 2003 Massachusetts Institute of Technology.
18
19 Permission is granted to make and distribute verbatim copies of
20 this manual provided the copyright notice and this permission
21 notice are preserved on all copies.
22
23 Permission is granted to copy and distribute modified versions of
24 this manual under the conditions for verbatim copying, provided
25 that the entire resulting derived work is distributed under the
26 terms of a permission notice identical to this one.
27
28 Permission is granted to copy and distribute translations of this
29 manual into another language, under the above conditions for
30 modified versions, except that this permission notice may be
31 stated in a translation approved by the Free Software Foundation.
32 -->
33 <meta http-equiv="Content-Style-Type" content="text/css">
34 <style type="text/css"><!--
35 pre.display { font-family:inherit }
36 pre.format { font-family:inherit }
37 pre.smalldisplay { font-family:inherit; font-size:smaller }
38 pre.smallformat { font-family:inherit; font-size:smaller }
39 pre.smallexample { font-size:smaller }
40 pre.smalllisp { font-size:smaller }
41 span.sc { font-variant:small-caps }
42 span.roman { font-family:serif; font-weight:normal; }
43 span.sansserif { font-family:sans-serif; font-weight:normal; }
44 --></style>
45 </head>
46 <body>
47 <div class="node">
48 <p>
49 <a name="Memory-Allocation"></a>
50 Previous:&nbsp;<a rel="previous" accesskey="p" href="Precision.html#Precision">Precision</a>,
51 Up:&nbsp;<a rel="up" accesskey="u" href="Data-Types-and-Files.html#Data-Types-and-Files">Data Types and Files</a>
52 <hr>
53 </div>
54
55 <h4 class="subsection">4.1.3 Memory Allocation</h4>
56
57 <pre class="example"> void *fftw_malloc(size_t n);
58 void fftw_free(void *p);
59 </pre>
60 <p><a name="index-fftw_005fmalloc-142"></a><a name="index-fftw_005ffree-143"></a>
61 These are functions that behave identically to <code>malloc</code> and
62 <code>free</code>, except that they guarantee that the returned pointer obeys
63 any special alignment restrictions imposed by any algorithm in FFTW
64 (e.g. for SIMD acceleration). See <a href="Data-Alignment.html#Data-Alignment">Data Alignment</a>.
65 <a name="index-alignment-144"></a>
66 Data allocated by <code>fftw_malloc</code> <em>must</em> be deallocated by
67 <code>fftw_free</code> and not by the ordinary <code>free</code>.
68
69 <p>These routines simply call through to your operating system's
70 <code>malloc</code> or, if necessary, its aligned equivalent
71 (e.g. <code>memalign</code>), so you normally need not worry about any
72 significant time or space overhead. You are <em>not required</em> to use
73 them to allocate your data, but we strongly recommend it.
74
75 <p>Note: in C++, just as with ordinary <code>malloc</code>, you must typecast
76 the output of <code>fftw_malloc</code> to whatever pointer type you are
77 allocating.
78 <a name="index-C_002b_002b-145"></a>
79 <!-- -->
80
81 </body></html>
82