Mercurial > hg > sv-dependency-builds

comparison src/fftw-3.3.5/doc/html/Wisdom-Generic-Export_002fImport-from-Fortran.html @ 42:2cd0e3b3e1fd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Current fftw source
author Chris Cannam
date Tue, 18 Oct 2016 13:40:26 +0100
parents
children
comparison
equal deleted inserted replaced
41:481f5f8c5634 42:2cd0e3b3e1fd
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 Generic Export/Import from Fortran</title>
26
27 <meta name="description" content="FFTW 3.3.5: Wisdom Generic Export/Import from Fortran">
28 <meta name="keywords" content="FFTW 3.3.5: Wisdom Generic 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="Defining-an-FFTW-module.html#Defining-an-FFTW-module" rel="next" title="Defining an FFTW module">
38 <link href="Wisdom-String-Export_002fImport-from-Fortran.html#Wisdom-String-Export_002fImport-from-Fortran" rel="prev" title="Wisdom String Export/Import 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-Generic-Export_002fImport-from-Fortran"></a>
73 <div class="header">
74 <p>
75 Previous: <a href="Wisdom-String-Export_002fImport-from-Fortran.html#Wisdom-String-Export_002fImport-from-Fortran" accesskey="p" rel="prev">Wisdom String Export/Import 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-Generic-Export_002fImport-from-Fortran-1"></a>
79 <h4 class="subsection">7.6.3 Wisdom Generic Export/Import from Fortran</h4>
80
81 <p>The most generic wisdom export/import functions allow you to provide
82 an arbitrary callback function to read/write one character at a time
83 in any way you want. However, your callback function must be written
84 in a special way, using the <code>bind(C)</code> attribute to be passed to a
85 C interface.
86 </p>
87 <a name="index-fftw_005fexport_005fwisdom-1"></a>
88 <p>In particular, to call the generic wisdom export function
89 <code>fftw_export_wisdom</code>, you would write a callback subroutine of the form:
90 </p>
91 <div class="example">
92 <pre class="example"> subroutine my_write_char(c, p) bind(C)
93 use, intrinsic :: iso_c_binding
94 character(C_CHAR), value :: c
95 type(C_PTR), value :: p
96 <em>...write c...</em>
97 end subroutine my_write_char
98 </pre></div>
99
100 <p>Given such a subroutine (along with the corresponding interface definition), you could then export wisdom using:
101 </p>
102 <a name="index-c_005ffunloc"></a>
103 <div class="example">
104 <pre class="example"> call fftw_export_wisdom(c_funloc(my_write_char), p)
105 </pre></div>
106
107 <a name="index-c_005floc"></a>
108 <a name="index-c_005ff_005fpointer-4"></a>
109 <p>The standard <code>c_funloc</code> intrinsic converts a Fortran
110 <code>bind(C)</code> subroutine into a C function pointer. The parameter
111 <code>p</code> is a <code>type(C_PTR)</code> to any arbitrary data that you want
112 to pass to <code>my_write_char</code> (or <code>C_NULL_PTR</code> if none). (Note
113 that you can get a C pointer to Fortran data using the intrinsic
114 <code>c_loc</code>, and convert it back to a Fortran pointer in
115 <code>my_write_char</code> using <code>c_f_pointer</code>.)
116 </p>
117 <p>Similarly, to use the generic <code>fftw_import_wisdom</code>, you would
118 define a callback function of the form:
119 </p>
120 <a name="index-fftw_005fimport_005fwisdom-1"></a>
121 <div class="example">
122 <pre class="example"> integer(C_INT) function my_read_char(p) bind(C)
123 use, intrinsic :: iso_c_binding
124 type(C_PTR), value :: p
125 character :: c
126 <em>...read a character c...</em>
127 my_read_char = ichar(c, C_INT)
128 end function my_read_char
129
130 ....
131
132 integer(C_INT) :: ret
133 ret = fftw_import_wisdom(c_funloc(my_read_char), p)
134 if (ret .eq. 0) stop 'error importing wisdom'
135 </pre></div>
136
137 <p>Your function can return <code>-1</code> if the end of the input is reached.
138 Again, <code>p</code> is an arbitrary <code>type(C_PTR</code> that is passed
139 through to your function. <code>fftw_import_wisdom</code> returns <code>0</code>
140 if an error occurred and nonzero otherwise.
141 </p>
142 <hr>
143 <div class="header">
144 <p>
145 Previous: <a href="Wisdom-String-Export_002fImport-from-Fortran.html#Wisdom-String-Export_002fImport-from-Fortran" accesskey="p" rel="prev">Wisdom String Export/Import 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>
146 </div>
147
148
149
150 </body>
151 </html>