Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.5/doc/html/Allocating-aligned-memory-in-Fortran.html @ 169:223a55898ab9 tip default

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add null config files
author Chris Cannam <cannam@all-day-breakfast.com>
date Mon, 02 Mar 2020 14:03:47 +0000
parents 7867fa7e1b6b
children
rev   line source
cannam@127 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
cannam@127 2 <html>
cannam@127 3 <!-- This manual is for FFTW
cannam@127 4 (version 3.3.5, 30 July 2016).
cannam@127 5
cannam@127 6 Copyright (C) 2003 Matteo Frigo.
cannam@127 7
cannam@127 8 Copyright (C) 2003 Massachusetts Institute of Technology.
cannam@127 9
cannam@127 10 Permission is granted to make and distribute verbatim copies of this
cannam@127 11 manual provided the copyright notice and this permission notice are
cannam@127 12 preserved on all copies.
cannam@127 13
cannam@127 14 Permission is granted to copy and distribute modified versions of this
cannam@127 15 manual under the conditions for verbatim copying, provided that the
cannam@127 16 entire resulting derived work is distributed under the terms of a
cannam@127 17 permission notice identical to this one.
cannam@127 18
cannam@127 19 Permission is granted to copy and distribute translations of this manual
cannam@127 20 into another language, under the above conditions for modified versions,
cannam@127 21 except that this permission notice may be stated in a translation
cannam@127 22 approved by the Free Software Foundation. -->
cannam@127 23 <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
cannam@127 24 <head>
cannam@127 25 <title>FFTW 3.3.5: Allocating aligned memory in Fortran</title>
cannam@127 26
cannam@127 27 <meta name="description" content="FFTW 3.3.5: Allocating aligned memory in Fortran">
cannam@127 28 <meta name="keywords" content="FFTW 3.3.5: Allocating aligned memory in Fortran">
cannam@127 29 <meta name="resource-type" content="document">
cannam@127 30 <meta name="distribution" content="global">
cannam@127 31 <meta name="Generator" content="makeinfo">
cannam@127 32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
cannam@127 33 <link href="index.html#Top" rel="start" title="Top">
cannam@127 34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
cannam@127 35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
cannam@127 36 <link href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" rel="up" title="Calling FFTW from Modern Fortran">
cannam@127 37 <link href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" rel="next" title="Accessing the wisdom API from Fortran">
cannam@127 38 <link href="Plan-execution-in-Fortran.html#Plan-execution-in-Fortran" rel="prev" title="Plan execution in Fortran">
cannam@127 39 <style type="text/css">
cannam@127 40 <!--
cannam@127 41 a.summary-letter {text-decoration: none}
cannam@127 42 blockquote.smallquotation {font-size: smaller}
cannam@127 43 div.display {margin-left: 3.2em}
cannam@127 44 div.example {margin-left: 3.2em}
cannam@127 45 div.indentedblock {margin-left: 3.2em}
cannam@127 46 div.lisp {margin-left: 3.2em}
cannam@127 47 div.smalldisplay {margin-left: 3.2em}
cannam@127 48 div.smallexample {margin-left: 3.2em}
cannam@127 49 div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
cannam@127 50 div.smalllisp {margin-left: 3.2em}
cannam@127 51 kbd {font-style:oblique}
cannam@127 52 pre.display {font-family: inherit}
cannam@127 53 pre.format {font-family: inherit}
cannam@127 54 pre.menu-comment {font-family: serif}
cannam@127 55 pre.menu-preformatted {font-family: serif}
cannam@127 56 pre.smalldisplay {font-family: inherit; font-size: smaller}
cannam@127 57 pre.smallexample {font-size: smaller}
cannam@127 58 pre.smallformat {font-family: inherit; font-size: smaller}
cannam@127 59 pre.smalllisp {font-size: smaller}
cannam@127 60 span.nocodebreak {white-space:nowrap}
cannam@127 61 span.nolinebreak {white-space:nowrap}
cannam@127 62 span.roman {font-family:serif; font-weight:normal}
cannam@127 63 span.sansserif {font-family:sans-serif; font-weight:normal}
cannam@127 64 ul.no-bullet {list-style: none}
cannam@127 65 -->
cannam@127 66 </style>
cannam@127 67
cannam@127 68
cannam@127 69 </head>
cannam@127 70
cannam@127 71 <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
cannam@127 72 <a name="Allocating-aligned-memory-in-Fortran"></a>
cannam@127 73 <div class="header">
cannam@127 74 <p>
cannam@127 75 Next: <a href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" accesskey="n" rel="next">Accessing the wisdom API from Fortran</a>, Previous: <a href="Plan-execution-in-Fortran.html#Plan-execution-in-Fortran" accesskey="p" rel="prev">Plan execution in Fortran</a>, Up: <a href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" accesskey="u" rel="up">Calling FFTW from Modern Fortran</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>
cannam@127 76 </div>
cannam@127 77 <hr>
cannam@127 78 <a name="Allocating-aligned-memory-in-Fortran-1"></a>
cannam@127 79 <h3 class="section">7.5 Allocating aligned memory in Fortran</h3>
cannam@127 80
cannam@127 81 <a name="index-alignment-5"></a>
cannam@127 82 <a name="index-fftw_005falloc_005freal-5"></a>
cannam@127 83 <a name="index-fftw_005falloc_005fcomplex-5"></a>
cannam@127 84 <p>In order to obtain maximum performance in FFTW, you should store your
cannam@127 85 data in arrays that have been specially aligned in memory (see <a href="SIMD-alignment-and-fftw_005fmalloc.html#SIMD-alignment-and-fftw_005fmalloc">SIMD alignment and fftw_malloc</a>). Enforcing alignment also permits you to
cannam@127 86 safely use the new-array execute functions (see <a href="New_002darray-Execute-Functions.html#New_002darray-Execute-Functions">New-array Execute Functions</a>) to apply a given plan to more than one pair of in/out
cannam@127 87 arrays. Unfortunately, standard Fortran arrays do <em>not</em> provide
cannam@127 88 any alignment guarantees. The <em>only</em> way to allocate aligned
cannam@127 89 memory in standard Fortran is to allocate it with an external C
cannam@127 90 function, like the <code>fftw_alloc_real</code> and
cannam@127 91 <code>fftw_alloc_complex</code> functions. Fortunately, Fortran 2003 provides
cannam@127 92 a simple way to associate such allocated memory with a standard Fortran
cannam@127 93 array pointer that you can then use normally.
cannam@127 94 </p>
cannam@127 95 <p>We therefore recommend allocating all your input/output arrays using
cannam@127 96 the following technique:
cannam@127 97 </p>
cannam@127 98 <ol>
cannam@127 99 <li> Declare a <code>pointer</code>, <code>arr</code>, to your array of the desired type
cannam@127 100 and dimensions. For example, <code>real(C_DOUBLE), pointer :: a(:,:)</code>
cannam@127 101 for a 2d real array, or <code>complex(C_DOUBLE_COMPLEX), pointer ::
cannam@127 102 a(:,:,:)</code> for a 3d complex array.
cannam@127 103
cannam@127 104 </li><li> The number of elements to allocate must be an
cannam@127 105 <code>integer(C_SIZE_T)</code>. You can either declare a variable of this
cannam@127 106 type, e.g. <code>integer(C_SIZE_T) :: sz</code>, to store the number of
cannam@127 107 elements to allocate, or you can use the <code>int(..., C_SIZE_T)</code>
cannam@127 108 intrinsic function. e.g. set <code>sz = L * M * N</code> or use
cannam@127 109 <code>int(L * M * N, C_SIZE_T)</code> for an L&nbsp;&times;&nbsp;M&nbsp;&times;&nbsp;N array.
cannam@127 110
cannam@127 111 </li><li> Declare a <code>type(C_PTR) :: p</code> to hold the return value from
cannam@127 112 FFTW&rsquo;s allocation routine. Set <code>p = fftw_alloc_real(sz)</code> for a real array, or <code>p = fftw_alloc_complex(sz)</code> for a complex array.
cannam@127 113
cannam@127 114 </li><li> <a name="index-c_005ff_005fpointer-2"></a>
cannam@127 115 Associate your pointer <code>arr</code> with the allocated memory <code>p</code>
cannam@127 116 using the standard <code>c_f_pointer</code> subroutine: <code>call
cannam@127 117 c_f_pointer(p, arr, [...dimensions...])</code>, where
cannam@127 118 <code>[...dimensions...])</code> are an array of the dimensions of the array
cannam@127 119 (in the usual Fortran order). e.g. <code>call c_f_pointer(p, arr,
cannam@127 120 [L,M,N])</code> for an L&nbsp;&times;&nbsp;M&nbsp;&times;&nbsp;N array. (Alternatively, you can
cannam@127 121 omit the dimensions argument if you specified the shape explicitly
cannam@127 122 when declaring <code>arr</code>.) You can now use <code>arr</code> as a usual
cannam@127 123 multidimensional array.
cannam@127 124
cannam@127 125 </li><li> When you are done using the array, deallocate the memory by <code>call
cannam@127 126 fftw_free(p)</code> on <code>p</code>.
cannam@127 127
cannam@127 128 </li></ol>
cannam@127 129
cannam@127 130 <p>For example, here is how we would allocate an L&nbsp;&times;&nbsp;M 2d real array:
cannam@127 131 </p>
cannam@127 132 <div class="example">
cannam@127 133 <pre class="example"> real(C_DOUBLE), pointer :: arr(:,:)
cannam@127 134 type(C_PTR) :: p
cannam@127 135 p = fftw_alloc_real(int(L * M, C_SIZE_T))
cannam@127 136 call c_f_pointer(p, arr, [L,M])
cannam@127 137 <em>...use arr and arr(i,j) as usual...</em>
cannam@127 138 call fftw_free(p)
cannam@127 139 </pre></div>
cannam@127 140
cannam@127 141 <p>and here is an L&nbsp;&times;&nbsp;M&nbsp;&times;&nbsp;N 3d complex array:
cannam@127 142 </p>
cannam@127 143 <div class="example">
cannam@127 144 <pre class="example"> complex(C_DOUBLE_COMPLEX), pointer :: arr(:,:,:)
cannam@127 145 type(C_PTR) :: p
cannam@127 146 p = fftw_alloc_complex(int(L * M * N, C_SIZE_T))
cannam@127 147 call c_f_pointer(p, arr, [L,M,N])
cannam@127 148 <em>...use arr and arr(i,j,k) as usual...</em>
cannam@127 149 call fftw_free(p)
cannam@127 150 </pre></div>
cannam@127 151
cannam@127 152 <p>See <a href="Reversing-array-dimensions.html#Reversing-array-dimensions">Reversing array dimensions</a> for an example allocating a
cannam@127 153 single array and associating both real and complex array pointers with
cannam@127 154 it, for in-place real-to-complex transforms.
cannam@127 155 </p>
cannam@127 156 <hr>
cannam@127 157 <div class="header">
cannam@127 158 <p>
cannam@127 159 Next: <a href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" accesskey="n" rel="next">Accessing the wisdom API from Fortran</a>, Previous: <a href="Plan-execution-in-Fortran.html#Plan-execution-in-Fortran" accesskey="p" rel="prev">Plan execution in Fortran</a>, Up: <a href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" accesskey="u" rel="up">Calling FFTW from Modern Fortran</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>
cannam@127 160 </div>
cannam@127 161
cannam@127 162
cannam@127 163
cannam@127 164 </body>
cannam@127 165 </html>