Official ARM version: v5.6.0HEADmaster

1 files changed, 30 insertions, 38 deletions

diff --git a/docs/DSP/html/arm__cfft__q31_8c.html b/docs/DSP/html/arm__cfft__q31_8c.html
index f8f61a5..e27b36a 100644
--- a/docs/DSP/html/arm__cfft__q31_8c.html
+++ b/docs/DSP/html/arm__cfft__q31_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__q31_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:ac12f1e7f159d5741358cdc36830a0395"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__q31_8c.html#ac12f1e7f159d5741358cdc36830a0395">arm_radix4_butterfly_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, uint32_t fftLen, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pCoef, uint32_t twidCoefModifier)</td></tr>
-<tr class="memdesc:ac12f1e7f159d5741358cdc36830a0395"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core function for the Q31 CFFT butterfly process.  <a href="#ac12f1e7f159d5741358cdc36830a0395">More...</a><br/></td></tr>
-<tr class="separator:ac12f1e7f159d5741358cdc36830a0395"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ac9c7c553114c1201a3a987a11b8a6d01"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__q31_8c.html#ac9c7c553114c1201a3a987a11b8a6d01">arm_radix4_butterfly_inverse_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, uint32_t fftLen, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pCoef, uint32_t twidCoefModifier)</td></tr>
-<tr class="memdesc:ac9c7c553114c1201a3a987a11b8a6d01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core function for the Q31 CIFFT butterfly process.  <a href="#ac9c7c553114c1201a3a987a11b8a6d01">More...</a><br/></td></tr>
-<tr class="separator:ac9c7c553114c1201a3a987a11b8a6d01"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:af4d3481332146c3c703bf494baf23c45"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__q31_8c.html#af4d3481332146c3c703bf494baf23c45">arm_radix4_butterfly_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, uint32_t fftLen, const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pCoef, uint32_t twidCoefModifier)</td></tr>
+<tr class="memdesc:af4d3481332146c3c703bf494baf23c45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core function for the Q31 CFFT butterfly process.  <a href="#af4d3481332146c3c703bf494baf23c45">More...</a><br/></td></tr>
+<tr class="separator:af4d3481332146c3c703bf494baf23c45"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a053363aef7c6b41a61af7730c638c79b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__q31_8c.html#a053363aef7c6b41a61af7730c638c79b">arm_radix4_butterfly_inverse_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, uint32_t fftLen, const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pCoef, uint32_t twidCoefModifier)</td></tr>
+<tr class="memdesc:a053363aef7c6b41a61af7730c638c79b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core function for the Q31 CIFFT butterfly process.  <a href="#a053363aef7c6b41a61af7730c638c79b">More...</a><br/></td></tr>
+<tr class="separator:a053363aef7c6b41a61af7730c638c79b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ac8e7ebe1cb131a5b0f55d0464640591f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__q31_8c.html#ac8e7ebe1cb131a5b0f55d0464640591f">arm_bitreversal_32</a> (uint32_t *pSrc, const uint16_t bitRevLen, const uint16_t *pBitRevTable)</td></tr>
+<tr class="memdesc:ac8e7ebe1cb131a5b0f55d0464640591f"><td class="mdescLeft">&#160;</td><td class="mdescRight">In-place 32 bit reversal function.  <a href="#ac8e7ebe1cb131a5b0f55d0464640591f">More...</a><br/></td></tr>
 <tr class="separator:ac8e7ebe1cb131a5b0f55d0464640591f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:af6df8bf714c30d44e6b871ea87d22b30"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__q31_8c.html#af6df8bf714c30d44e6b871ea87d22b30">arm_cfft_radix4by2_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, uint32_t fftLen, const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pCoef)</td></tr>
 <tr class="separator:af6df8bf714c30d44e6b871ea87d22b30"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a3f3ae10bc2057cc1360abfa25f224c8c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__q31_8c.html#a3f3ae10bc2057cc1360abfa25f224c8c">arm_cfft_radix4by2_inverse_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, uint32_t fftLen, const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pCoef)</td></tr>
 <tr class="separator:a3f3ae10bc2057cc1360abfa25f224c8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga5a0008bd997ab6e2e299ef2fb272fb4b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ComplexFFT.html#ga5a0008bd997ab6e2e299ef2fb272fb4b">arm_cfft_q31</a> (const <a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</a> *S, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_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:ga5a0008bd997ab6e2e299ef2fb272fb4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Processing function for the fixed-point complex FFT in Q31 format.  <a href="group__ComplexFFT.html#ga5a0008bd997ab6e2e299ef2fb272fb4b">More...</a><br/></td></tr>
+<tr class="memdesc:ga5a0008bd997ab6e2e299ef2fb272fb4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Processing function for the Q31 complex FFT.  <a href="group__ComplexFFT.html#ga5a0008bd997ab6e2e299ef2fb272fb4b">More...</a><br/></td></tr>
 <tr class="separator:ga5a0008bd997ab6e2e299ef2fb272fb4b"><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#ga5a0008bd997ab6e2e299ef2fb272fb4b">arm_cfft_q31()</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 32-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__cfft__q31_8c.html#ac9c7c553114c1201a3a987a11b8a6d01">arm_radix4_butterfly_inverse_q31()</a>, <a class="el" href="arm__math_8h.html#a960f210642058d2b3d5368729a6e8375">mult_32x32_keep32_R</a>, <a class="el" href="arm__math_8h.html#aba3e538352fc7f9d6d15f9a18d469399">multAcc_32x32_keep32_R</a>, and <a class="el" href="arm__math_8h.html#a668fbf1cd1c3bc8faf1b1c83964ade23">multSub_32x32_keep32_R</a>.</p>
-
-<p>Referenced by <a class="el" href="group__ComplexFFT.html#ga5a0008bd997ab6e2e299ef2fb272fb4b">arm_cfft_q31()</a>.</p>
-
 </div>
 </div>
 <a class="anchor" id="af6df8bf714c30d44e6b871ea87d22b30"></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__cfft__q31_8c.html#ac12f1e7f159d5741358cdc36830a0395">arm_radix4_butterfly_q31()</a>, <a class="el" href="arm__math_8h.html#a960f210642058d2b3d5368729a6e8375">mult_32x32_keep32_R</a>, <a class="el" href="arm__math_8h.html#aba3e538352fc7f9d6d15f9a18d469399">multAcc_32x32_keep32_R</a>, and <a class="el" href="arm__math_8h.html#a668fbf1cd1c3bc8faf1b1c83964ade23">multSub_32x32_keep32_R</a>.</p>
-
-<p>Referenced by <a class="el" href="group__ComplexFFT.html#ga5a0008bd997ab6e2e299ef2fb272fb4b">arm_cfft_q31()</a>.</p>
-
 </div>
 </div>
-<a class="anchor" id="ac9c7c553114c1201a3a987a11b8a6d01"></a>
+<a class="anchor" id="a053363aef7c6b41a61af7730c638c79b"></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#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
+          <td class="paramtype">const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
           <td class="paramname"><em>pCoef</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">*pSrc</td><td>points to the in-place buffer of Q31 data type. </td></tr>
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">pSrc</td><td>points to the in-place buffer of Q31 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">*pCoef</td><td>points to twiddle coefficient buffer. </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">pCoef</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#ad1b053da364f9fd82ca1a381df7590b6">__SIMD64</a>.</p>
-
-<p>Referenced by <a class="el" href="group__ComplexFFT.html#ga5a0008bd997ab6e2e299ef2fb272fb4b">arm_cfft_q31()</a>, <a class="el" href="group__ComplexFFT.html#gafde3ee1f58cf393b45a9073174fff548">arm_cfft_radix4_q31()</a>, and <a class="el" href="arm__cfft__q31_8c.html#a3f3ae10bc2057cc1360abfa25f224c8c">arm_cfft_radix4by2_inverse_q31()</a>.</p>
+<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
 
 </div>
 </div>
-<a class="anchor" id="ac12f1e7f159d5741358cdc36830a0395"></a>
+<a class="anchor" id="af4d3481332146c3c703bf494baf23c45"></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#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
+          <td class="paramtype">const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
           <td class="paramname"><em>pCoef</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">*pSrc</td><td>points to the in-place buffer of Q31 data type. </td></tr>
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">pSrc</td><td>points to the in-place buffer of Q31 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">*pCoef</td><td>points to twiddle coefficient buffer. </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">pCoef</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#ad1b053da364f9fd82ca1a381df7590b6">__SIMD64</a>.</p>
-
-<p>Referenced by <a class="el" href="group__ComplexFFT.html#ga5a0008bd997ab6e2e299ef2fb272fb4b">arm_cfft_q31()</a>, <a class="el" href="group__ComplexFFT.html#gafde3ee1f58cf393b45a9073174fff548">arm_cfft_radix4_q31()</a>, and <a class="el" href="arm__cfft__q31_8c.html#af6df8bf714c30d44e6b871ea87d22b30">arm_cfft_radix4by2_q31()</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__q31_8c.html">arm_cfft_q31.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