diff options
Diffstat (limited to 'docs/DSP/html/group__variance.html')
| -rw-r--r-- | docs/DSP/html/group__variance.html | 75 |
1 files changed, 33 insertions, 42 deletions
diff --git a/docs/DSP/html/group__variance.html b/docs/DSP/html/group__variance.html index f0a761a..7810a75 100644 --- a/docs/DSP/html/group__variance.html +++ b/docs/DSP/html/group__variance.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 -  <span id="projectnumber">Version 1.5.2</span> +  <span id="projectnumber">Version 1.7.0</span> </div> <div id="projectbrief">CMSIS DSP Software Library</div> </td> @@ -116,29 +116,30 @@ $(document).ready(function(){initNavTree('group__variance.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:ga393f26c5a3bfa05624fb8d32232a6d96"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__variance.html#ga393f26c5a3bfa05624fb8d32232a6d96">arm_var_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pResult)</td></tr> -<tr class="memdesc:ga393f26c5a3bfa05624fb8d32232a6d96"><td class="mdescLeft"> </td><td class="mdescRight">Variance of the elements of a floating-point vector. <a href="#ga393f26c5a3bfa05624fb8d32232a6d96">More...</a><br/></td></tr> -<tr class="separator:ga393f26c5a3bfa05624fb8d32232a6d96"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga79dce009ed2de28a125aeb3f19631654"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__variance.html#ga79dce009ed2de28a125aeb3f19631654">arm_var_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pResult)</td></tr> -<tr class="memdesc:ga79dce009ed2de28a125aeb3f19631654"><td class="mdescLeft"> </td><td class="mdescRight">Variance of the elements of a Q15 vector. <a href="#ga79dce009ed2de28a125aeb3f19631654">More...</a><br/></td></tr> -<tr class="separator:ga79dce009ed2de28a125aeb3f19631654"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gac02873f1c2cc80adfd799305f0e6465d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__variance.html#gac02873f1c2cc80adfd799305f0e6465d">arm_var_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pResult)</td></tr> -<tr class="memdesc:gac02873f1c2cc80adfd799305f0e6465d"><td class="mdescLeft"> </td><td class="mdescRight">Variance of the elements of a Q31 vector. <a href="#gac02873f1c2cc80adfd799305f0e6465d">More...</a><br/></td></tr> -<tr class="separator:gac02873f1c2cc80adfd799305f0e6465d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaae455544f0c8ac92469a1e25d3906515"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__variance.html#gaae455544f0c8ac92469a1e25d3906515">arm_var_f32</a> (const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pResult)</td></tr> +<tr class="memdesc:gaae455544f0c8ac92469a1e25d3906515"><td class="mdescLeft"> </td><td class="mdescRight">Variance of the elements of a floating-point vector. <a href="#gaae455544f0c8ac92469a1e25d3906515">More...</a><br/></td></tr> +<tr class="separator:gaae455544f0c8ac92469a1e25d3906515"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaef3ebc6401209c3f93749e08d341ab48"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__variance.html#gaef3ebc6401209c3f93749e08d341ab48">arm_var_q15</a> (const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pResult)</td></tr> +<tr class="memdesc:gaef3ebc6401209c3f93749e08d341ab48"><td class="mdescLeft"> </td><td class="mdescRight">Variance of the elements of a Q15 vector. <a href="#gaef3ebc6401209c3f93749e08d341ab48">More...</a><br/></td></tr> +<tr class="separator:gaef3ebc6401209c3f93749e08d341ab48"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga87a07c87c1d85104de0ea4a3d017454c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__variance.html#ga87a07c87c1d85104de0ea4a3d017454c">arm_var_q31</a> (const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pResult)</td></tr> +<tr class="memdesc:ga87a07c87c1d85104de0ea4a3d017454c"><td class="mdescLeft"> </td><td class="mdescRight">Variance of the elements of a Q31 vector. <a href="#ga87a07c87c1d85104de0ea4a3d017454c">More...</a><br/></td></tr> +<tr class="separator:ga87a07c87c1d85104de0ea4a3d017454c"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> <p>Calculates the variance of the elements in the input vector. The underlying algorithm used is the direct method sometimes referred to as the two-pass method:</p> <pre> - Result = sum(element - meanOfElements)^2) / numElement - 1</pre><pre> where, meanOfElements = ( pSrc[0] * pSrc[0] + pSrc[1] * pSrc[1] + ... + pSrc[blockSize-1] ) / blockSize</pre><pre></pre><p>There are separate functions for floating point, Q31, and Q15 data types. </p> + Result = sum(element - meanOfElements)^2) / numElement - 1</pre><pre> meanOfElements = ( pSrc[0] * pSrc[0] + pSrc[1] * pSrc[1] + ... + pSrc[blockSize-1] ) / blockSize +</pre><p>There are separate functions for floating point, Q31, and Q15 data types. </p> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="ga393f26c5a3bfa05624fb8d32232a6d96"></a> +<a class="anchor" id="gaae455544f0c8ac92469a1e25d3906515"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_var_f32 </td> <td>(</td> - <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> * </td> + <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> * </td> <td class="paramname"><em>pSrc</em>, </td> </tr> <tr> @@ -162,28 +163,24 @@ 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 input 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">[out]</td><td class="paramname">*pResult</td><td>variance value returned here </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the input vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in input vector </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pResult</td><td>variance value returned here </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none. </dd></dl> - -<p>References <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>.</p> - -<p>Referenced by <a class="el" href="arm__class__marks__example__f32_8c.html#a196718f834091385d38586a0ce4009dc">main()</a>.</p> +<dl class="section return"><dt>Returns</dt><dd>none </dd></dl> </div> </div> -<a class="anchor" id="ga79dce009ed2de28a125aeb3f19631654"></a> +<a class="anchor" id="gaef3ebc6401209c3f93749e08d341ab48"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_var_q15 </td> <td>(</td> - <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td> + <td class="paramtype">const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td> <td class="paramname"><em>pSrc</em>, </td> </tr> <tr> @@ -207,28 +204,25 @@ 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 input 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">[out]</td><td class="paramname">*pResult</td><td>variance value returned here </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the input vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in input vector </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pResult</td><td>variance value returned here </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl> -<p><b>Scaling and Overflow Behavior:</b></p> -<dl class="section user"><dt></dt><dd>The function is implemented using a 64-bit internal accumulator. The input is represented in 1.15 format. Intermediate multiplication yields a 2.30 format, and this result is added without saturation to a 64-bit accumulator in 34.30 format. With 33 guard bits in the accumulator, there is no risk of overflow, and the full precision of the intermediate multiplication is preserved. Finally, the 34.30 result is truncated to 34.15 format by discarding the lower 15 bits, and then saturated to yield a result in 1.15 format. </dd></dl> - -<p>References <a class="el" href="arm__math_8h.html#a9de2e0a5785be82866bcb96012282248">__SIMD32</a>, <a class="el" href="arm__math_8h.html#a7aed02041f489a4f65dbd7093073d94e">__SMLALD()</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>Scaling and Overflow Behavior</dt><dd>The function is implemented using a 64-bit internal accumulator. The input is represented in 1.15 format. Intermediate multiplication yields a 2.30 format, and this result is added without saturation to a 64-bit accumulator in 34.30 format. With 33 guard bits in the accumulator, there is no risk of overflow, and the full precision of the intermediate multiplication is preserved. Finally, the 34.30 result is truncated to 34.15 format by discarding the lower 15 bits, and then saturated to yield a result in 1.15 format. </dd></dl> </div> </div> -<a class="anchor" id="gac02873f1c2cc80adfd799305f0e6465d"></a> +<a class="anchor" id="ga87a07c87c1d85104de0ea4a3d017454c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_var_q31 </td> <td>(</td> - <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td> + <td class="paramtype">const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td> <td class="paramname"><em>pSrc</em>, </td> </tr> <tr> @@ -252,17 +246,14 @@ 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 input 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">[out]</td><td class="paramname">*pResult</td><td>variance value returned here </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the input vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in input vector </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pResult</td><td>variance value returned here </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl> -<p><b>Scaling and Overflow Behavior:</b></p> -<dl class="section user"><dt></dt><dd>The function is implemented using an internal 64-bit accumulator. The input is represented in 1.31 format, which is then downshifted by 8 bits which yields 1.23, and intermediate multiplication yields a 2.46 format. The accumulator maintains full precision of the intermediate multiplication results, but provides only a 16 guard bits. There is no saturation on intermediate additions. If the accumulator overflows it wraps around and distorts the result. In order to avoid overflows completely the input signal must be scaled down by log2(blockSize)-8 bits, as a total of blockSize additions are performed internally. After division, internal variables should be Q18.46 Finally, the 18.46 accumulator is right shifted by 15 bits to yield a 1.31 format value. </dd></dl> - -<p>References <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>Scaling and Overflow Behavior</dt><dd>The function is implemented using an internal 64-bit accumulator. The input is represented in 1.31 format, which is then downshifted by 8 bits which yields 1.23, and intermediate multiplication yields a 2.46 format. The accumulator maintains full precision of the intermediate multiplication results, but provides only a 16 guard bits. There is no saturation on intermediate additions. If the accumulator overflows it wraps around and distorts the result. In order to avoid overflows completely the input signal must be scaled down by log2(blockSize)-8 bits, as a total of blockSize additions are performed internally. After division, internal variables should be Q18.46 Finally, the 18.46 accumulator is right shifted by 15 bits to yield a 1.31 format value. </dd></dl> </div> </div> @@ -271,7 +262,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 |