Official ARM version: v5.6.0HEADmaster

1 files changed, 33 insertions, 41 deletions

diff --git a/docs/DSP/html/arm__cfft__q15_8c.html b/docs/DSP/html/arm__cfft__q15_8c.html
index 7f45d3d..011e694 100644
--- a/docs/DSP/html/arm__cfft__q15_8c.html
+++ b/docs/DSP/html/arm__cfft__q15_8c.html
@@ -32,7 +32,7 @@
   <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
   <td style="padding-left: 0.5em;">
    <div id="projectname">CMSIS-DSP
-   &#160;<span id="projectnumber">Version 1.5.2</span>
+   &#160;<span id="projectnumber">Version 1.7.0</span>
    </div>
    <div id="projectbrief">CMSIS DSP Software Library</div>
   </td>
@@ -116,20 +116,21 @@ $(document).ready(function(){initNavTree('arm__cfft__q15_8c.html','');});
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
-<tr class="memitem:abf1a2f9aa9f44ad5da1f0dbae8b54f2f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__q15_8c.html#abf1a2f9aa9f44ad5da1f0dbae8b54f2f">arm_radix4_butterfly_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrc, uint32_t fftLen, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pCoef, uint32_t twidCoefModifier)</td></tr>
-<tr class="memdesc:abf1a2f9aa9f44ad5da1f0dbae8b54f2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core function for the Q15 CFFT butterfly process.  <a href="#abf1a2f9aa9f44ad5da1f0dbae8b54f2f">More...</a><br/></td></tr>
-<tr class="separator:abf1a2f9aa9f44ad5da1f0dbae8b54f2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a734ecff00f21a6a10e9ec437c8987eb1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__q15_8c.html#a734ecff00f21a6a10e9ec437c8987eb1">arm_radix4_butterfly_inverse_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrc, uint32_t fftLen, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pCoef, uint32_t twidCoefModifier)</td></tr>
-<tr class="memdesc:a734ecff00f21a6a10e9ec437c8987eb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core function for the Q15 CIFFT butterfly process.  <a href="#a734ecff00f21a6a10e9ec437c8987eb1">More...</a><br/></td></tr>
-<tr class="separator:a734ecff00f21a6a10e9ec437c8987eb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a10af006080b7c9872dd9a538b79040da"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__q15_8c.html#a10af006080b7c9872dd9a538b79040da">arm_radix4_butterfly_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrc, uint32_t fftLen, const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pCoef, uint32_t twidCoefModifier)</td></tr>
+<tr class="memdesc:a10af006080b7c9872dd9a538b79040da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core function for the Q15 CFFT butterfly process.  <a href="#a10af006080b7c9872dd9a538b79040da">More...</a><br/></td></tr>
+<tr class="separator:a10af006080b7c9872dd9a538b79040da"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a9c0708cce16e3f17a5a616c71fd17ec5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__q15_8c.html#a9c0708cce16e3f17a5a616c71fd17ec5">arm_radix4_butterfly_inverse_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrc, uint32_t fftLen, const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pCoef, uint32_t twidCoefModifier)</td></tr>
+<tr class="memdesc:a9c0708cce16e3f17a5a616c71fd17ec5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core function for the Q15 CIFFT butterfly process.  <a href="#a9c0708cce16e3f17a5a616c71fd17ec5">More...</a><br/></td></tr>
+<tr class="separator:a9c0708cce16e3f17a5a616c71fd17ec5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a773957c278f4d9e728711f27e8a6e278"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__q15_8c.html#a773957c278f4d9e728711f27e8a6e278">arm_bitreversal_16</a> (uint16_t *pSrc, const uint16_t bitRevLen, const uint16_t *pBitRevTable)</td></tr>
+<tr class="memdesc:a773957c278f4d9e728711f27e8a6e278"><td class="mdescLeft">&#160;</td><td class="mdescRight">In-place 16 bit reversal function.  <a href="#a773957c278f4d9e728711f27e8a6e278">More...</a><br/></td></tr>
 <tr class="separator:a773957c278f4d9e728711f27e8a6e278"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:af1d4a751153857c173511e0c77ab4fa9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__q15_8c.html#af1d4a751153857c173511e0c77ab4fa9">arm_cfft_radix4by2_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrc, uint32_t fftLen, const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pCoef)</td></tr>
 <tr class="separator:af1d4a751153857c173511e0c77ab4fa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:abe669acc8db57d1fb9b1e2bba30f2224"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__q15_8c.html#abe669acc8db57d1fb9b1e2bba30f2224">arm_cfft_radix4by2_inverse_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrc, uint32_t fftLen, const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pCoef)</td></tr>
 <tr class="separator:abe669acc8db57d1fb9b1e2bba30f2224"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga68cdacd2267a2967955e40e6b7ec1229"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ComplexFFT.html#ga68cdacd2267a2967955e40e6b7ec1229">arm_cfft_q15</a> (const <a class="el" href="structarm__cfft__instance__q15.html">arm_cfft_instance_q15</a> *S, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *p1, uint8_t <a class="el" href="arm__fft__bin__example__f32_8c.html#a379ccb99013d369a41b49619083c16ef">ifftFlag</a>, uint8_t bitReverseFlag)</td></tr>
-<tr class="memdesc:ga68cdacd2267a2967955e40e6b7ec1229"><td class="mdescLeft">&#160;</td><td class="mdescRight">Processing function for the Q15 complex FFT.  <a href="group__ComplexFFT.html#ga68cdacd2267a2967955e40e6b7ec1229">More...</a><br/></td></tr>
+<tr class="memdesc:ga68cdacd2267a2967955e40e6b7ec1229"><td class="mdescLeft">&#160;</td><td class="mdescRight">Processing function for Q15 complex FFT.  <a href="group__ComplexFFT.html#ga68cdacd2267a2967955e40e6b7ec1229">More...</a><br/></td></tr>
 <tr class="separator:ga68cdacd2267a2967955e40e6b7ec1229"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Function Documentation</h2>
@@ -153,7 +154,7 @@ Functions</h2></td></tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">const uint16_t *&#160;</td>
-          <td class="paramname"><em>pBitRevTable</em>&#160;</td>
+          <td class="paramname"><em>pBitRevTab</em>&#160;</td>
         </tr>
         <tr>
           <td></td>
@@ -162,8 +163,15 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-
-<p>Referenced by <a class="el" href="group__ComplexFFT.html#ga68cdacd2267a2967955e40e6b7ec1229">arm_cfft_q15()</a>.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">pSrc</td><td>points to in-place buffer of unknown 16-bit data type </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">bitRevLen</td><td>bit reversal table length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">pBitRevTab</td><td>points to bit reversal table </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
 
 </div>
 </div>
@@ -197,10 +205,6 @@ Functions</h2></td></tr>
       </table>
 </div><div class="memdoc">
 
-<p>References <a class="el" href="arm__math_8h.html#a15e896d0146c280e600d00f609832350">__QSUB()</a>, <a class="el" href="arm__math_8h.html#a6e4703dc08d1b82eab7f5ef96edb59bb">__QSUB16()</a>, <a class="el" href="arm__math_8h.html#af3d7aff37a4472f1f2bc88eb3b97b526">__SHADD16()</a>, <a class="el" href="arm__math_8h.html#a9c58d7b4648a973d91e27544bc190e60">__SMUADX()</a>, <a class="el" href="arm__math_8h.html#a6b293f62ad7eb225fa9ce0f39458eba3">__SMUSD()</a>, <a class="el" href="arm__math_8h.html#af0d54ec57b936994a34f073d0049ea3f">_SIMD32_OFFSET</a>, and <a class="el" href="arm__cfft__q15_8c.html#a734ecff00f21a6a10e9ec437c8987eb1">arm_radix4_butterfly_inverse_q15()</a>.</p>
-
-<p>Referenced by <a class="el" href="group__ComplexFFT.html#ga68cdacd2267a2967955e40e6b7ec1229">arm_cfft_q15()</a>.</p>
-
 </div>
 </div>
 <a class="anchor" id="af1d4a751153857c173511e0c77ab4fa9"></a>
@@ -234,13 +238,9 @@ Functions</h2></td></tr>
 </div><div class="memdoc">
 <p>end of ComplexFFT group </p>
 
-<p>References <a class="el" href="arm__math_8h.html#a6e4703dc08d1b82eab7f5ef96edb59bb">__QSUB16()</a>, <a class="el" href="arm__math_8h.html#af3d7aff37a4472f1f2bc88eb3b97b526">__SHADD16()</a>, <a class="el" href="arm__math_8h.html#a2eed05660fedbe3fbd0b6dbb1315cfc3">__SMUAD()</a>, <a class="el" href="arm__math_8h.html#a7375d1deba32929dc97008bfa7085d46">__SMUSDX()</a>, <a class="el" href="arm__math_8h.html#af0d54ec57b936994a34f073d0049ea3f">_SIMD32_OFFSET</a>, and <a class="el" href="arm__cfft__q15_8c.html#abf1a2f9aa9f44ad5da1f0dbae8b54f2f">arm_radix4_butterfly_q15()</a>.</p>
-
-<p>Referenced by <a class="el" href="group__ComplexFFT.html#ga68cdacd2267a2967955e40e6b7ec1229">arm_cfft_q15()</a>.</p>
-
 </div>
 </div>
-<a class="anchor" id="a734ecff00f21a6a10e9ec437c8987eb1"></a>
+<a class="anchor" id="a9c0708cce16e3f17a5a616c71fd17ec5"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
@@ -259,7 +259,7 @@ Functions</h2></td></tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
+          <td class="paramtype">const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
           <td class="paramname"><em>pCoef16</em>, </td>
         </tr>
         <tr>
@@ -277,22 +277,18 @@ Functions</h2></td></tr>
 </div><div class="memdoc">
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in,out]</td><td class="paramname">*pSrc16</td><td>points to the in-place buffer of Q15 data type. </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">fftLen</td><td>length of the FFT. </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*pCoef16</td><td>points to twiddle coefficient buffer. </td></tr>
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">pSrc16</td><td>points to the in-place buffer of Q15 data type </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">fftLen</td><td>length of the FFT </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">pCoef16</td><td>points to twiddle coefficient buffer </td></tr>
     <tr><td class="paramdir">[in]</td><td class="paramname">twidCoefModifier</td><td>twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table. </td></tr>
   </table>
   </dd>
 </dl>
-<dl class="section return"><dt>Returns</dt><dd>none. </dd></dl>
-
-<p>References <a class="el" href="arm__math_8h.html#a08bea9cb2c311d925224c0d6829edb8c">__QADD16()</a>, <a class="el" href="arm__math_8h.html#aad6f7afa72d784b95e6357c215a919bb">__QASX()</a>, <a class="el" href="arm__math_8h.html#a391f5f1d2e7cefaccfece0a49141ad47">__QSAX()</a>, <a class="el" href="arm__math_8h.html#a6e4703dc08d1b82eab7f5ef96edb59bb">__QSUB16()</a>, <a class="el" href="arm__math_8h.html#af3d7aff37a4472f1f2bc88eb3b97b526">__SHADD16()</a>, <a class="el" href="arm__math_8h.html#af60f220d422ebc524411f712544feecf">__SHASX()</a>, <a class="el" href="arm__math_8h.html#abbfbf3cfac1971b4b380c0cde120a85b">__SHSAX()</a>, <a class="el" href="arm__math_8h.html#a0987d147320a596bbdb537d70b23de73">__SHSUB16()</a>, <a class="el" href="arm__math_8h.html#a9de2e0a5785be82866bcb96012282248">__SIMD32</a>, <a class="el" href="arm__math_8h.html#a9c58d7b4648a973d91e27544bc190e60">__SMUADX()</a>, <a class="el" href="arm__math_8h.html#a6b293f62ad7eb225fa9ce0f39458eba3">__SMUSD()</a>, and <a class="el" href="arm__math_8h.html#af0d54ec57b936994a34f073d0049ea3f">_SIMD32_OFFSET</a>.</p>
-
-<p>Referenced by <a class="el" href="group__ComplexFFT.html#ga68cdacd2267a2967955e40e6b7ec1229">arm_cfft_q15()</a>, <a class="el" href="group__ComplexFFT.html#ga8d66cdac41b8bf6cefdb895456eee84a">arm_cfft_radix4_q15()</a>, and <a class="el" href="arm__cfft__q15_8c.html#abe669acc8db57d1fb9b1e2bba30f2224">arm_cfft_radix4by2_inverse_q15()</a>.</p>
+<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
 
 </div>
 </div>
-<a class="anchor" id="abf1a2f9aa9f44ad5da1f0dbae8b54f2f"></a>
+<a class="anchor" id="a10af006080b7c9872dd9a538b79040da"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
@@ -311,7 +307,7 @@ Functions</h2></td></tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
+          <td class="paramtype">const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
           <td class="paramname"><em>pCoef16</em>, </td>
         </tr>
         <tr>
@@ -330,18 +326,14 @@ Functions</h2></td></tr>
 <p>end of ComplexFFT group </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in,out]</td><td class="paramname">*pSrc16</td><td>points to the in-place buffer of Q15 data type. </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">fftLen</td><td>length of the FFT. </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*pCoef16</td><td>points to twiddle coefficient buffer. </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">twidCoefModifier</td><td>twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table. </td></tr>
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">pSrc16</td><td>points to the in-place buffer of Q15 data type </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">fftLen</td><td>length of the FFT </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">pCoef16</td><td>points to twiddle coefficient buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">twidCoefModifier</td><td>twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table </td></tr>
   </table>
   </dd>
 </dl>
-<dl class="section return"><dt>Returns</dt><dd>none. </dd></dl>
-
-<p>References <a class="el" href="arm__math_8h.html#a08bea9cb2c311d925224c0d6829edb8c">__QADD16()</a>, <a class="el" href="arm__math_8h.html#aad6f7afa72d784b95e6357c215a919bb">__QASX()</a>, <a class="el" href="arm__math_8h.html#a391f5f1d2e7cefaccfece0a49141ad47">__QSAX()</a>, <a class="el" href="arm__math_8h.html#a6e4703dc08d1b82eab7f5ef96edb59bb">__QSUB16()</a>, <a class="el" href="arm__math_8h.html#af3d7aff37a4472f1f2bc88eb3b97b526">__SHADD16()</a>, <a class="el" href="arm__math_8h.html#af60f220d422ebc524411f712544feecf">__SHASX()</a>, <a class="el" href="arm__math_8h.html#abbfbf3cfac1971b4b380c0cde120a85b">__SHSAX()</a>, <a class="el" href="arm__math_8h.html#a0987d147320a596bbdb537d70b23de73">__SHSUB16()</a>, <a class="el" href="arm__math_8h.html#a9de2e0a5785be82866bcb96012282248">__SIMD32</a>, <a class="el" href="arm__math_8h.html#a2eed05660fedbe3fbd0b6dbb1315cfc3">__SMUAD()</a>, <a class="el" href="arm__math_8h.html#a7375d1deba32929dc97008bfa7085d46">__SMUSDX()</a>, and <a class="el" href="arm__math_8h.html#af0d54ec57b936994a34f073d0049ea3f">_SIMD32_OFFSET</a>.</p>
-
-<p>Referenced by <a class="el" href="group__ComplexFFT.html#ga68cdacd2267a2967955e40e6b7ec1229">arm_cfft_q15()</a>, <a class="el" href="group__ComplexFFT.html#ga8d66cdac41b8bf6cefdb895456eee84a">arm_cfft_radix4_q15()</a>, and <a class="el" href="arm__cfft__q15_8c.html#af1d4a751153857c173511e0c77ab4fa9">arm_cfft_radix4by2_q15()</a>.</p>
+<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
 
 </div>
 </div>
@@ -351,7 +343,7 @@ Functions</h2></td></tr>
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_650d82db24a6311fa7658fced19ae149.html">DSP</a></li><li class="navelem"><a class="el" href="dir_cf3b734d050ceea02fbfb06f215bbc8f.html">Source</a></li><li class="navelem"><a class="el" href="dir_f93595924be31e3058e32faa649f9f3e.html">TransformFunctions</a></li><li class="navelem"><a class="el" href="arm__cfft__q15_8c.html">arm_cfft_q15.c</a></li>
-    <li class="footer">Generated on Wed Aug 1 2018 17:12:20 for CMSIS-DSP by Arm Ltd. All rights reserved.
+    <li class="footer">Generated on Wed Jul 10 2019 15:20:38 for CMSIS-DSP Version 1.7.0 by Arm Ltd. All rights reserved.
 	<!--
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6