diff options
Diffstat (limited to 'docs/DSP/html/group__BasicSub.html')
| -rw-r--r-- | docs/DSP/html/group__BasicSub.html | 103 |
1 files changed, 45 insertions, 58 deletions
diff --git a/docs/DSP/html/group__BasicSub.html b/docs/DSP/html/group__BasicSub.html index 848763c..3508828 100644 --- a/docs/DSP/html/group__BasicSub.html +++ b/docs/DSP/html/group__BasicSub.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,18 +116,18 @@ $(document).ready(function(){initNavTree('group__BasicSub.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:ga7f975a472de286331134227c08aad826"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicSub.html#ga7f975a472de286331134227c08aad826">arm_sub_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrcA, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrcB, <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:ga7f975a472de286331134227c08aad826"><td class="mdescLeft"> </td><td class="mdescRight">Floating-point vector subtraction. <a href="#ga7f975a472de286331134227c08aad826">More...</a><br/></td></tr> -<tr class="separator:ga7f975a472de286331134227c08aad826"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga997a8ee93088d15bda23c325d455b588"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicSub.html#ga997a8ee93088d15bda23c325d455b588">arm_sub_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcA, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcB, <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:ga997a8ee93088d15bda23c325d455b588"><td class="mdescLeft"> </td><td class="mdescRight">Q15 vector subtraction. <a href="#ga997a8ee93088d15bda23c325d455b588">More...</a><br/></td></tr> -<tr class="separator:ga997a8ee93088d15bda23c325d455b588"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga28aa6908d092752144413e21933dc878"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicSub.html#ga28aa6908d092752144413e21933dc878">arm_sub_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrcA, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrcB, <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:ga28aa6908d092752144413e21933dc878"><td class="mdescLeft"> </td><td class="mdescRight">Q31 vector subtraction. <a href="#ga28aa6908d092752144413e21933dc878">More...</a><br/></td></tr> -<tr class="separator:ga28aa6908d092752144413e21933dc878"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gab09941de7dfeb247e5c29b406a435fcc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicSub.html#gab09941de7dfeb247e5c29b406a435fcc">arm_sub_q7</a> (<a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrcA, <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrcB, <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:gab09941de7dfeb247e5c29b406a435fcc"><td class="mdescLeft"> </td><td class="mdescRight">Q7 vector subtraction. <a href="#gab09941de7dfeb247e5c29b406a435fcc">More...</a><br/></td></tr> -<tr class="separator:gab09941de7dfeb247e5c29b406a435fcc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga76b8b2aec34269c6de0b090cab00fb33"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicSub.html#ga76b8b2aec34269c6de0b090cab00fb33">arm_sub_f32</a> (const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrcA, const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrcB, <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:ga76b8b2aec34269c6de0b090cab00fb33"><td class="mdescLeft"> </td><td class="mdescRight">Floating-point vector subtraction. <a href="#ga76b8b2aec34269c6de0b090cab00fb33">More...</a><br/></td></tr> +<tr class="separator:ga76b8b2aec34269c6de0b090cab00fb33"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga33a096c2860eca18bbc4e6966409064f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicSub.html#ga33a096c2860eca18bbc4e6966409064f">arm_sub_q15</a> (const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcA, const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcB, <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:ga33a096c2860eca18bbc4e6966409064f"><td class="mdescLeft"> </td><td class="mdescRight">Q15 vector subtraction. <a href="#ga33a096c2860eca18bbc4e6966409064f">More...</a><br/></td></tr> +<tr class="separator:ga33a096c2860eca18bbc4e6966409064f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga913159f71589b56dbfb03ddc1210a59c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicSub.html#ga913159f71589b56dbfb03ddc1210a59c">arm_sub_q31</a> (const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrcA, const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrcB, <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:ga913159f71589b56dbfb03ddc1210a59c"><td class="mdescLeft"> </td><td class="mdescRight">Q31 vector subtraction. <a href="#ga913159f71589b56dbfb03ddc1210a59c">More...</a><br/></td></tr> +<tr class="separator:ga913159f71589b56dbfb03ddc1210a59c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga162990b82a18231c4e606ba0e6584c7e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicSub.html#ga162990b82a18231c4e606ba0e6584c7e">arm_sub_q7</a> (const <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrcA, const <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrcB, <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:ga162990b82a18231c4e606ba0e6584c7e"><td class="mdescLeft"> </td><td class="mdescRight">Q7 vector subtraction. <a href="#ga162990b82a18231c4e606ba0e6584c7e">More...</a><br/></td></tr> +<tr class="separator:ga162990b82a18231c4e606ba0e6584c7e"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> <p>Element-by-element subtraction of two vectors.</p> @@ -135,20 +135,20 @@ Functions</h2></td></tr> pDst[n] = pSrcA[n] - pSrcB[n], 0 <= n < blockSize. </pre><p>There are separate functions for floating-point, Q7, Q15, and Q31 data types. </p> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="ga7f975a472de286331134227c08aad826"></a> +<a class="anchor" id="ga76b8b2aec34269c6de0b090cab00fb33"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_sub_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>pSrcA</em>, </td> </tr> <tr> <td class="paramkey"></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>pSrcB</em>, </td> </tr> <tr> @@ -172,35 +172,31 @@ 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">*pSrcA</td><td>points to the first input vector </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second 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">pSrcA</td><td>points to the first input vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrcB</td><td>points to the second 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="ga997a8ee93088d15bda23c325d455b588"></a> +<a class="anchor" id="ga33a096c2860eca18bbc4e6966409064f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_sub_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>pSrcA</em>, </td> </tr> <tr> <td class="paramkey"></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>pSrcB</em>, </td> </tr> <tr> @@ -224,35 +220,32 @@ 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">*pSrcA</td><td>points to the first input vector </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second 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">pSrcA</td><td>points to the first input vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrcB</td><td>points to the second 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. Results outside of the allowable Q15 range [0x8000 0x7FFF] will be saturated. </dd></dl> - -<p>References <a class="el" href="arm__math_8h.html#a6e4703dc08d1b82eab7f5ef96edb59bb">__QSUB16()</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>Scaling and Overflow Behavior</dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q15 range [0x8000 0x7FFF] are saturated. </dd></dl> </div> </div> -<a class="anchor" id="ga28aa6908d092752144413e21933dc878"></a> +<a class="anchor" id="ga913159f71589b56dbfb03ddc1210a59c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_sub_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>pSrcA</em>, </td> </tr> <tr> <td class="paramkey"></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>pSrcB</em>, </td> </tr> <tr> @@ -276,35 +269,32 @@ 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">*pSrcA</td><td>points to the first input vector </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second 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">pSrcA</td><td>points to the first input vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrcB</td><td>points to the second 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. Results outside of the allowable Q31 range [0x80000000 0x7FFFFFFF] will be saturated. </dd></dl> - -<p>References <a class="el" href="arm__math_8h.html#a15e896d0146c280e600d00f609832350">__QSUB()</a>, <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, and <a class="el" href="arm__math_8h.html#a9a94b78de0f083bd8fadf3c3abe40431">clip_q63_to_q31()</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. Results outside of the allowable Q31 range [0x80000000 0x7FFFFFFF] are saturated. </dd></dl> </div> </div> -<a class="anchor" id="gab09941de7dfeb247e5c29b406a435fcc"></a> +<a class="anchor" id="ga162990b82a18231c4e606ba0e6584c7e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_sub_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>pSrcA</em>, </td> </tr> <tr> <td class="paramkey"></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>pSrcB</em>, </td> </tr> <tr> @@ -328,18 +318,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">*pSrcA</td><td>points to the first input vector </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second 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">pSrcA</td><td>points to the first input vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrcB</td><td>points to the second 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. Results outside of the allowable Q7 range [0x80 0x7F] will be saturated. </dd></dl> - -<p>References <a class="el" href="arm__math_8h.html#a4690314b420f463093f1a2f68b5fb143">__QSUB8()</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>Scaling and Overflow Behavior</dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q7 range [0x80 0x7F] will be saturated. </dd></dl> </div> </div> @@ -348,7 +335,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 |