Mercurial > hg > js-dsp-test

annotate fft/fftw/fftw-3.3.4/doc/html/Wisdom-String-Export_002fImport-from-Fortran.html @ 40:223f770b5341 kissfft-double tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Try a double-precision kissfft
author Chris Cannam
date Wed, 07 Sep 2016 10:40:32 +0100
parents 26056e866c29
children
rev   line source
Chris@19 1 <html lang="en">
Chris@19 2 <head>
Chris@19 3 <title>Wisdom String Export/Import from Fortran - FFTW 3.3.4</title>
Chris@19 4 <meta http-equiv="Content-Type" content="text/html">
Chris@19 5 <meta name="description" content="FFTW 3.3.4">
Chris@19 6 <meta name="generator" content="makeinfo 4.13">
Chris@19 7 <link title="Top" rel="start" href="index.html#Top">
Chris@19 8 <link rel="up" href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" title="Accessing the wisdom API from Fortran">
Chris@19 9 <link rel="prev" href="Wisdom-File-Export_002fImport-from-Fortran.html#Wisdom-File-Export_002fImport-from-Fortran" title="Wisdom File Export/Import from Fortran">
Chris@19 10 <link rel="next" href="Wisdom-Generic-Export_002fImport-from-Fortran.html#Wisdom-Generic-Export_002fImport-from-Fortran" title="Wisdom Generic Export/Import from Fortran">
Chris@19 11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
Chris@19 12 <!--
Chris@19 13 This manual is for FFTW
Chris@19 14 (version 3.3.4, 20 September 2013).
Chris@19 15
Chris@19 16 Copyright (C) 2003 Matteo Frigo.
Chris@19 17
Chris@19 18 Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@19 19
Chris@19 20 Permission is granted to make and distribute verbatim copies of
Chris@19 21 this manual provided the copyright notice and this permission
Chris@19 22 notice are preserved on all copies.
Chris@19 23
Chris@19 24 Permission is granted to copy and distribute modified versions of
Chris@19 25 this manual under the conditions for verbatim copying, provided
Chris@19 26 that the entire resulting derived work is distributed under the
Chris@19 27 terms of a permission notice identical to this one.
Chris@19 28
Chris@19 29 Permission is granted to copy and distribute translations of this
Chris@19 30 manual into another language, under the above conditions for
Chris@19 31 modified versions, except that this permission notice may be
Chris@19 32 stated in a translation approved by the Free Software Foundation.
Chris@19 33 -->
Chris@19 34 <meta http-equiv="Content-Style-Type" content="text/css">
Chris@19 35 <style type="text/css"><!--
Chris@19 36 pre.display { font-family:inherit }
Chris@19 37 pre.format { font-family:inherit }
Chris@19 38 pre.smalldisplay { font-family:inherit; font-size:smaller }
Chris@19 39 pre.smallformat { font-family:inherit; font-size:smaller }
Chris@19 40 pre.smallexample { font-size:smaller }
Chris@19 41 pre.smalllisp { font-size:smaller }
Chris@19 42 span.sc { font-variant:small-caps }
Chris@19 43 span.roman { font-family:serif; font-weight:normal; }
Chris@19 44 span.sansserif { font-family:sans-serif; font-weight:normal; }
Chris@19 45 --></style>
Chris@19 46 </head>
Chris@19 47 <body>
Chris@19 48 <div class="node">
Chris@19 49 <a name="Wisdom-String-Export%2fImport-from-Fortran"></a>
Chris@19 50 <a name="Wisdom-String-Export_002fImport-from-Fortran"></a>
Chris@19 51 <p>
Chris@19 52 Next:&nbsp;<a rel="next" accesskey="n" href="Wisdom-Generic-Export_002fImport-from-Fortran.html#Wisdom-Generic-Export_002fImport-from-Fortran">Wisdom Generic Export/Import from Fortran</a>,
Chris@19 53 Previous:&nbsp;<a rel="previous" accesskey="p" href="Wisdom-File-Export_002fImport-from-Fortran.html#Wisdom-File-Export_002fImport-from-Fortran">Wisdom File Export/Import from Fortran</a>,
Chris@19 54 Up:&nbsp;<a rel="up" accesskey="u" href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran">Accessing the wisdom API from Fortran</a>
Chris@19 55 <hr>
Chris@19 56 </div>
Chris@19 57
Chris@19 58 <h4 class="subsection">7.6.2 Wisdom String Export/Import from Fortran</h4>
Chris@19 59
Chris@19 60 <p><a name="index-fftw_005fexport_005fwisdom_005fto_005fstring-571"></a>Dealing with FFTW's C string export/import is a bit more painful. In
Chris@19 61 particular, the <code>fftw_export_wisdom_to_string</code> function requires
Chris@19 62 you to deal with a dynamically allocated C string. To get its length,
Chris@19 63 you must define an interface to the C <code>strlen</code> function, and to
Chris@19 64 deallocate it you must define an interface to C <code>free</code>:
Chris@19 65
Chris@19 66 <pre class="example"> use, intrinsic :: iso_c_binding
Chris@19 67 interface
Chris@19 68 integer(C_INT) function strlen(s) bind(C, name='strlen')
Chris@19 69 import
Chris@19 70 type(C_PTR), value :: s
Chris@19 71 end function strlen
Chris@19 72 subroutine free(p) bind(C, name='free')
Chris@19 73 import
Chris@19 74 type(C_PTR), value :: p
Chris@19 75 end subroutine free
Chris@19 76 end interface
Chris@19 77 </pre>
Chris@19 78 <p>Given these definitions, you can then export wisdom to a Fortran
Chris@19 79 character array:
Chris@19 80
Chris@19 81 <pre class="example"> character(C_CHAR), pointer :: s(:)
Chris@19 82 integer(C_SIZE_T) :: slen
Chris@19 83 type(C_PTR) :: p
Chris@19 84 p = fftw_export_wisdom_to_string()
Chris@19 85 if (.not. c_associated(p)) stop 'error exporting wisdom'
Chris@19 86 slen = strlen(p)
Chris@19 87 call c_f_pointer(p, s, [slen+1])
Chris@19 88 ...
Chris@19 89 call free(p)
Chris@19 90 </pre>
Chris@19 91 <p><a name="index-c_005fassociated-572"></a><a name="index-c_005ff_005fpointer-573"></a>
Chris@19 92 Note that <code>slen</code> is the length of the C string, but the length of
Chris@19 93 the array is <code>slen+1</code> because it includes the terminating null
Chris@19 94 character. (You can omit the &lsquo;<samp><span class="samp">+1</span></samp>&rsquo; if you don't want Fortran to
Chris@19 95 know about the null character.) The standard <code>c_associated</code> function
Chris@19 96 checks whether <code>p</code> is a null pointer, which is returned by
Chris@19 97 <code>fftw_export_wisdom_to_string</code> if there was an error.
Chris@19 98
Chris@19 99 <p><a name="index-fftw_005fimport_005fwisdom_005ffrom_005fstring-574"></a>To import wisdom from a string, use
Chris@19 100 <code>fftw_import_wisdom_from_string</code> as usual; note that the argument
Chris@19 101 of this function must be a <code>character(C_CHAR)</code> that is terminated
Chris@19 102 by the <code>C_NULL_CHAR</code> character, like the <code>s</code> array above.
Chris@19 103
Chris@19 104 <!-- =========> -->
Chris@19 105 </body></html>
Chris@19 106