Official ARM version: v5.6.0HEADmaster

1 files changed, 38 insertions, 49 deletions

diff --git a/docs/DSP/html/group__q31__to__x.html b/docs/DSP/html/group__q31__to__x.html
index a08d6ea..1ba4cd3 100644
--- a/docs/DSP/html/group__q31__to__x.html
+++ b/docs/DSP/html/group__q31__to__x.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,26 +116,26 @@ $(document).ready(function(){initNavTree('group__q31__to__x.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:gacf407b007a37da18e99dabd9023c56b4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__q31__to__x.html#gacf407b007a37da18e99dabd9023c56b4">arm_q31_to_float</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
-<tr class="memdesc:gacf407b007a37da18e99dabd9023c56b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the elements of the Q31 vector to floating-point vector.  <a href="#gacf407b007a37da18e99dabd9023c56b4">More...</a><br/></td></tr>
-<tr class="separator:gacf407b007a37da18e99dabd9023c56b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga901dede4661365c9e7c630d3eb31c32c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__q31__to__x.html#ga901dede4661365c9e7c630d3eb31c32c">arm_q31_to_q15</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
-<tr class="memdesc:ga901dede4661365c9e7c630d3eb31c32c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the elements of the Q31 vector to Q15 vector.  <a href="#ga901dede4661365c9e7c630d3eb31c32c">More...</a><br/></td></tr>
-<tr class="separator:ga901dede4661365c9e7c630d3eb31c32c"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga7f297d1a7d776805395095fdb24a8071"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__q31__to__x.html#ga7f297d1a7d776805395095fdb24a8071">arm_q31_to_q7</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
-<tr class="memdesc:ga7f297d1a7d776805395095fdb24a8071"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the elements of the Q31 vector to Q7 vector.  <a href="#ga7f297d1a7d776805395095fdb24a8071">More...</a><br/></td></tr>
-<tr class="separator:ga7f297d1a7d776805395095fdb24a8071"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga19a9d023aca1f99abd5da6f13a42b6cf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__q31__to__x.html#ga19a9d023aca1f99abd5da6f13a42b6cf">arm_q31_to_float</a> (const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
+<tr class="memdesc:ga19a9d023aca1f99abd5da6f13a42b6cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the elements of the Q31 vector to floating-point vector.  <a href="#ga19a9d023aca1f99abd5da6f13a42b6cf">More...</a><br/></td></tr>
+<tr class="separator:ga19a9d023aca1f99abd5da6f13a42b6cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga775f3a1996f00a8048c4b7acba2e0828"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__q31__to__x.html#ga775f3a1996f00a8048c4b7acba2e0828">arm_q31_to_q15</a> (const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
+<tr class="memdesc:ga775f3a1996f00a8048c4b7acba2e0828"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the elements of the Q31 vector to Q15 vector.  <a href="#ga775f3a1996f00a8048c4b7acba2e0828">More...</a><br/></td></tr>
+<tr class="separator:ga775f3a1996f00a8048c4b7acba2e0828"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gabef5357eb3348b3b5b38915fffce8f3d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__q31__to__x.html#gabef5357eb3348b3b5b38915fffce8f3d">arm_q31_to_q7</a> (const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
+<tr class="memdesc:gabef5357eb3348b3b5b38915fffce8f3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the elements of the Q31 vector to Q7 vector.  <a href="#gabef5357eb3348b3b5b38915fffce8f3d">More...</a><br/></td></tr>
+<tr class="separator:gabef5357eb3348b3b5b38915fffce8f3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 <h2 class="groupheader">Function Documentation</h2>
-<a class="anchor" id="gacf407b007a37da18e99dabd9023c56b4"></a>
+<a class="anchor" id="ga19a9d023aca1f99abd5da6f13a42b6cf"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">void arm_q31_to_float </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>pSrc</em>, </td>
         </tr>
         <tr>
@@ -159,32 +159,27 @@ Functions</h2></td></tr>
 </div><div class="memdoc">
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the Q31 input vector </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the floating-point output vector </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the Q31 input vector </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the floating-point output vector </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in each vector </td></tr>
   </table>
   </dd>
 </dl>
-<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
-<dl class="section user"><dt>Description:</dt><dd></dd></dl>
-<p>The equation used for the conversion process is:</p>
-<pre>
-        pDst[n] = (float32_t) pSrc[n] / 2147483648;   0 &lt;= n &lt; blockSize.
-</pre> 
-<p>References <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>.</p>
-
-<p>Referenced by <a class="el" href="arm__graphic__equalizer__example__q31_8c.html#a52d2cba30e6946c95578be946ac12a65">main()</a>.</p>
+<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
+<dl class="section user"><dt>Details</dt><dd>The equation used for the conversion process is: <pre>
+    pDst[n] = (float32_t) pSrc[n] / 2147483648;   0 &lt;= n &lt; blockSize.
+</pre> </dd></dl>
 
 </div>
 </div>
-<a class="anchor" id="ga901dede4661365c9e7c630d3eb31c32c"></a>
+<a class="anchor" id="ga775f3a1996f00a8048c4b7acba2e0828"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">void arm_q31_to_q15 </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>pSrc</em>, </td>
         </tr>
         <tr>
@@ -208,30 +203,27 @@ Functions</h2></td></tr>
 </div><div class="memdoc">
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the Q31 input vector </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the Q15 output vector </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the Q31 input vector </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the Q15 output vector </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in each vector </td></tr>
   </table>
   </dd>
 </dl>
-<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
-<dl class="section user"><dt>Description:</dt><dd></dd></dl>
-<p>The equation used for the conversion process is:</p>
-<pre>
-        pDst[n] = (q15_t) pSrc[n] &gt;&gt; 16;   0 &lt;= n &lt; blockSize.
-</pre> 
-<p>References <a class="el" href="arm__math_8h.html#ac4be483b8d98e977a69baf4a292a76fe">__PKHTB</a>, <a class="el" href="arm__math_8h.html#a9de2e0a5785be82866bcb96012282248">__SIMD32</a>, and <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>.</p>
+<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
+<dl class="section user"><dt>Details</dt><dd>The equation used for the conversion process is: <pre>
+    pDst[n] = (q15_t) pSrc[n] &gt;&gt; 16;   0 &lt;= n &lt; blockSize.
+</pre> </dd></dl>
 
 </div>
 </div>
-<a class="anchor" id="ga7f297d1a7d776805395095fdb24a8071"></a>
+<a class="anchor" id="gabef5357eb3348b3b5b38915fffce8f3d"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">void arm_q31_to_q7 </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>pSrc</em>, </td>
         </tr>
         <tr>
@@ -255,19 +247,16 @@ Functions</h2></td></tr>
 </div><div class="memdoc">
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the Q31 input vector </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the Q7 output vector </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the Q31 input vector </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the Q7 output vector </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in each vector </td></tr>
   </table>
   </dd>
 </dl>
-<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
-<dl class="section user"><dt>Description:</dt><dd></dd></dl>
-<p>The equation used for the conversion process is:</p>
-<pre>
-        pDst[n] = (q7_t) pSrc[n] &gt;&gt; 24;   0 &lt;= n &lt; blockSize.
-</pre> 
-<p>References <a class="el" href="arm__math_8h.html#a3ebff224ad44c217fde9f530342e2960">__PACKq7</a>, <a class="el" href="arm__math_8h.html#a9de2e0a5785be82866bcb96012282248">__SIMD32</a>, and <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>.</p>
+<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
+<dl class="section user"><dt>Details</dt><dd>The equation used for the conversion process is: <pre>
+    pDst[n] = (q7_t) pSrc[n] &gt;&gt; 24;   0 &lt;= n &lt; blockSize.
+</pre> </dd></dl>
 
 </div>
 </div>
@@ -276,7 +265,7 @@ Functions</h2></td></tr>
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Wed Aug 1 2018 17:12:22 for CMSIS-DSP by Arm Ltd. All rights reserved.
+    <li class="footer">Generated on Wed Jul 10 2019 15:20:40 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