Mercurial > hg > sv-dependency-builds

comparison src/fftw-3.3.5/doc/html/Wisdom-File-Export_002fImport-from-Fortran.html @ 127:7867fa7e1b6b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Current fftw source
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 18 Oct 2016 13:40:26 +0100
parents
children
comparison
equal deleted inserted replaced
126:4a7071416412 127:7867fa7e1b6b
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html>
3 <!-- This manual is for FFTW
4 (version 3.3.5, 30 July 2016).
5
6 Copyright (C) 2003 Matteo Frigo.
7
8 Copyright (C) 2003 Massachusetts Institute of Technology.
9
10 Permission is granted to make and distribute verbatim copies of this
11 manual provided the copyright notice and this permission notice are
12 preserved on all copies.
13
14 Permission is granted to copy and distribute modified versions of this
15 manual under the conditions for verbatim copying, provided that the
16 entire resulting derived work is distributed under the terms of a
17 permission notice identical to this one.
18
19 Permission is granted to copy and distribute translations of this manual
20 into another language, under the above conditions for modified versions,
21 except that this permission notice may be stated in a translation
22 approved by the Free Software Foundation. -->
23 <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
24 <head>
25 <title>FFTW 3.3.5: Wisdom File Export/Import from Fortran</title>
26
27 <meta name="description" content="FFTW 3.3.5: Wisdom File Export/Import from Fortran">
28 <meta name="keywords" content="FFTW 3.3.5: Wisdom File Export/Import from Fortran">
29 <meta name="resource-type" content="document">
30 <meta name="distribution" content="global">
31 <meta name="Generator" content="makeinfo">
32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
33 <link href="index.html#Top" rel="start" title="Top">
34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
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">
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">
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">
39 <style type="text/css">
40 <!--
41 a.summary-letter {text-decoration: none}
42 blockquote.smallquotation {font-size: smaller}
43 div.display {margin-left: 3.2em}
44 div.example {margin-left: 3.2em}
45 div.indentedblock {margin-left: 3.2em}
46 div.lisp {margin-left: 3.2em}
47 div.smalldisplay {margin-left: 3.2em}
48 div.smallexample {margin-left: 3.2em}
49 div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
50 div.smalllisp {margin-left: 3.2em}
51 kbd {font-style:oblique}
52 pre.display {font-family: inherit}
53 pre.format {font-family: inherit}
54 pre.menu-comment {font-family: serif}
55 pre.menu-preformatted {font-family: serif}
56 pre.smalldisplay {font-family: inherit; font-size: smaller}
57 pre.smallexample {font-size: smaller}
58 pre.smallformat {font-family: inherit; font-size: smaller}
59 pre.smalllisp {font-size: smaller}
60 span.nocodebreak {white-space:nowrap}
61 span.nolinebreak {white-space:nowrap}
62 span.roman {font-family:serif; font-weight:normal}
63 span.sansserif {font-family:sans-serif; font-weight:normal}
64 ul.no-bullet {list-style: none}
65 -->
66 </style>
67
68
69 </head>
70
71 <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
72 <a name="Wisdom-File-Export_002fImport-from-Fortran"></a>
73 <div class="header">
74 <p>
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>
76 </div>
77 <hr>
78 <a name="Wisdom-File-Export_002fImport-from-Fortran-1"></a>
79 <h4 class="subsection">7.6.1 Wisdom File Export/Import from Fortran</h4>
80
81 <a name="index-fftw_005fimport-wisdom_005ffrom_005ffilename"></a>
82 <a name="index-fftw_005fexport_005fwisdom_005fto_005ffilename-2"></a>
83 <p>The easiest way to export and import wisdom is to do so using
84 <code>fftw_export_wisdom_to_filename</code> and
85 <code>fftw_wisdom_from_filename</code>. The only trick is that these
86 require you to pass a C string, which is an array of type
87 <code>CHARACTER(C_CHAR)</code> that is terminated by <code>C_NULL_CHAR</code>.
88 You can call them like this:
89 </p>
90 <div class="example">
91 <pre class="example"> integer(C_INT) :: ret
92 ret = fftw_export_wisdom_to_filename(C_CHAR_'my_wisdom.dat' // C_NULL_CHAR)
93 if (ret .eq. 0) stop 'error exporting wisdom to file'
94 ret = fftw_import_wisdom_from_filename(C_CHAR_'my_wisdom.dat' // C_NULL_CHAR)
95 if (ret .eq. 0) stop 'error importing wisdom from file'
96 </pre></div>
97
98 <p>Note that prepending &lsquo;<samp>C_CHAR_</samp>&rsquo; is needed to specify that the
99 literal string is of kind <code>C_CHAR</code>, and we null-terminate the
100 string by appending &lsquo;<samp>// C_NULL_CHAR</samp>&rsquo;. These functions return an
101 <code>integer(C_INT)</code> (<code>ret</code>) which is <code>0</code> if an error
102 occurred during export/import and nonzero otherwise.
103 </p>
104 <p>It is also possible to use the lower-level routines
105 <code>fftw_export_wisdom_to_file</code> and
106 <code>fftw_import_wisdom_from_file</code>, which accept parameters of the C
107 type <code>FILE*</code>, expressed in Fortran as <code>type(C_PTR)</code>.
108 However, you are then responsible for creating the <code>FILE*</code>
109 yourself. You can do this by using <code>iso_c_binding</code> to define
110 Fortran intefaces for the C library functions <code>fopen</code> and
111 <code>fclose</code>, which is a bit strange in Fortran but workable.
112 </p>
113
114
115
116 </body>
117 </html>