diff options
Diffstat (limited to 'docs/DSP/html/group__cmplx__mag.html')
| -rw-r--r-- | docs/DSP/html/group__cmplx__mag.html | 77 |
1 files changed, 34 insertions, 43 deletions
diff --git a/docs/DSP/html/group__cmplx__mag.html b/docs/DSP/html/group__cmplx__mag.html index 167ce95..ab69be7 100644 --- a/docs/DSP/html/group__cmplx__mag.html +++ b/docs/DSP/html/group__cmplx__mag.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,34 @@ $(document).ready(function(){initNavTree('group__cmplx__mag.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:gae45024c497392cde2ae358a76d435213"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__mag.html#gae45024c497392cde2ae358a76d435213">arm_cmplx_mag_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 numSamples)</td></tr> -<tr class="memdesc:gae45024c497392cde2ae358a76d435213"><td class="mdescLeft"> </td><td class="mdescRight">Floating-point complex magnitude. <a href="#gae45024c497392cde2ae358a76d435213">More...</a><br/></td></tr> -<tr class="separator:gae45024c497392cde2ae358a76d435213"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga0a4a8f77a6a51d9b3f3b9d729f85b7a4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__mag.html#ga0a4a8f77a6a51d9b3f3b9d729f85b7a4">arm_cmplx_mag_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 numSamples)</td></tr> -<tr class="memdesc:ga0a4a8f77a6a51d9b3f3b9d729f85b7a4"><td class="mdescLeft"> </td><td class="mdescRight">Q15 complex magnitude. <a href="#ga0a4a8f77a6a51d9b3f3b9d729f85b7a4">More...</a><br/></td></tr> -<tr class="separator:ga0a4a8f77a6a51d9b3f3b9d729f85b7a4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga14f82f9230e9d96d5b9774e2fefcb7be"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__mag.html#ga14f82f9230e9d96d5b9774e2fefcb7be">arm_cmplx_mag_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 numSamples)</td></tr> -<tr class="memdesc:ga14f82f9230e9d96d5b9774e2fefcb7be"><td class="mdescLeft"> </td><td class="mdescRight">Q31 complex magnitude. <a href="#ga14f82f9230e9d96d5b9774e2fefcb7be">More...</a><br/></td></tr> -<tr class="separator:ga14f82f9230e9d96d5b9774e2fefcb7be"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaba4e0eff7816fe80d01121fb4cf6c6bc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__mag.html#gaba4e0eff7816fe80d01121fb4cf6c6bc">arm_cmplx_mag_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 numSamples)</td></tr> +<tr class="memdesc:gaba4e0eff7816fe80d01121fb4cf6c6bc"><td class="mdescLeft"> </td><td class="mdescRight">Floating-point complex magnitude. <a href="#gaba4e0eff7816fe80d01121fb4cf6c6bc">More...</a><br/></td></tr> +<tr class="separator:gaba4e0eff7816fe80d01121fb4cf6c6bc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0488e185f4631ac029b02f1759b287cf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__mag.html#ga0488e185f4631ac029b02f1759b287cf">arm_cmplx_mag_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 numSamples)</td></tr> +<tr class="memdesc:ga0488e185f4631ac029b02f1759b287cf"><td class="mdescLeft"> </td><td class="mdescRight">Q15 complex magnitude. <a href="#ga0488e185f4631ac029b02f1759b287cf">More...</a><br/></td></tr> +<tr class="separator:ga0488e185f4631ac029b02f1759b287cf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab69ad9237469565958cce6b4555bbb6e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__mag.html#gab69ad9237469565958cce6b4555bbb6e">arm_cmplx_mag_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 numSamples)</td></tr> +<tr class="memdesc:gab69ad9237469565958cce6b4555bbb6e"><td class="mdescLeft"> </td><td class="mdescRight">Q31 complex magnitude. <a href="#gab69ad9237469565958cce6b4555bbb6e">More...</a><br/></td></tr> +<tr class="separator:gab69ad9237469565958cce6b4555bbb6e"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> <p>Computes the magnitude of the elements of a complex data vector.</p> -<p>The <code>pSrc</code> points to the source data and <code>pDst</code> points to the where the result should be written. <code>numSamples</code> specifies the number of complex samples in the input array and the data is stored in an interleaved fashion (real, imag, real, imag, ...). The input array has a total of <code>2*numSamples</code> values; the output array has a total of <code>numSamples</code> values. The underlying algorithm is used:</p> +<p>The <code>pSrc</code> points to the source data and <code>pDst</code> points to the where the result should be written. <code>numSamples</code> specifies the number of complex samples in the input array and the data is stored in an interleaved fashion (real, imag, real, imag, ...). The input array has a total of <code>2*numSamples</code> values; the output array has a total of <code>numSamples</code> values.</p> +<p>The underlying algorithm is used:</p> <pre> -for(n=0; n<numSamples; n++) { +for (n = 0; n < numSamples; n++) { pDst[n] = sqrt(pSrc[(2*n)+0]^2 + pSrc[(2*n)+1]^2); } </pre><p>There are separate functions for floating-point, Q15, and Q31 data types. </p> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="gae45024c497392cde2ae358a76d435213"></a> +<a class="anchor" id="gaba4e0eff7816fe80d01121fb4cf6c6bc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_cmplx_mag_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 +167,24 @@ for(n=0; n<numSamples; n++) { </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 complex input buffer </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to real output buffer </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of complex samples in the input vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to input vector </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to output vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</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="group__SQRT.html#ga697d82c2747a3302cf44e7c9583da2e8">arm_sqrt_f32()</a>.</p> - -<p>Referenced by <a class="el" href="arm__fft__bin__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="ga0a4a8f77a6a51d9b3f3b9d729f85b7a4"></a> +<a class="anchor" id="ga0488e185f4631ac029b02f1759b287cf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_cmplx_mag_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 +208,25 @@ for(n=0; n<numSamples; n++) { </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname">*pSrc</td><td>points to the complex input vector </td></tr> - <tr><td class="paramname">*pDst</td><td>points to the real output vector </td></tr> - <tr><td class="paramname">numSamples</td><td>number of complex samples in the input vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to input vector </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to output vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</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 implements 1.15 by 1.15 multiplications and finally output is converted into 2.14 format. </dd></dl> - -<p>References <a class="el" href="arm__math_8h.html#a9de2e0a5785be82866bcb96012282248">__SIMD32</a>, <a class="el" href="arm__math_8h.html#a2eed05660fedbe3fbd0b6dbb1315cfc3">__SMUAD()</a>, and <a class="el" href="group__SQRT.html#ga5abe5ca724f3e15849662b03752c1238">arm_sqrt_q15()</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 implements 1.15 by 1.15 multiplications and finally output is converted into 2.14 format. </dd></dl> </div> </div> -<a class="anchor" id="ga14f82f9230e9d96d5b9774e2fefcb7be"></a> +<a class="anchor" id="gab69ad9237469565958cce6b4555bbb6e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_cmplx_mag_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,17 +250,14 @@ for(n=0; n<numSamples; n++) { </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname">*pSrc</td><td>points to the complex input vector </td></tr> - <tr><td class="paramname">*pDst</td><td>points to the real output vector </td></tr> - <tr><td class="paramname">numSamples</td><td>number of complex samples in the input vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to input vector </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to output vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</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 implements 1.31 by 1.31 multiplications and finally output is converted into 2.30 format. Input down scaling is not required. </dd></dl> - -<p>References <a class="el" href="group__SQRT.html#ga119e25831e141d734d7ef10636670058">arm_sqrt_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 implements 1.31 by 1.31 multiplications and finally output is converted into 2.30 format. Input down scaling is not required. </dd></dl> </div> </div> @@ -275,7 +266,7 @@ for(n=0; n<numSamples; n++) { <!-- 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 |