Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.8/doc/html/Wisdom-File-Export_002fImport-from-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 bd3cc4d1df30
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: Wisdom File Export/Import from Fortran</title>
cannam@167 26
cannam@167 27 <meta name="description" content="FFTW 3.3.8: Wisdom File Export/Import from Fortran">
cannam@167 28 <meta name="keywords" content="FFTW 3.3.8: Wisdom File Export/Import from Fortran">
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="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" rel="up" title="Accessing the wisdom API from Fortran">
cannam@167 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">
cannam@167 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">
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="Wisdom-File-Export_002fImport-from-Fortran"></a>
cannam@167 72 <div class="header">
cannam@167 73 <p>
cannam@167 74 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>
cannam@167 75 </div>
cannam@167 76 <hr>
cannam@167 77 <a name="Wisdom-File-Export_002fImport-from-Fortran-1"></a>
cannam@167 78 <h4 class="subsection">7.6.1 Wisdom File Export/Import from Fortran</h4>
cannam@167 79
cannam@167 80 <a name="index-fftw_005fimport-wisdom_005ffrom_005ffilename"></a>
cannam@167 81 <a name="index-fftw_005fexport_005fwisdom_005fto_005ffilename-2"></a>
cannam@167 82 <p>The easiest way to export and import wisdom is to do so using
cannam@167 83 <code>fftw_export_wisdom_to_filename</code> and
cannam@167 84 <code>fftw_wisdom_from_filename</code>. The only trick is that these
cannam@167 85 require you to pass a C string, which is an array of type
cannam@167 86 <code>CHARACTER(C_CHAR)</code> that is terminated by <code>C_NULL_CHAR</code>.
cannam@167 87 You can call them like this:
cannam@167 88 </p>
cannam@167 89 <div class="example">
cannam@167 90 <pre class="example"> integer(C_INT) :: ret
cannam@167 91 ret = fftw_export_wisdom_to_filename(C_CHAR_'my_wisdom.dat' // C_NULL_CHAR)
cannam@167 92 if (ret .eq. 0) stop 'error exporting wisdom to file'
cannam@167 93 ret = fftw_import_wisdom_from_filename(C_CHAR_'my_wisdom.dat' // C_NULL_CHAR)
cannam@167 94 if (ret .eq. 0) stop 'error importing wisdom from file'
cannam@167 95 </pre></div>
cannam@167 96
cannam@167 97 <p>Note that prepending &lsquo;<samp>C_CHAR_</samp>&rsquo; is needed to specify that the
cannam@167 98 literal string is of kind <code>C_CHAR</code>, and we null-terminate the
cannam@167 99 string by appending &lsquo;<samp>// C_NULL_CHAR</samp>&rsquo;. These functions return an
cannam@167 100 <code>integer(C_INT)</code> (<code>ret</code>) which is <code>0</code> if an error
cannam@167 101 occurred during export/import and nonzero otherwise.
cannam@167 102 </p>
cannam@167 103 <p>It is also possible to use the lower-level routines
cannam@167 104 <code>fftw_export_wisdom_to_file</code> and
cannam@167 105 <code>fftw_import_wisdom_from_file</code>, which accept parameters of the C
cannam@167 106 type <code>FILE*</code>, expressed in Fortran as <code>type(C_PTR)</code>.
cannam@167 107 However, you are then responsible for creating the <code>FILE*</code>
cannam@167 108 yourself. You can do this by using <code>iso_c_binding</code> to define
cannam@167 109 Fortran intefaces for the C library functions <code>fopen</code> and
cannam@167 110 <code>fclose</code>, which is a bit strange in Fortran but workable.
cannam@167 111 </p>
cannam@167 112
cannam@167 113
cannam@167 114
cannam@167 115 </body>
cannam@167 116 </html>