diff options
Diffstat (limited to 'docs/DSP/html/group__mean.html')
| -rw-r--r-- | docs/DSP/html/group__mean.html | 97 |
1 files changed, 42 insertions, 55 deletions
diff --git a/docs/DSP/html/group__mean.html b/docs/DSP/html/group__mean.html index 07b2ebd..2c621e5 100644 --- a/docs/DSP/html/group__mean.html +++ b/docs/DSP/html/group__mean.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,33 +116,33 @@ $(document).ready(function(){initNavTree('group__mean.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:ga74ce08c49ab61e57bd50c3a0ca1fdb2b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mean.html#ga74ce08c49ab61e57bd50c3a0ca1fdb2b">arm_mean_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:ga74ce08c49ab61e57bd50c3a0ca1fdb2b"><td class="mdescLeft"> </td><td class="mdescRight">Mean value of a floating-point vector. <a href="#ga74ce08c49ab61e57bd50c3a0ca1fdb2b">More...</a><br/></td></tr> -<tr class="separator:ga74ce08c49ab61e57bd50c3a0ca1fdb2b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gac882495d5f098819fd3939c1ef7795b3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mean.html#gac882495d5f098819fd3939c1ef7795b3">arm_mean_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:gac882495d5f098819fd3939c1ef7795b3"><td class="mdescLeft"> </td><td class="mdescRight">Mean value of a Q15 vector. <a href="#gac882495d5f098819fd3939c1ef7795b3">More...</a><br/></td></tr> -<tr class="separator:gac882495d5f098819fd3939c1ef7795b3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gacf2526d8c2d75e486e8f0b0e31877ad0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mean.html#gacf2526d8c2d75e486e8f0b0e31877ad0">arm_mean_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:gacf2526d8c2d75e486e8f0b0e31877ad0"><td class="mdescLeft"> </td><td class="mdescRight">Mean value of a Q31 vector. <a href="#gacf2526d8c2d75e486e8f0b0e31877ad0">More...</a><br/></td></tr> -<tr class="separator:gacf2526d8c2d75e486e8f0b0e31877ad0"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaebc707ee539020357c25da4c75b52eb7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mean.html#gaebc707ee539020357c25da4c75b52eb7">arm_mean_q7</a> (<a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_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#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pResult)</td></tr> -<tr class="memdesc:gaebc707ee539020357c25da4c75b52eb7"><td class="mdescLeft"> </td><td class="mdescRight">Mean value of a Q7 vector. <a href="#gaebc707ee539020357c25da4c75b52eb7">More...</a><br/></td></tr> -<tr class="separator:gaebc707ee539020357c25da4c75b52eb7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae4fb7698771d7c24f536ed24347c1488"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mean.html#gae4fb7698771d7c24f536ed24347c1488">arm_mean_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:gae4fb7698771d7c24f536ed24347c1488"><td class="mdescLeft"> </td><td class="mdescRight">Mean value of a floating-point vector. <a href="#gae4fb7698771d7c24f536ed24347c1488">More...</a><br/></td></tr> +<tr class="separator:gae4fb7698771d7c24f536ed24347c1488"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga55fc43607651123ffe3b967e30305734"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mean.html#ga55fc43607651123ffe3b967e30305734">arm_mean_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:ga55fc43607651123ffe3b967e30305734"><td class="mdescLeft"> </td><td class="mdescRight">Mean value of a Q15 vector. <a href="#ga55fc43607651123ffe3b967e30305734">More...</a><br/></td></tr> +<tr class="separator:ga55fc43607651123ffe3b967e30305734"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab86ec60eba14c4bc4e2bd9b54ac4b487"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mean.html#gab86ec60eba14c4bc4e2bd9b54ac4b487">arm_mean_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:gab86ec60eba14c4bc4e2bd9b54ac4b487"><td class="mdescLeft"> </td><td class="mdescRight">Mean value of a Q31 vector. <a href="#gab86ec60eba14c4bc4e2bd9b54ac4b487">More...</a><br/></td></tr> +<tr class="separator:gab86ec60eba14c4bc4e2bd9b54ac4b487"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa907ace253a82be0741a3203ac04601c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mean.html#gaa907ace253a82be0741a3203ac04601c">arm_mean_q7</a> (const <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_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#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pResult)</td></tr> +<tr class="memdesc:gaa907ace253a82be0741a3203ac04601c"><td class="mdescLeft"> </td><td class="mdescRight">Mean value of a Q7 vector. <a href="#gaa907ace253a82be0741a3203ac04601c">More...</a><br/></td></tr> +<tr class="separator:gaa907ace253a82be0741a3203ac04601c"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> <p>Calculates the mean of the input vector. Mean is defined as the average of the elements in the vector. The underlying algorithm is used:</p> <pre> - Result = (pSrc[0] + pSrc[1] + pSrc[2] + ... + pSrc[blockSize-1]) / blockSize; + Result = (pSrc[0] + pSrc[1] + pSrc[2] + ... + pSrc[blockSize-1]) / blockSize; </pre><p>There are separate functions for floating-point, Q31, Q15, and Q7 data types. </p> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="ga74ce08c49ab61e57bd50c3a0ca1fdb2b"></a> +<a class="anchor" id="gae4fb7698771d7c24f536ed24347c1488"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_mean_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> @@ -166,28 +166,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>mean 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>mean 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="gac882495d5f098819fd3939c1ef7795b3"></a> +<a class="anchor" id="ga55fc43607651123ffe3b967e30305734"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_mean_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> @@ -211,28 +207,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>mean 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>mean 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 32-bit internal accumulator. The input is represented in 1.15 format and is accumulated in a 32-bit accumulator in 17.15 format. There is no risk of internal overflow with this approach, and the full precision of intermediate result is preserved. Finally, the accumulator is saturated and truncated to yield a result of 1.15 format. </dd></dl> - -<p>References <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>Scaling and Overflow Behavior</dt><dd>The function is implemented using a 32-bit internal accumulator. The input is represented in 1.15 format and is accumulated in a 32-bit accumulator in 17.15 format. There is no risk of internal overflow with this approach, and the full precision of intermediate result is preserved. Finally, the accumulator is truncated to yield a result of 1.15 format. </dd></dl> </div> </div> -<a class="anchor" id="gacf2526d8c2d75e486e8f0b0e31877ad0"></a> +<a class="anchor" id="gab86ec60eba14c4bc4e2bd9b54ac4b487"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_mean_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> @@ -256,28 +249,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>mean 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>mean 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.31 format and is accumulated in a 64-bit accumulator in 33.31 format. There is no risk of internal overflow with this approach, and the full precision of intermediate result is preserved. Finally, the accumulator is truncated to yield a result of 1.31 format. </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 a 64-bit internal accumulator. The input is represented in 1.31 format and is accumulated in a 64-bit accumulator in 33.31 format. There is no risk of internal overflow with this approach, and the full precision of intermediate result is preserved. Finally, the accumulator is truncated to yield a result of 1.31 format. </dd></dl> </div> </div> -<a class="anchor" id="gaebc707ee539020357c25da4c75b52eb7"></a> +<a class="anchor" id="gaa907ace253a82be0741a3203ac04601c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_mean_q7 </td> <td>(</td> - <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> * </td> + <td class="paramtype">const <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> * </td> <td class="paramname"><em>pSrc</em>, </td> </tr> <tr> @@ -301,17 +291,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>mean 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>mean 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 32-bit internal accumulator. The input is represented in 1.7 format and is accumulated in a 32-bit accumulator in 25.7 format. There is no risk of internal overflow with this approach, and the full precision of intermediate result is preserved. Finally, the accumulator is truncated to yield a result of 1.7 format. </dd></dl> - -<p>References <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>Scaling and Overflow Behavior</dt><dd>The function is implemented using a 32-bit internal accumulator. The input is represented in 1.7 format and is accumulated in a 32-bit accumulator in 25.7 format. There is no risk of internal overflow with this approach, and the full precision of intermediate result is preserved. Finally, the accumulator is truncated to yield a result of 1.7 format. </dd></dl> </div> </div> @@ -320,7 +307,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 |