diff options
Diffstat (limited to 'docs/DSP/html/group__cmplx__conj.html')
| -rw-r--r-- | docs/DSP/html/group__cmplx__conj.html | 77 |
1 files changed, 36 insertions, 41 deletions
diff --git a/docs/DSP/html/group__cmplx__conj.html b/docs/DSP/html/group__cmplx__conj.html index 81176b7..5f9f696 100644 --- a/docs/DSP/html/group__cmplx__conj.html +++ b/docs/DSP/html/group__cmplx__conj.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,34 +116,35 @@ $(document).ready(function(){initNavTree('group__cmplx__conj.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:ga3a102aead6460ad9fcb0626f6b226ffb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__conj.html#ga3a102aead6460ad9fcb0626f6b226ffb">arm_cmplx_conj_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:ga3a102aead6460ad9fcb0626f6b226ffb"><td class="mdescLeft"> </td><td class="mdescRight">Floating-point complex conjugate. <a href="#ga3a102aead6460ad9fcb0626f6b226ffb">More...</a><br/></td></tr> -<tr class="separator:ga3a102aead6460ad9fcb0626f6b226ffb"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaf47689ae07962acaecb8ddde556df4a4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__conj.html#gaf47689ae07962acaecb8ddde556df4a4">arm_cmplx_conj_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:gaf47689ae07962acaecb8ddde556df4a4"><td class="mdescLeft"> </td><td class="mdescRight">Q15 complex conjugate. <a href="#gaf47689ae07962acaecb8ddde556df4a4">More...</a><br/></td></tr> -<tr class="separator:gaf47689ae07962acaecb8ddde556df4a4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gafecc94879a383c5208ec3ef99485e4b5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__conj.html#gafecc94879a383c5208ec3ef99485e4b5">arm_cmplx_conj_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:gafecc94879a383c5208ec3ef99485e4b5"><td class="mdescLeft"> </td><td class="mdescRight">Q31 complex conjugate. <a href="#gafecc94879a383c5208ec3ef99485e4b5">More...</a><br/></td></tr> -<tr class="separator:gafecc94879a383c5208ec3ef99485e4b5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1b5571244b051bb72db30886896da2da"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__conj.html#ga1b5571244b051bb72db30886896da2da">arm_cmplx_conj_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:ga1b5571244b051bb72db30886896da2da"><td class="mdescLeft"> </td><td class="mdescRight">Floating-point complex conjugate. <a href="#ga1b5571244b051bb72db30886896da2da">More...</a><br/></td></tr> +<tr class="separator:ga1b5571244b051bb72db30886896da2da"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2eef7dba99852d5f7ec3e025b2e5653b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__conj.html#ga2eef7dba99852d5f7ec3e025b2e5653b">arm_cmplx_conj_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:ga2eef7dba99852d5f7ec3e025b2e5653b"><td class="mdescLeft"> </td><td class="mdescRight">Q15 complex conjugate. <a href="#ga2eef7dba99852d5f7ec3e025b2e5653b">More...</a><br/></td></tr> +<tr class="separator:ga2eef7dba99852d5f7ec3e025b2e5653b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga652edf2688aae9b2f53c5da73f6cc2bc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cmplx__conj.html#ga652edf2688aae9b2f53c5da73f6cc2bc">arm_cmplx_conj_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:ga652edf2688aae9b2f53c5da73f6cc2bc"><td class="mdescLeft"> </td><td class="mdescRight">Q31 complex conjugate. <a href="#ga652edf2688aae9b2f53c5da73f6cc2bc">More...</a><br/></td></tr> +<tr class="separator:ga652edf2688aae9b2f53c5da73f6cc2bc"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> <p>Conjugates 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 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. The underlying algorithm is used:</p> +<p>The <code>pSrc</code> points to the source data and <code>pDst</code> points to the destination data where the result should be written. <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> <pre> -for(n=0; n<numSamples; n++) { - pDst[(2*n)+0)] = pSrc[(2*n)+0]; // real part - pDst[(2*n)+1)] = -pSrc[(2*n)+1]; // imag part +for (n = 0; n < numSamples; n++) { + pDst[(2*n) ] = pSrc[(2*n) ]; // real part + pDst[(2*n)+1] = -pSrc[(2*n)+1]; // imag part } </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="ga3a102aead6460ad9fcb0626f6b226ffb"></a> +<a class="anchor" id="ga1b5571244b051bb72db30886896da2da"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_cmplx_conj_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> @@ -167,24 +168,24 @@ 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 input vector </td></tr> - <tr><td class="paramname">*pDst</td><td>points to the output vector </td></tr> - <tr><td class="paramname">numSamples</td><td>number of complex samples in each vector </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">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> +<dl class="section return"><dt>Returns</dt><dd>none </dd></dl> </div> </div> -<a class="anchor" id="gaf47689ae07962acaecb8ddde556df4a4"></a> +<a class="anchor" id="ga2eef7dba99852d5f7ec3e025b2e5653b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_cmplx_conj_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> @@ -208,28 +209,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 input vector </td></tr> - <tr><td class="paramname">*pDst</td><td>points to the output vector </td></tr> - <tr><td class="paramname">numSamples</td><td>number of complex samples in each vector </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">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 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#aad6f7afa72d784b95e6357c215a919bb">__QASX()</a>, <a class="el" href="arm__math_8h.html#a391f5f1d2e7cefaccfece0a49141ad47">__QSAX()</a>, and <a class="el" href="arm__math_8h.html#a9de2e0a5785be82866bcb96012282248">__SIMD32</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) is saturated to the maximum allowable positive value 0x7FFF. </dd></dl> </div> </div> -<a class="anchor" id="gafecc94879a383c5208ec3ef99485e4b5"></a> +<a class="anchor" id="ga652edf2688aae9b2f53c5da73f6cc2bc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_cmplx_conj_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> @@ -253,17 +251,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 input vector </td></tr> - <tr><td class="paramname">*pDst</td><td>points to the output vector </td></tr> - <tr><td class="paramname">numSamples</td><td>number of complex samples in each vector </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">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 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>.</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) is saturated to the maximum allowable positive value 0x7FFFFFFF. </dd></dl> </div> </div> @@ -272,7 +267,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 |