diff options
Diffstat (limited to 'docs/DSP/html/group__cmplx__dot__prod.html')
| -rw-r--r-- | docs/DSP/html/group__cmplx__dot__prod.html | 94 |
1 files changed, 46 insertions, 48 deletions
diff --git a/docs/DSP/html/group__cmplx__dot__prod.html b/docs/DSP/html/group__cmplx__dot__prod.html index e51be96..ad1b23d 100644 --- a/docs/DSP/html/group__cmplx__dot__prod.html +++ b/docs/DSP/html/group__cmplx__dot__prod.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,43 +116,43 @@ $(document).ready(function(){initNavTree('group__cmplx__dot__prod.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:gadcfaf567a25eb641da4043eafb9bb076"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__dot__prod.html#gadcfaf567a25eb641da4043eafb9bb076">arm_cmplx_dot_prod_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, uint32_t numSamples, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *realResult, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *imagResult)</td></tr> -<tr class="memdesc:gadcfaf567a25eb641da4043eafb9bb076"><td class="mdescLeft"> </td><td class="mdescRight">Floating-point complex dot product. <a href="#gadcfaf567a25eb641da4043eafb9bb076">More...</a><br/></td></tr> -<tr class="separator:gadcfaf567a25eb641da4043eafb9bb076"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga2b08b5e8001d2c15204639d00893fc70"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__dot__prod.html#ga2b08b5e8001d2c15204639d00893fc70">arm_cmplx_dot_prod_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, uint32_t numSamples, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *realResult, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *imagResult)</td></tr> -<tr class="memdesc:ga2b08b5e8001d2c15204639d00893fc70"><td class="mdescLeft"> </td><td class="mdescRight">Q15 complex dot product. <a href="#ga2b08b5e8001d2c15204639d00893fc70">More...</a><br/></td></tr> -<tr class="separator:ga2b08b5e8001d2c15204639d00893fc70"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga5b731a59db062a9ad84562ef68a6c8af"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__dot__prod.html#ga5b731a59db062a9ad84562ef68a6c8af">arm_cmplx_dot_prod_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, uint32_t numSamples, <a class="el" href="arm__math_8h.html#a5aea1cb12fc02d9d44c8abf217eaa5c6">q63_t</a> *realResult, <a class="el" href="arm__math_8h.html#a5aea1cb12fc02d9d44c8abf217eaa5c6">q63_t</a> *imagResult)</td></tr> -<tr class="memdesc:ga5b731a59db062a9ad84562ef68a6c8af"><td class="mdescLeft"> </td><td class="mdescRight">Q31 complex dot product. <a href="#ga5b731a59db062a9ad84562ef68a6c8af">More...</a><br/></td></tr> -<tr class="separator:ga5b731a59db062a9ad84562ef68a6c8af"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga93796e73f02771cf6fe13de016e296ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__dot__prod.html#ga93796e73f02771cf6fe13de016e296ed">arm_cmplx_dot_prod_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, uint32_t numSamples, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *realResult, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *imagResult)</td></tr> +<tr class="memdesc:ga93796e73f02771cf6fe13de016e296ed"><td class="mdescLeft"> </td><td class="mdescRight">Floating-point complex dot product. <a href="#ga93796e73f02771cf6fe13de016e296ed">More...</a><br/></td></tr> +<tr class="separator:ga93796e73f02771cf6fe13de016e296ed"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae712971379c461cfb8bef7e423bf8417"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__dot__prod.html#gae712971379c461cfb8bef7e423bf8417">arm_cmplx_dot_prod_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, uint32_t numSamples, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *realResult, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *imagResult)</td></tr> +<tr class="memdesc:gae712971379c461cfb8bef7e423bf8417"><td class="mdescLeft"> </td><td class="mdescRight">Q15 complex dot product. <a href="#gae712971379c461cfb8bef7e423bf8417">More...</a><br/></td></tr> +<tr class="separator:gae712971379c461cfb8bef7e423bf8417"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa90661b5eee3b6d83a149043ada0eb37"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__dot__prod.html#gaa90661b5eee3b6d83a149043ada0eb37">arm_cmplx_dot_prod_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, uint32_t numSamples, <a class="el" href="arm__math_8h.html#a5aea1cb12fc02d9d44c8abf217eaa5c6">q63_t</a> *realResult, <a class="el" href="arm__math_8h.html#a5aea1cb12fc02d9d44c8abf217eaa5c6">q63_t</a> *imagResult)</td></tr> +<tr class="memdesc:gaa90661b5eee3b6d83a149043ada0eb37"><td class="mdescLeft"> </td><td class="mdescRight">Q31 complex dot product. <a href="#gaa90661b5eee3b6d83a149043ada0eb37">More...</a><br/></td></tr> +<tr class="separator:gaa90661b5eee3b6d83a149043ada0eb37"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> <p>Computes the dot product of two complex vectors. The vectors are multiplied element-by-element and then summed.</p> <p>The <code>pSrcA</code> points to the first complex input vector and <code>pSrcB</code> points to the second complex input vector. <code>numSamples</code> specifies the number of complex samples and the data in each array is stored in an interleaved fashion (real, imag, real, imag, ...). Each array has a total of <code>2*numSamples</code> values.</p> -<p>The underlying algorithm is used: </p> +<p>The underlying algorithm is used:</p> <pre> -realResult=0; -imagResult=0; -for(n=0; n<numSamples; n++) { - realResult += pSrcA[(2*n)+0]*pSrcB[(2*n)+0] - pSrcA[(2*n)+1]*pSrcB[(2*n)+1]; - imagResult += pSrcA[(2*n)+0]*pSrcB[(2*n)+1] + pSrcA[(2*n)+1]*pSrcB[(2*n)+0]; +realResult = 0; +imagResult = 0; +for (n = 0; n < numSamples; n++) { + realResult += pSrcA[(2*n)+0] * pSrcB[(2*n)+0] - pSrcA[(2*n)+1] * pSrcB[(2*n)+1]; + imagResult += pSrcA[(2*n)+0] * pSrcB[(2*n)+1] + pSrcA[(2*n)+1] * pSrcB[(2*n)+0]; } </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="gadcfaf567a25eb641da4043eafb9bb076"></a> +<a class="anchor" id="ga93796e73f02771cf6fe13de016e296ed"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_cmplx_dot_prod_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> @@ -182,32 +182,32 @@ for(n=0; n<numSamples; n++) { </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname">*pSrcA</td><td>points to the first input vector </td></tr> - <tr><td class="paramname">*pSrcB</td><td>points to the second input vector </td></tr> - <tr><td class="paramname">numSamples</td><td>number of complex samples in each vector </td></tr> - <tr><td class="paramname">*realResult</td><td>real part of the result returned here </td></tr> - <tr><td class="paramname">*imagResult</td><td>imaginary part of the result returned here </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">[in]</td><td class="paramname">numSamples</td><td>number of samples in each vector </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">realResult</td><td>real part of the result returned here </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">imagResult</td><td>imaginary part of the result returned here </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none. </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>none </dd></dl> </div> </div> -<a class="anchor" id="ga2b08b5e8001d2c15204639d00893fc70"></a> +<a class="anchor" id="gae712971379c461cfb8bef7e423bf8417"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_cmplx_dot_prod_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> @@ -237,34 +237,33 @@ for(n=0; n<numSamples; n++) { </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname">*pSrcA</td><td>points to the first input vector </td></tr> - <tr><td class="paramname">*pSrcB</td><td>points to the second input vector </td></tr> - <tr><td class="paramname">numSamples</td><td>number of complex samples in each vector </td></tr> - <tr><td class="paramname">*realResult</td><td>real part of the result returned here </td></tr> - <tr><td class="paramname">*imagResult</td><td>imaginary part of the result returned here </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">[in]</td><td class="paramname">numSamples</td><td>number of samples in each vector </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">realResult</td><td>real part of the result returned here </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">imagResult</td><td>imaginary part of the result returned her </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 intermediate 1.15 by 1.15 multiplications are performed with full precision and yield a 2.30 result. These are accumulated in a 64-bit accumulator with 34.30 precision. As a final step, the accumulators are converted to 8.24 format. The return results <code>realResult</code> and <code>imagResult</code> are in 8.24 format. </dd></dl> +<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 intermediate 1.15 by 1.15 multiplications are performed with full precision and yield a 2.30 result. These are accumulated in a 64-bit accumulator with 34.30 precision. As a final step, the accumulators are converted to 8.24 format. The return results <code>realResult</code> and <code>imagResult</code> are in 8.24 format. </dd></dl> </div> </div> -<a class="anchor" id="ga5b731a59db062a9ad84562ef68a6c8af"></a> +<a class="anchor" id="gaa90661b5eee3b6d83a149043ada0eb37"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_cmplx_dot_prod_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> @@ -294,17 +293,16 @@ for(n=0; n<numSamples; n++) { </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname">*pSrcA</td><td>points to the first input vector </td></tr> - <tr><td class="paramname">*pSrcB</td><td>points to the second input vector </td></tr> - <tr><td class="paramname">numSamples</td><td>number of complex samples in each vector </td></tr> - <tr><td class="paramname">*realResult</td><td>real part of the result returned here </td></tr> - <tr><td class="paramname">*imagResult</td><td>imaginary part of the result returned here </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">[in]</td><td class="paramname">numSamples</td><td>number of samples in each vector </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">realResult</td><td>real part of the result returned here </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">imagResult</td><td>imaginary part of the result 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 intermediate 1.31 by 1.31 multiplications are performed with 64-bit precision and then shifted to 16.48 format. The internal real and imaginary accumulators are in 16.48 format and provide 15 guard bits. Additions are nonsaturating and no overflow will occur as long as <code>numSamples</code> is less than 32768. The return results <code>realResult</code> and <code>imagResult</code> are in 16.48 format. Input down scaling is not required. </dd></dl> +<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 intermediate 1.31 by 1.31 multiplications are performed with 64-bit precision and then shifted to 16.48 format. The internal real and imaginary accumulators are in 16.48 format and provide 15 guard bits. Additions are nonsaturating and no overflow will occur as long as <code>numSamples</code> is less than 32768. The return results <code>realResult</code> and <code>imagResult</code> are in 16.48 format. Input down scaling is not required. </dd></dl> </div> </div> @@ -313,7 +311,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 |