Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.5/doc/html/Wisdom-File-Export_002fImport-from-Fortran.html @ 83:ae30d91d2ffe

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Replace these with versions built using an older toolset (so as to avoid ABI compatibilities when linking on Ubuntu 14.04 for packaging purposes)
author Chris Cannam
date Fri, 07 Feb 2020 11:51:13 +0000
parents 2cd0e3b3e1fd
children
rev   line source
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: Wisdom File Export/Import from Fortran</title>
Chris@42 26
Chris@42 27 <meta name="description" content="FFTW 3.3.5: Wisdom File Export/Import from Fortran">
Chris@42 28 <meta name="keywords" content="FFTW 3.3.5: Wisdom File Export/Import from Fortran">
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="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" rel="up" title="Accessing the wisdom API from Fortran">
Chris@42 37 <link href="Wisdom-String-Export_002fImport-from-Fortran.html#Wisdom-String-Export_002fImport-from-Fortran" rel="next" title="Wisdom String Export/Import from Fortran">
Chris@42 38 <link href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" rel="prev" title="Accessing the wisdom API from Fortran">
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="Wisdom-File-Export_002fImport-from-Fortran"></a>
Chris@42 73 <div class="header">
Chris@42 74 <p>
Chris@42 75 Next: <a href="Wisdom-String-Export_002fImport-from-Fortran.html#Wisdom-String-Export_002fImport-from-Fortran" accesskey="n" rel="next">Wisdom String Export/Import from Fortran</a>, Previous: <a href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" accesskey="p" rel="prev">Accessing the wisdom API from Fortran</a>, Up: <a href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" accesskey="u" rel="up">Accessing the wisdom API from 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>
Chris@42 76 </div>
Chris@42 77 <hr>
Chris@42 78 <a name="Wisdom-File-Export_002fImport-from-Fortran-1"></a>
Chris@42 79 <h4 class="subsection">7.6.1 Wisdom File Export/Import from Fortran</h4>
Chris@42 80
Chris@42 81 <a name="index-fftw_005fimport-wisdom_005ffrom_005ffilename"></a>
Chris@42 82 <a name="index-fftw_005fexport_005fwisdom_005fto_005ffilename-2"></a>
Chris@42 83 <p>The easiest way to export and import wisdom is to do so using
Chris@42 84 <code>fftw_export_wisdom_to_filename</code> and
Chris@42 85 <code>fftw_wisdom_from_filename</code>. The only trick is that these
Chris@42 86 require you to pass a C string, which is an array of type
Chris@42 87 <code>CHARACTER(C_CHAR)</code> that is terminated by <code>C_NULL_CHAR</code>.
Chris@42 88 You can call them like this:
Chris@42 89 </p>
Chris@42 90 <div class="example">
Chris@42 91 <pre class="example"> integer(C_INT) :: ret
Chris@42 92 ret = fftw_export_wisdom_to_filename(C_CHAR_'my_wisdom.dat' // C_NULL_CHAR)
Chris@42 93 if (ret .eq. 0) stop 'error exporting wisdom to file'
Chris@42 94 ret = fftw_import_wisdom_from_filename(C_CHAR_'my_wisdom.dat' // C_NULL_CHAR)
Chris@42 95 if (ret .eq. 0) stop 'error importing wisdom from file'
Chris@42 96 </pre></div>
Chris@42 97
Chris@42 98 <p>Note that prepending &lsquo;<samp>C_CHAR_</samp>&rsquo; is needed to specify that the
Chris@42 99 literal string is of kind <code>C_CHAR</code>, and we null-terminate the
Chris@42 100 string by appending &lsquo;<samp>// C_NULL_CHAR</samp>&rsquo;. These functions return an
Chris@42 101 <code>integer(C_INT)</code> (<code>ret</code>) which is <code>0</code> if an error
Chris@42 102 occurred during export/import and nonzero otherwise.
Chris@42 103 </p>
Chris@42 104 <p>It is also possible to use the lower-level routines
Chris@42 105 <code>fftw_export_wisdom_to_file</code> and
Chris@42 106 <code>fftw_import_wisdom_from_file</code>, which accept parameters of the C
Chris@42 107 type <code>FILE*</code>, expressed in Fortran as <code>type(C_PTR)</code>.
Chris@42 108 However, you are then responsible for creating the <code>FILE*</code>
Chris@42 109 yourself. You can do this by using <code>iso_c_binding</code> to define
Chris@42 110 Fortran intefaces for the C library functions <code>fopen</code> and
Chris@42 111 <code>fclose</code>, which is a bit strange in Fortran but workable.
Chris@42 112 </p>
Chris@42 113
Chris@42 114
Chris@42 115
Chris@42 116 </body>
Chris@42 117 </html>