Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.8/doc/html/Overview-of-Fortran-interface.html @ 167:bd3cc4d1df30

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 <cannam@all-day-breakfast.com>
date Tue, 19 Nov 2019 14:52:55 +0000
parents
children
rev   line source
cannam@167 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
cannam@167 2 <html>
cannam@167 3 <!-- This manual is for FFTW
cannam@167 4 (version 3.3.8, 24 May 2018).
cannam@167 5
cannam@167 6 Copyright (C) 2003 Matteo Frigo.
cannam@167 7
cannam@167 8 Copyright (C) 2003 Massachusetts Institute of Technology.
cannam@167 9
cannam@167 10 Permission is granted to make and distribute verbatim copies of this
cannam@167 11 manual provided the copyright notice and this permission notice are
cannam@167 12 preserved on all copies.
cannam@167 13
cannam@167 14 Permission is granted to copy and distribute modified versions of this
cannam@167 15 manual under the conditions for verbatim copying, provided that the
cannam@167 16 entire resulting derived work is distributed under the terms of a
cannam@167 17 permission notice identical to this one.
cannam@167 18
cannam@167 19 Permission is granted to copy and distribute translations of this manual
cannam@167 20 into another language, under the above conditions for modified versions,
cannam@167 21 except that this permission notice may be stated in a translation
cannam@167 22 approved by the Free Software Foundation. -->
cannam@167 23 <!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
cannam@167 24 <head>
cannam@167 25 <title>FFTW 3.3.8: Overview of Fortran interface</title>
cannam@167 26
cannam@167 27 <meta name="description" content="FFTW 3.3.8: Overview of Fortran interface">
cannam@167 28 <meta name="keywords" content="FFTW 3.3.8: Overview of Fortran interface">
cannam@167 29 <meta name="resource-type" content="document">
cannam@167 30 <meta name="distribution" content="global">
cannam@167 31 <meta name="Generator" content="makeinfo">
cannam@167 32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
cannam@167 33 <link href="index.html#Top" rel="start" title="Top">
cannam@167 34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
cannam@167 35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
cannam@167 36 <link href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" rel="up" title="Calling FFTW from Modern Fortran">
cannam@167 37 <link href="Extended-and-quadruple-precision-in-Fortran.html#Extended-and-quadruple-precision-in-Fortran" rel="next" title="Extended and quadruple precision in Fortran">
cannam@167 38 <link href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" rel="prev" title="Calling FFTW from Modern Fortran">
cannam@167 39 <style type="text/css">
cannam@167 40 <!--
cannam@167 41 a.summary-letter {text-decoration: none}
cannam@167 42 blockquote.indentedblock {margin-right: 0em}
cannam@167 43 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
cannam@167 44 blockquote.smallquotation {font-size: smaller}
cannam@167 45 div.display {margin-left: 3.2em}
cannam@167 46 div.example {margin-left: 3.2em}
cannam@167 47 div.lisp {margin-left: 3.2em}
cannam@167 48 div.smalldisplay {margin-left: 3.2em}
cannam@167 49 div.smallexample {margin-left: 3.2em}
cannam@167 50 div.smalllisp {margin-left: 3.2em}
cannam@167 51 kbd {font-style: oblique}
cannam@167 52 pre.display {font-family: inherit}
cannam@167 53 pre.format {font-family: inherit}
cannam@167 54 pre.menu-comment {font-family: serif}
cannam@167 55 pre.menu-preformatted {font-family: serif}
cannam@167 56 pre.smalldisplay {font-family: inherit; font-size: smaller}
cannam@167 57 pre.smallexample {font-size: smaller}
cannam@167 58 pre.smallformat {font-family: inherit; font-size: smaller}
cannam@167 59 pre.smalllisp {font-size: smaller}
cannam@167 60 span.nolinebreak {white-space: nowrap}
cannam@167 61 span.roman {font-family: initial; font-weight: normal}
cannam@167 62 span.sansserif {font-family: sans-serif; font-weight: normal}
cannam@167 63 ul.no-bullet {list-style: none}
cannam@167 64 -->
cannam@167 65 </style>
cannam@167 66
cannam@167 67
cannam@167 68 </head>
cannam@167 69
cannam@167 70 <body lang="en">
cannam@167 71 <a name="Overview-of-Fortran-interface"></a>
cannam@167 72 <div class="header">
cannam@167 73 <p>
cannam@167 74 Next: <a href="Reversing-array-dimensions.html#Reversing-array-dimensions" accesskey="n" rel="next">Reversing array dimensions</a>, Previous: <a href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" accesskey="p" rel="prev">Calling FFTW from Modern 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@167 75 </div>
cannam@167 76 <hr>
cannam@167 77 <a name="Overview-of-Fortran-interface-1"></a>
cannam@167 78 <h3 class="section">7.1 Overview of Fortran interface</h3>
cannam@167 79
cannam@167 80 <p>FFTW provides a file <code>fftw3.f03</code> that defines Fortran 2003
cannam@167 81 interfaces for all of its C routines, except for the MPI routines
cannam@167 82 described elsewhere, which can be found in the same directory as
cannam@167 83 <code>fftw3.h</code> (the C header file). In any Fortran subroutine where
cannam@167 84 you want to use FFTW functions, you should begin with:
cannam@167 85 </p>
cannam@167 86 <a name="index-iso_005fc_005fbinding-1"></a>
cannam@167 87 <div class="example">
cannam@167 88 <pre class="example"> use, intrinsic :: iso_c_binding
cannam@167 89 include 'fftw3.f03'
cannam@167 90 </pre></div>
cannam@167 91
cannam@167 92 <p>This includes the interface definitions and the standard
cannam@167 93 <code>iso_c_binding</code> module (which defines the equivalents of C
cannam@167 94 types). You can also put the FFTW functions into a module if you
cannam@167 95 prefer (see <a href="Defining-an-FFTW-module.html#Defining-an-FFTW-module">Defining an FFTW module</a>).
cannam@167 96 </p>
cannam@167 97 <p>At this point, you can now call anything in the FFTW C interface
cannam@167 98 directly, almost exactly as in C other than minor changes in syntax.
cannam@167 99 For example:
cannam@167 100 </p>
cannam@167 101 <a name="index-fftw_005fplan_005fdft_005f2d-2"></a>
cannam@167 102 <a name="index-fftw_005fexecute_005fdft-2"></a>
cannam@167 103 <a name="index-fftw_005fdestroy_005fplan-3"></a>
cannam@167 104 <div class="example">
cannam@167 105 <pre class="example"> type(C_PTR) :: plan
cannam@167 106 complex(C_DOUBLE_COMPLEX), dimension(1024,1000) :: in, out
cannam@167 107 plan = fftw_plan_dft_2d(1000,1024, in,out, FFTW_FORWARD,FFTW_ESTIMATE)
cannam@167 108 ...
cannam@167 109 call fftw_execute_dft(plan, in, out)
cannam@167 110 ...
cannam@167 111 call fftw_destroy_plan(plan)
cannam@167 112 </pre></div>
cannam@167 113
cannam@167 114 <p>A few important things to keep in mind are:
cannam@167 115 </p>
cannam@167 116 <ul>
cannam@167 117 <li> <a name="index-fftw_005fcomplex-2"></a>
cannam@167 118 <a name="index-C_005fPTR"></a>
cannam@167 119 <a name="index-C_005fINT"></a>
cannam@167 120 <a name="index-C_005fDOUBLE"></a>
cannam@167 121 <a name="index-C_005fDOUBLE_005fCOMPLEX"></a>
cannam@167 122 FFTW plans are <code>type(C_PTR)</code>. Other C types are mapped in the
cannam@167 123 obvious way via the <code>iso_c_binding</code> standard: <code>int</code> turns
cannam@167 124 into <code>integer(C_INT)</code>, <code>fftw_complex</code> turns into
cannam@167 125 <code>complex(C_DOUBLE_COMPLEX)</code>, <code>double</code> turns into
cannam@167 126 <code>real(C_DOUBLE)</code>, and so on. See <a href="FFTW-Fortran-type-reference.html#FFTW-Fortran-type-reference">FFTW Fortran type reference</a>.
cannam@167 127
cannam@167 128 </li><li> Functions in C become functions in Fortran if they have a return value,
cannam@167 129 and subroutines in Fortran otherwise.
cannam@167 130
cannam@167 131 </li><li> The ordering of the Fortran array dimensions must be <em>reversed</em>
cannam@167 132 when they are passed to the FFTW plan creation, thanks to differences
cannam@167 133 in array indexing conventions (see <a href="Multi_002ddimensional-Array-Format.html#Multi_002ddimensional-Array-Format">Multi-dimensional Array Format</a>). This is <em>unlike</em> the legacy Fortran interface
cannam@167 134 (see <a href="Fortran_002dinterface-routines.html#Fortran_002dinterface-routines">Fortran-interface routines</a>), which reversed the dimensions
cannam@167 135 for you. See <a href="Reversing-array-dimensions.html#Reversing-array-dimensions">Reversing array dimensions</a>.
cannam@167 136
cannam@167 137 </li><li> <a name="index-alignment-4"></a>
cannam@167 138 <a name="index-SIMD-2"></a>
cannam@167 139 Using ordinary Fortran array declarations like this works, but may
cannam@167 140 yield suboptimal performance because the data may not be not aligned
cannam@167 141 to exploit SIMD instructions on modern proessors (see <a href="SIMD-alignment-and-fftw_005fmalloc.html#SIMD-alignment-and-fftw_005fmalloc">SIMD alignment and fftw_malloc</a>). Better performance will often be obtained
cannam@167 142 by allocating with &lsquo;<samp>fftw_alloc</samp>&rsquo;. See <a href="Allocating-aligned-memory-in-Fortran.html#Allocating-aligned-memory-in-Fortran">Allocating aligned memory in Fortran</a>.
cannam@167 143
cannam@167 144 </li><li> <a name="index-fftw_005fexecute-5"></a>
cannam@167 145 Similar to the legacy Fortran interface (see <a href="FFTW-Execution-in-Fortran.html#FFTW-Execution-in-Fortran">FFTW Execution in Fortran</a>), we currently recommend <em>not</em> using <code>fftw_execute</code>
cannam@167 146 but rather using the more specialized functions like
cannam@167 147 <code>fftw_execute_dft</code> (see <a href="New_002darray-Execute-Functions.html#New_002darray-Execute-Functions">New-array Execute Functions</a>).
cannam@167 148 However, you should execute the plan on the <code>same arrays</code> as the
cannam@167 149 ones for which you created the plan, unless you are especially
cannam@167 150 careful. See <a href="Plan-execution-in-Fortran.html#Plan-execution-in-Fortran">Plan execution in Fortran</a>. To prevent
cannam@167 151 you from using <code>fftw_execute</code> by mistake, the <code>fftw3.f03</code>
cannam@167 152 file does not provide an <code>fftw_execute</code> interface declaration.
cannam@167 153
cannam@167 154 </li><li> <a name="index-flags-8"></a>
cannam@167 155 Multiple planner flags are combined with <code>ior</code> (equivalent to &lsquo;<samp>|</samp>&rsquo; in C). e.g. <code>FFTW_MEASURE | FFTW_DESTROY_INPUT</code> becomes <code>ior(FFTW_MEASURE, FFTW_DESTROY_INPUT)</code>. (You can also use &lsquo;<samp>+</samp>&rsquo; as long as you don&rsquo;t try to include a given flag more than once.)
cannam@167 156
cannam@167 157 </li></ul>
cannam@167 158
cannam@167 159 <table class="menu" border="0" cellspacing="0">
cannam@167 160 <tr><td align="left" valign="top">&bull; <a href="Extended-and-quadruple-precision-in-Fortran.html#Extended-and-quadruple-precision-in-Fortran" accesskey="1">Extended and quadruple precision in Fortran</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
cannam@167 161 </td></tr>
cannam@167 162 </table>
cannam@167 163
cannam@167 164 <hr>
cannam@167 165 <div class="header">
cannam@167 166 <p>
cannam@167 167 Next: <a href="Reversing-array-dimensions.html#Reversing-array-dimensions" accesskey="n" rel="next">Reversing array dimensions</a>, Previous: <a href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" accesskey="p" rel="prev">Calling FFTW from Modern 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@167 168 </div>
cannam@167 169
cannam@167 170
cannam@167 171
cannam@167 172 </body>
cannam@167 173 </html>