Mercurial > hg > vamp-docs
diff code-docs/classVamp_1_1FFT.html @ 6:27319718b1f8 vamp-plugin-sdk-v2.7
Update code docs to v2.7 SDK
| author | Chris Cannam |
|---|---|
| date | Fri, 24 Feb 2017 16:44:47 +0000 |
| parents | 5c2683745b33 |
| children |
line wrap: on
line diff
--- a/code-docs/classVamp_1_1FFT.html Tue Dec 03 16:43:33 2013 +0000 +++ b/code-docs/classVamp_1_1FFT.html Fri Feb 24 16:44:47 2017 +0000 @@ -3,65 +3,51 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> <title>VampPluginSDK: Vamp::FFT Class Reference</title> - <link href="tabs.css" rel="stylesheet" type="text/css"/> -<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> - - +<link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> -<div id="top"><!-- do not remove this div! --> - - +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> - - - <td style="padding-left: 0.5em;"> + <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">VampPluginSDK -  <span id="projectnumber">2.4</span> +  <span id="projectnumber">2.7</span> </div> - </td> - - - </tr> </tbody> </table> </div> - -<!-- Generated by Doxygen 1.8.0 --> - <div id="navrow1" class="tabs"> - <ul class="tablist"> - <li><a href="index.html"><span>Main Page</span></a></li> - <li><a href="namespaces.html"><span>Namespaces</span></a></li> - <li class="current"><a href="annotated.html"><span>Classes</span></a></li> - <li><a href="files.html"><span>Files</span></a></li> - <li><a href="dirs.html"><span>Directories</span></a></li> - </ul> - </div> - <div id="navrow2" class="tabs2"> - <ul class="tablist"> - <li><a href="annotated.html"><span>Class List</span></a></li> - <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> - <li><a href="functions.html"><span>Class Members</span></a></li> - </ul> - </div> -</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',false,false,'search.php','Search'); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" @@ -69,45 +55,51 @@ </div> </div> <script type="text/javascript"> - initNavTree('classVamp_1_1FFT.html',''); +$(document).ready(function(){initNavTree('classVamp_1_1FFT.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> -<a href="#pub-static-methods">Static Public Member Functions</a> </div> +<a href="#pub-static-methods">Static Public Member Functions</a> | +<a href="classVamp_1_1FFT-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Vamp::FFT Class Reference</div> </div> </div><!--header--> <div class="contents"> -<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>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. <a href="classVamp_1_1FFT.html#details">More...</a></p> <p><code>#include <<a class="el" href="FFT_8h_source.html">FFT.h</a>></code></p> - -<p><a href="classVamp_1_1FFT-members.html">List of all members.</a></p> <table class="memberdecls"> -<tr><td colspan="2"><h2><a name="pub-static-methods"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:a219e3f6f0392dbdacad4a47d912f9aca"><td class="memItemLeft" align="right" valign="top">static void </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> -<tr class="memdesc:a219e3f6f0392dbdacad4a47d912f9aca"><td class="mdescLeft"> </td><td class="mdescRight">Calculate a forward transform of size n. <a href="#a219e3f6f0392dbdacad4a47d912f9aca"></a><br/></td></tr> +<tr class="memdesc:a219e3f6f0392dbdacad4a47d912f9aca"><td class="mdescLeft"> </td><td class="mdescRight">Calculate a one-shot forward transform of size n. <a href="#a219e3f6f0392dbdacad4a47d912f9aca">More...</a><br /></td></tr> +<tr class="separator:a219e3f6f0392dbdacad4a47d912f9aca"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aff98a3610275024cd3cb421e6283ee7f"><td class="memItemLeft" align="right" valign="top">static void </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> -<tr class="memdesc:aff98a3610275024cd3cb421e6283ee7f"><td class="mdescLeft"> </td><td class="mdescRight">Calculate an inverse transform of size n. <a href="#aff98a3610275024cd3cb421e6283ee7f"></a><br/></td></tr> +<tr class="memdesc:aff98a3610275024cd3cb421e6283ee7f"><td class="mdescLeft"> </td><td class="mdescRight">Calculate a one-shot inverse transform of size n. <a href="#aff98a3610275024cd3cb421e6283ee7f">More...</a><br /></td></tr> +<tr class="separator:aff98a3610275024cd3cb421e6283ee7f"><td class="memSeparator" colspan="2"> </td></tr> </table> -<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> -<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> -<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> -<p>The inverse transform is scaled by 1/n.</p> -<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> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<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> +<p>This class provides one-shot (i.e. fixed table state is recalculated every time) double-precision complex-complex transforms. For repeated transforms from real time-domain data, use an <a class="el" href="classVamp_1_1FFTComplex.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFTComplex</a> or <a class="el" href="classVamp_1_1FFTReal.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFTReal</a> object instead.</p> +<p>Note: If the SDK has been compiled with the SINGLE_PRECISION_FFT flag, then all FFTs will use single precision internally. The default is double precision. The API uses doubles in either case.</p> +<p>The forward transform is unscaled; the inverse transform is scaled by 1/n. </p> -<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> -</div><hr/><h2>Member Function Documentation</h2> -<a class="anchor" id="a219e3f6f0392dbdacad4a47d912f9aca"></a> +<p class="definition">Definition at line <a class="el" href="FFT_8h_source.html#l00059">59</a> of file <a class="el" href="FFT_8h_source.html">FFT.h</a>.</p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a219e3f6f0392dbdacad4a47d912f9aca"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a219e3f6f0392dbdacad4a47d912f9aca">◆ </a></span>forward()</h2> + <div class="memitem"> <div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">static void <a class="el" href="classVamp_1_1FFT.html#a219e3f6f0392dbdacad4a47d912f9aca">Vamp::FFT::forward</a> </td> + <td class="memname">static void Vamp::FFT::forward </td> <td>(</td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>n</em>, </td> @@ -139,25 +131,35 @@ <tr> <td></td> <td>)</td> - <td></td><td><code> [static]</code></td> + <td></td><td></td> </tr> </table> -</div> -<div class="memdoc"> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> -<p>Calculate a forward transform of size n. </p> +<p>Calculate a one-shot forward transform of size n. </p> +<p>n must be a multiple of 2.</p> <p>ri and ii must point to the real and imaginary component arrays of the input. For real input, ii may be NULL.</p> <p>ro and io must point to enough space to receive the real and imaginary component arrays of the output.</p> <p>All input and output arrays are of size n. </p> </div> </div> -<a class="anchor" id="aff98a3610275024cd3cb421e6283ee7f"></a> +<a id="aff98a3610275024cd3cb421e6283ee7f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aff98a3610275024cd3cb421e6283ee7f">◆ </a></span>inverse()</h2> + <div class="memitem"> <div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">static void <a class="el" href="classVamp_1_1FFT.html#aff98a3610275024cd3cb421e6283ee7f">Vamp::FFT::inverse</a> </td> + <td class="memname">static void Vamp::FFT::inverse </td> <td>(</td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>n</em>, </td> @@ -189,13 +191,18 @@ <tr> <td></td> <td>)</td> - <td></td><td><code> [static]</code></td> + <td></td><td></td> </tr> </table> -</div> -<div class="memdoc"> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> -<p>Calculate an inverse transform of size n. </p> +<p>Calculate a one-shot inverse transform of size n. </p> +<p>n must be a power of 2, greater than 1.</p> <p>ri and ii must point to the real and imaginary component arrays of the input. For real input, ii may be NULL.</p> <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> <p>All input and output arrays are of size n. </p> @@ -206,18 +213,15 @@ <li><a class="el" href="FFT_8h_source.html">FFT.h</a></li> </ul> </div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a></li><li class="navelem"><a class="el" href="classVamp_1_1FFT.html">FFT</a></li> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> </div> - <div id="nav-path" class="navpath"> - <ul> - <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> - <li class="navelem"><a class="el" href="classVamp_1_1FFT.html">FFT</a> </li> - - <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by - <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> - </ul> - </div> - - </body> </html>