summaryrefslogtreecommitdiff
path: root/docs/DSP/html/group__BasicAbs.html
diff options
context:
space:
mode:
authorrihab kouki <rihab.kouki@st.com>2020-07-28 11:24:49 +0100
committerrihab kouki <rihab.kouki@st.com>2020-07-28 11:24:49 +0100
commit96d6da4e252b06dcfdc041e7df23e86161c33007 (patch)
treea262f59bb1db7ec7819acae435f5049cbe5e2354 /docs/DSP/html/group__BasicAbs.html
parent9f95ff5b6ba01db09552b84a0ab79607060a2666 (diff)
downloadst-cmsis-core-lowfat-96d6da4e252b06dcfdc041e7df23e86161c33007.tar.gz
st-cmsis-core-lowfat-96d6da4e252b06dcfdc041e7df23e86161c33007.tar.bz2
st-cmsis-core-lowfat-96d6da4e252b06dcfdc041e7df23e86161c33007.zip
Official ARM version: v5.6.0HEADmaster
Diffstat (limited to 'docs/DSP/html/group__BasicAbs.html')
-rw-r--r--docs/DSP/html/group__BasicAbs.html89
1 files changed, 38 insertions, 51 deletions
diff --git a/docs/DSP/html/group__BasicAbs.html b/docs/DSP/html/group__BasicAbs.html
index db3cffa..0fbe288 100644
--- a/docs/DSP/html/group__BasicAbs.html
+++ b/docs/DSP/html/group__BasicAbs.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,18 +116,18 @@ $(document).ready(function(){initNavTree('group__BasicAbs.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:ga421b6275f9d35f50286c0ff3beceff02"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicAbs.html#ga421b6275f9d35f50286c0ff3beceff02">arm_abs_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_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:ga421b6275f9d35f50286c0ff3beceff02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Floating-point vector absolute value. <a href="#ga421b6275f9d35f50286c0ff3beceff02">More...</a><br/></td></tr>
-<tr class="separator:ga421b6275f9d35f50286c0ff3beceff02"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga39f92964c9b649ba252e26ebe7b95594"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicAbs.html#ga39f92964c9b649ba252e26ebe7b95594">arm_abs_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_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:ga39f92964c9b649ba252e26ebe7b95594"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q15 vector absolute value. <a href="#ga39f92964c9b649ba252e26ebe7b95594">More...</a><br/></td></tr>
-<tr class="separator:ga39f92964c9b649ba252e26ebe7b95594"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga59eafcdcdb52da60d37f20aec6ff4577"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicAbs.html#ga59eafcdcdb52da60d37f20aec6ff4577">arm_abs_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
-<tr class="memdesc:ga59eafcdcdb52da60d37f20aec6ff4577"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q31 vector absolute value. <a href="#ga59eafcdcdb52da60d37f20aec6ff4577">More...</a><br/></td></tr>
-<tr class="separator:ga59eafcdcdb52da60d37f20aec6ff4577"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gadc30985e33fbf96802a5a7954dece3b1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicAbs.html#gadc30985e33fbf96802a5a7954dece3b1">arm_abs_q7</a> (<a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_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:gadc30985e33fbf96802a5a7954dece3b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 vector absolute value. <a href="#gadc30985e33fbf96802a5a7954dece3b1">More...</a><br/></td></tr>
-<tr class="separator:gadc30985e33fbf96802a5a7954dece3b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga0e8fc7df3033cdbe9cda8a766a46e6d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicAbs.html#ga0e8fc7df3033cdbe9cda8a766a46e6d9">arm_abs_f32</a> (const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_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:ga0e8fc7df3033cdbe9cda8a766a46e6d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Floating-point vector absolute value. <a href="#ga0e8fc7df3033cdbe9cda8a766a46e6d9">More...</a><br/></td></tr>
+<tr class="separator:ga0e8fc7df3033cdbe9cda8a766a46e6d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga5cd90f9490ba8711c86e6f4bd7154359"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicAbs.html#ga5cd90f9490ba8711c86e6f4bd7154359">arm_abs_q15</a> (const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_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:ga5cd90f9490ba8711c86e6f4bd7154359"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q15 vector absolute value. <a href="#ga5cd90f9490ba8711c86e6f4bd7154359">More...</a><br/></td></tr>
+<tr class="separator:ga5cd90f9490ba8711c86e6f4bd7154359"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga494bd5db5e2686d96f5548e80ba8ca89"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicAbs.html#ga494bd5db5e2686d96f5548e80ba8ca89">arm_abs_q31</a> (const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
+<tr class="memdesc:ga494bd5db5e2686d96f5548e80ba8ca89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q31 vector absolute value. <a href="#ga494bd5db5e2686d96f5548e80ba8ca89">More...</a><br/></td></tr>
+<tr class="separator:ga494bd5db5e2686d96f5548e80ba8ca89"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga097f1938c72471930b4e5647de40c505"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicAbs.html#ga097f1938c72471930b4e5647de40c505">arm_abs_q7</a> (const <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_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:ga097f1938c72471930b4e5647de40c505"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 vector absolute value. <a href="#ga097f1938c72471930b4e5647de40c505">More...</a><br/></td></tr>
+<tr class="separator:ga097f1938c72471930b4e5647de40c505"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Computes the absolute value of a vector on an element-by-element basis.</p>
@@ -135,14 +135,14 @@ Functions</h2></td></tr>
pDst[n] = abs(pSrc[n]), 0 &lt;= n &lt; blockSize.
</pre><p>The functions support in-place computation allowing the source and destination pointers to reference the same memory buffer. There are separate functions for floating-point, Q7, Q15, and Q31 data types. </p>
<h2 class="groupheader">Function Documentation</h2>
-<a class="anchor" id="ga421b6275f9d35f50286c0ff3beceff02"></a>
+<a class="anchor" id="ga0e8fc7df3033cdbe9cda8a766a46e6d9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void arm_abs_f32 </td>
<td>(</td>
- <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
+ <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</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 buffer </td></tr>
- <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output buffer </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">[out]</td><td class="paramname">pDst</td><td>points to the 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>
-
-<p>References <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>.</p>
-
-<p>Referenced by <a class="el" href="arm__signal__converge__example__f32_8c.html#a52d2cba30e6946c95578be946ac12a65">main()</a>.</p>
+<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
</div>
</div>
-<a class="anchor" id="ga39f92964c9b649ba252e26ebe7b95594"></a>
+<a class="anchor" id="ga5cd90f9490ba8711c86e6f4bd7154359"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void arm_abs_q15 </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>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 buffer </td></tr>
- <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output buffer </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">[out]</td><td class="paramname">pDst</td><td>points to the 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>
-<p><b>Scaling and Overflow Behavior:</b> </p>
-<dl class="section user"><dt></dt><dd>The function uses saturating arithmetic. The Q15 value -1 (0x8000) will be saturated to the maximum allowable positive value 0x7FFF. </dd></dl>
-
-<p>References <a class="el" href="arm__math_8h.html#aa505179349146cf6186640b4c8b47714">__PKHBT</a>, <a class="el" href="arm__math_8h.html#a6e4703dc08d1b82eab7f5ef96edb59bb">__QSUB16()</a>, <a class="el" href="arm__math_8h.html#a1185d670d798aaf52eec13f0403f3407">__SIMD32_CONST</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 uses saturating arithmetic. The Q15 value -1 (0x8000) will be saturated to the maximum allowable positive value 0x7FFF. </dd></dl>
</div>
</div>
-<a class="anchor" id="ga59eafcdcdb52da60d37f20aec6ff4577"></a>
+<a class="anchor" id="ga494bd5db5e2686d96f5548e80ba8ca89"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void arm_abs_q31 </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>
@@ -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 buffer </td></tr>
- <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output buffer </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">[out]</td><td class="paramname">pDst</td><td>points to the 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>
-<p><b>Scaling and Overflow Behavior:</b> </p>
-<dl class="section user"><dt></dt><dd>The function uses saturating arithmetic. The Q31 value -1 (0x80000000) will be saturated to the maximum allowable positive value 0x7FFFFFFF. </dd></dl>
-
-<p>References <a class="el" href="arm__math_8h.html#a15e896d0146c280e600d00f609832350">__QSUB()</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 uses saturating arithmetic. The Q31 value -1 (0x80000000) will be saturated to the maximum allowable positive value 0x7FFFFFFF. </dd></dl>
</div>
</div>
-<a class="anchor" id="gadc30985e33fbf96802a5a7954dece3b1"></a>
+<a class="anchor" id="ga097f1938c72471930b4e5647de40c505"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void arm_abs_q7 </td>
<td>(</td>
- <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *&#160;</td>
+ <td class="paramtype">const <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *&#160;</td>
<td class="paramname"><em>pSrc</em>, </td>
</tr>
<tr>
@@ -301,18 +291,15 @@ 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 buffer </td></tr>
- <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output buffer </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">[out]</td><td class="paramname">pDst</td><td>points to the 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>Conditions for optimum performance</dt><dd>Input and output buffers should be aligned by 32-bit</dd></dl>
-<p><b>Scaling and Overflow Behavior:</b> </p>
-<dl class="section user"><dt></dt><dd>The function uses saturating arithmetic. The Q7 value -1 (0x80) will be saturated to the maximum allowable positive value 0x7F. </dd></dl>
-
-<p>References <a class="el" href="arm__math_8h.html#a4690314b420f463093f1a2f68b5fb143">__QSUB8()</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>Conditions for optimum performance</dt><dd>Input and output buffers should be aligned by 32-bit </dd></dl>
+<dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>The function uses saturating arithmetic. The Q7 value -1 (0x80) will be saturated to the maximum allowable positive value 0x7F. </dd></dl>
</div>
</div>
@@ -321,7 +308,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:21 for CMSIS-DSP by Arm Ltd. All rights reserved.
+ <li class="footer">Generated on Wed Jul 10 2019 15:20:39 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