annotate Lib/fftw-3.2.1/doc/html/.svn/text-base/Memory-Allocation.html.svn-base @ 14:636c989477e7

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