Mercurial > hg > vamp-docs

annotate code-docs/classVamp_1_1FFT.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update for 2.4
author Chris Cannam
date Fri, 13 Jul 2012 13:30:27 +0100
parents
children 27319718b1f8
rev   line source
Chris@3 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@3 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@3 3 <head>
Chris@3 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@3 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
Chris@3 6 <title>VampPluginSDK: Vamp::FFT Class Reference</title>
Chris@3 7
Chris@3 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@3 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@3 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@3 11 <script type="text/javascript" src="jquery.js"></script>
Chris@3 12 <script type="text/javascript" src="resize.js"></script>
Chris@3 13 <script type="text/javascript" src="navtree.js"></script>
Chris@3 14 <script type="text/javascript">
Chris@3 15 $(document).ready(initResizable);
Chris@3 16 </script>
Chris@3 17
Chris@3 18
Chris@3 19 </head>
Chris@3 20 <body>
Chris@3 21 <div id="top"><!-- do not remove this div! -->
Chris@3 22
Chris@3 23
Chris@3 24 <div id="titlearea">
Chris@3 25 <table cellspacing="0" cellpadding="0">
Chris@3 26 <tbody>
Chris@3 27 <tr style="height: 56px;">
Chris@3 28
Chris@3 29
Chris@3 30 <td style="padding-left: 0.5em;">
Chris@3 31 <div id="projectname">VampPluginSDK
Chris@3 32 &#160;<span id="projectnumber">2.4</span>
Chris@3 33 </div>
Chris@3 34
Chris@3 35 </td>
Chris@3 36
Chris@3 37
Chris@3 38
Chris@3 39 </tr>
Chris@3 40 </tbody>
Chris@3 41 </table>
Chris@3 42 </div>
Chris@3 43
Chris@3 44 <!-- Generated by Doxygen 1.8.0 -->
Chris@3 45 <div id="navrow1" class="tabs">
Chris@3 46 <ul class="tablist">
Chris@3 47 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
Chris@3 48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
Chris@3 49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
Chris@3 50 <li><a href="files.html"><span>Files</span></a></li>
Chris@3 51 <li><a href="dirs.html"><span>Directories</span></a></li>
Chris@3 52 </ul>
Chris@3 53 </div>
Chris@3 54 <div id="navrow2" class="tabs2">
Chris@3 55 <ul class="tablist">
Chris@3 56 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
Chris@3 57 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
Chris@3 58 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
Chris@3 59 </ul>
Chris@3 60 </div>
Chris@3 61 </div>
Chris@3 62 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@3 63 <div id="nav-tree">
Chris@3 64 <div id="nav-tree-contents">
Chris@3 65 </div>
Chris@3 66 </div>
Chris@3 67 <div id="splitbar" style="-moz-user-select:none;"
Chris@3 68 class="ui-resizable-handle">
Chris@3 69 </div>
Chris@3 70 </div>
Chris@3 71 <script type="text/javascript">
Chris@3 72 initNavTree('classVamp_1_1FFT.html','');
Chris@3 73 </script>
Chris@3 74 <div id="doc-content">
Chris@3 75 <div class="header">
Chris@3 76 <div class="summary">
Chris@3 77 <a href="#pub-static-methods">Static Public Member Functions</a> </div>
Chris@3 78 <div class="headertitle">
Chris@3 79 <div class="title">Vamp::FFT Class Reference</div> </div>
Chris@3 80 </div><!--header-->
Chris@3 81 <div class="contents">
Chris@3 82
Chris@3 83 <p>A simple <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> implementation provided for convenience of plugin authors.
Chris@3 84 <a href="classVamp_1_1FFT.html#details">More...</a></p>
Chris@3 85
Chris@3 86 <p><code>#include &lt;<a class="el" href="FFT_8h_source.html">FFT.h</a>&gt;</code></p>
Chris@3 87
Chris@3 88 <p><a href="classVamp_1_1FFT-members.html">List of all members.</a></p>
Chris@3 89 <table class="memberdecls">
Chris@3 90 <tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Chris@3 91 Static Public Member Functions</h2></td></tr>
Chris@3 92 <tr class="memitem:a219e3f6f0392dbdacad4a47d912f9aca"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1FFT.html#a219e3f6f0392dbdacad4a47d912f9aca">forward</a> (unsigned int n, const double *ri, const double *ii, double *ro, double *io)</td></tr>
Chris@3 93 <tr class="memdesc:a219e3f6f0392dbdacad4a47d912f9aca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate a forward transform of size n. <a href="#a219e3f6f0392dbdacad4a47d912f9aca"></a><br/></td></tr>
Chris@3 94 <tr class="memitem:aff98a3610275024cd3cb421e6283ee7f"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1FFT.html#aff98a3610275024cd3cb421e6283ee7f">inverse</a> (unsigned int n, const double *ri, const double *ii, double *ro, double *io)</td></tr>
Chris@3 95 <tr class="memdesc:aff98a3610275024cd3cb421e6283ee7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate an inverse transform of size n. <a href="#aff98a3610275024cd3cb421e6283ee7f"></a><br/></td></tr>
Chris@3 96 </table>
Chris@3 97 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
Chris@3 98 <div class="textblock"><p>A simple <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> implementation provided for convenience of plugin authors. </p>
Chris@3 99 <p>This class provides double-precision FFTs in power-of-two sizes only. It is slower than more sophisticated library implementations. If these requirements aren't suitable, make other arrangements.</p>
Chris@3 100 <p>The inverse transform is scaled by 1/n.</p>
Chris@3 101 <p>The implementation is from Don Cross's public domain <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> code. </p>
Chris@3 102
Chris@3 103 <p>Definition at line <a class="el" href="FFT_8h_source.html#l00058">58</a> of file <a class="el" href="FFT_8h_source.html">FFT.h</a>.</p>
Chris@3 104 </div><hr/><h2>Member Function Documentation</h2>
Chris@3 105 <a class="anchor" id="a219e3f6f0392dbdacad4a47d912f9aca"></a>
Chris@3 106 <div class="memitem">
Chris@3 107 <div class="memproto">
Chris@3 108 <table class="memname">
Chris@3 109 <tr>
Chris@3 110 <td class="memname">static void <a class="el" href="classVamp_1_1FFT.html#a219e3f6f0392dbdacad4a47d912f9aca">Vamp::FFT::forward</a> </td>
Chris@3 111 <td>(</td>
Chris@3 112 <td class="paramtype">unsigned int&#160;</td>
Chris@3 113 <td class="paramname"><em>n</em>, </td>
Chris@3 114 </tr>
Chris@3 115 <tr>
Chris@3 116 <td class="paramkey"></td>
Chris@3 117 <td></td>
Chris@3 118 <td class="paramtype">const double *&#160;</td>
Chris@3 119 <td class="paramname"><em>ri</em>, </td>
Chris@3 120 </tr>
Chris@3 121 <tr>
Chris@3 122 <td class="paramkey"></td>
Chris@3 123 <td></td>
Chris@3 124 <td class="paramtype">const double *&#160;</td>
Chris@3 125 <td class="paramname"><em>ii</em>, </td>
Chris@3 126 </tr>
Chris@3 127 <tr>
Chris@3 128 <td class="paramkey"></td>
Chris@3 129 <td></td>
Chris@3 130 <td class="paramtype">double *&#160;</td>
Chris@3 131 <td class="paramname"><em>ro</em>, </td>
Chris@3 132 </tr>
Chris@3 133 <tr>
Chris@3 134 <td class="paramkey"></td>
Chris@3 135 <td></td>
Chris@3 136 <td class="paramtype">double *&#160;</td>
Chris@3 137 <td class="paramname"><em>io</em>&#160;</td>
Chris@3 138 </tr>
Chris@3 139 <tr>
Chris@3 140 <td></td>
Chris@3 141 <td>)</td>
Chris@3 142 <td></td><td><code> [static]</code></td>
Chris@3 143 </tr>
Chris@3 144 </table>
Chris@3 145 </div>
Chris@3 146 <div class="memdoc">
Chris@3 147
Chris@3 148 <p>Calculate a forward transform of size n. </p>
Chris@3 149 <p>ri and ii must point to the real and imaginary component arrays of the input. For real input, ii may be NULL.</p>
Chris@3 150 <p>ro and io must point to enough space to receive the real and imaginary component arrays of the output.</p>
Chris@3 151 <p>All input and output arrays are of size n. </p>
Chris@3 152
Chris@3 153 </div>
Chris@3 154 </div>
Chris@3 155 <a class="anchor" id="aff98a3610275024cd3cb421e6283ee7f"></a>
Chris@3 156 <div class="memitem">
Chris@3 157 <div class="memproto">
Chris@3 158 <table class="memname">
Chris@3 159 <tr>
Chris@3 160 <td class="memname">static void <a class="el" href="classVamp_1_1FFT.html#aff98a3610275024cd3cb421e6283ee7f">Vamp::FFT::inverse</a> </td>
Chris@3 161 <td>(</td>
Chris@3 162 <td class="paramtype">unsigned int&#160;</td>
Chris@3 163 <td class="paramname"><em>n</em>, </td>
Chris@3 164 </tr>
Chris@3 165 <tr>
Chris@3 166 <td class="paramkey"></td>
Chris@3 167 <td></td>
Chris@3 168 <td class="paramtype">const double *&#160;</td>
Chris@3 169 <td class="paramname"><em>ri</em>, </td>
Chris@3 170 </tr>
Chris@3 171 <tr>
Chris@3 172 <td class="paramkey"></td>
Chris@3 173 <td></td>
Chris@3 174 <td class="paramtype">const double *&#160;</td>
Chris@3 175 <td class="paramname"><em>ii</em>, </td>
Chris@3 176 </tr>
Chris@3 177 <tr>
Chris@3 178 <td class="paramkey"></td>
Chris@3 179 <td></td>
Chris@3 180 <td class="paramtype">double *&#160;</td>
Chris@3 181 <td class="paramname"><em>ro</em>, </td>
Chris@3 182 </tr>
Chris@3 183 <tr>
Chris@3 184 <td class="paramkey"></td>
Chris@3 185 <td></td>
Chris@3 186 <td class="paramtype">double *&#160;</td>
Chris@3 187 <td class="paramname"><em>io</em>&#160;</td>
Chris@3 188 </tr>
Chris@3 189 <tr>
Chris@3 190 <td></td>
Chris@3 191 <td>)</td>
Chris@3 192 <td></td><td><code> [static]</code></td>
Chris@3 193 </tr>
Chris@3 194 </table>
Chris@3 195 </div>
Chris@3 196 <div class="memdoc">
Chris@3 197
Chris@3 198 <p>Calculate an inverse transform of size n. </p>
Chris@3 199 <p>ri and ii must point to the real and imaginary component arrays of the input. For real input, ii may be NULL.</p>
Chris@3 200 <p>ro and io must point to enough space to receive the real and imaginary component arrays of the output. The output is scaled by 1/n. The output pointers may not be NULL, even if the output is expected to be real.</p>
Chris@3 201 <p>All input and output arrays are of size n. </p>
Chris@3 202
Chris@3 203 </div>
Chris@3 204 </div>
Chris@3 205 <hr/>The documentation for this class was generated from the following file:<ul>
Chris@3 206 <li><a class="el" href="FFT_8h_source.html">FFT.h</a></li>
Chris@3 207 </ul>
Chris@3 208 </div><!-- contents -->
Chris@3 209 </div>
Chris@3 210 <div id="nav-path" class="navpath">
Chris@3 211 <ul>
Chris@3 212 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
Chris@3 213 <li class="navelem"><a class="el" href="classVamp_1_1FFT.html">FFT</a> </li>
Chris@3 214
Chris@3 215 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by
Chris@3 216 <a href="http://www.doxygen.org/index.html">
Chris@3 217 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
Chris@3 218 </ul>
Chris@3 219 </div>
Chris@3 220
Chris@3 221
Chris@3 222 </body>
Chris@3 223 </html>