Mercurial > hg > vamp-docs

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