git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/Documentation/DSP_Lib/html/group___cmplx_by_cmplx_mult.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <title>CMSIS DSP Software Library: Complex-by-Complex Multiplication</title>
   6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   7 <link href="search/search.css" rel="stylesheet" type="text/css"/>
   8 <script type="text/javaScript" src="search/search.js"></script>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 </head>
  11 <body onload='searchBox.OnSelectItem(0);'>
  12 <!-- Generated by Doxygen 1.7.2 -->
  13 <script type="text/javascript"><!--
  14 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  15 --></script>
  16 <div class="navigation" id="top">
  17   <div class="tabs">
  18     <ul class="tablist">
  19       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  20       <li><a href="modules.html"><span>Modules</span></a></li>
  21       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  22       <li><a href="files.html"><span>Files</span></a></li>
  23       <li><a href="examples.html"><span>Examples</span></a></li>
  24       <li id="searchli">
  25         <div id="MSearchBox" class="MSearchBoxInactive">
  26         <span class="left">
  27           <img id="MSearchSelect" src="search/mag_sel.png"
  28                onmouseover="return searchBox.OnSearchSelectShow()"
  29                onmouseout="return searchBox.OnSearchSelectHide()"
  30                alt=""/>
  31           <input type="text" id="MSearchField" value="Search" accesskey="S"
  32                onfocus="searchBox.OnSearchFieldFocus(true)"
  33                onblur="searchBox.OnSearchFieldFocus(false)"
  34                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  35           </span><span class="right">
  36             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  37           </span>
  38         </div>
  39       </li>
  40     </ul>
  41   </div>
  42 </div>
  43 <div class="header">
  44   <div class="summary">
  45 <a href="#func-members">Functions</a>  </div>
  46   <div class="headertitle">
  47 <h1>Complex-by-Complex Multiplication<br/>
  48 <small>
  49 [<a class="el" href="group__group_cmplx_math.html">Complex Math Functions</a>]</small>
  50 </h1>  </div>
  51 </div>
  52 <div class="contents">
  53 <table class="memberdecls">
  54 <tr><td colspan="2"><h2><a name="func-members"></a>
  55 Functions</h2></td></tr>
  56 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___cmplx_by_cmplx_mult.html#ga14b47080054a1ba1250a86805be1ff6b">arm_cmplx_mult_cmplx_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 numSamples)</td></tr>
  57 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___cmplx_by_cmplx_mult.html#ga1829e50993a90742de225a0ce4213838">arm_cmplx_mult_cmplx_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 numSamples)</td></tr>
  58 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___cmplx_by_cmplx_mult.html#ga67e96abfc9c3e30efb70a2ec9d0fe7e8">arm_cmplx_mult_cmplx_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 numSamples)</td></tr>
  59 </table>
  60 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  61 <p>Multiplies a complex vector by another complex vector and generates a complex result. The data in the complex arrays is stored in an interleaved fashion (real, imag, real, imag, ...). The parameter <code>numSamples</code> represents the number of complex samples processed. The complex arrays have a total of <code>2*numSamples</code> real values.</p>
  62 <p>The underlying algorithm is used:</p>
  63 <pre>
  64  for(n=0; n&lt;numSamples; n++) {
  65      pDst[(2*n)+0] = pSrcA[(2*n)+0] * pSrcB[(2*n)+0] - pSrcA[(2*n)+1] * pSrcB[(2*n)+1];
  66      pDst[(2*n)+1] = pSrcA[(2*n)+0] * pSrcB[(2*n)+1] + pSrcA[(2*n)+1] * pSrcB[(2*n)+0];
  67  }
  68  </pre><p>There are separate functions for floating-point, Q15, and Q31 data types. </p>
  69 <hr/><h2>Function Documentation</h2>
  70 <a class="anchor" id="ga14b47080054a1ba1250a86805be1ff6b"></a><!-- doxytag: member="arm_cmplx_mult_cmplx_f32.c::arm_cmplx_mult_cmplx_f32" ref="ga14b47080054a1ba1250a86805be1ff6b" args="(float32_t *pSrcA, float32_t *pSrcB, float32_t *pDst, uint32_t numSamples)" -->
  71 <div class="memitem">
  72 <div class="memproto">
  73       <table class="memname">
  74         <tr>
  75           <td class="memname">void arm_cmplx_mult_cmplx_f32 </td>
  76           <td>(</td>
  77           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  78           <td class="paramname"> <em>pSrcA</em>, </td>
  79         </tr>
  80         <tr>
  81           <td class="paramkey"></td>
  82           <td></td>
  83           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  84           <td class="paramname"> <em>pSrcB</em>, </td>
  85         </tr>
  86         <tr>
  87           <td class="paramkey"></td>
  88           <td></td>
  89           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  90           <td class="paramname"> <em>pDst</em>, </td>
  91         </tr>
  92         <tr>
  93           <td class="paramkey"></td>
  94           <td></td>
  95           <td class="paramtype">uint32_t&#160;</td>
  96           <td class="paramname"> <em>numSamples</em>&#160;</td>
  97         </tr>
  98         <tr>
  99           <td></td>
 100           <td>)</td>
 101           <td></td><td></td>
 102         </tr>
 103       </table>
 104 </div>
 105 <div class="memdoc">
 106
 107 <p>Floating-point complex-by-complex multiplication. </p>
 108 <dl><dt><b>Parameters:</b></dt><dd>
 109   <table class="params">
 110     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input vector </td></tr>
 111     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input vector </td></tr>
 112     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output vector </td></tr>
 113     <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of complex samples in each vector </td></tr>
 114   </table>
 115   </dd>
 116 </dl>
 117 <dl class="return"><dt><b>Returns:</b></dt><dd>none. </dd></dl>
 118 <dl><dt><b>Examples: </b></dt><dd><a class="el" href="arm_convolution_example_f32_8c-example.html#a18">arm_convolution_example_f32.c</a>.</dd>
 119 </dl>
 120 <p>Definition at line <a class="el" href="arm__cmplx__mult__cmplx__f32_8c_source.html#l00073">73</a> of file <a class="el" href="arm__cmplx__mult__cmplx__f32_8c_source.html">arm_cmplx_mult_cmplx_f32.c</a>.</p>
 121
 122 </div>
 123 </div>
 124 <a class="anchor" id="ga1829e50993a90742de225a0ce4213838"></a><!-- doxytag: member="arm_cmplx_mult_cmplx_q31.c::arm_cmplx_mult_cmplx_q31" ref="ga1829e50993a90742de225a0ce4213838" args="(q31_t *pSrcA, q31_t *pSrcB, q31_t *pDst, uint32_t numSamples)" -->
 125 <div class="memitem">
 126 <div class="memproto">
 127       <table class="memname">
 128         <tr>
 129           <td class="memname">void arm_cmplx_mult_cmplx_q31 </td>
 130           <td>(</td>
 131           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
 132           <td class="paramname"> <em>pSrcA</em>, </td>
 133         </tr>
 134         <tr>
 135           <td class="paramkey"></td>
 136           <td></td>
 137           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
 138           <td class="paramname"> <em>pSrcB</em>, </td>
 139         </tr>
 140         <tr>
 141           <td class="paramkey"></td>
 142           <td></td>
 143           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
 144           <td class="paramname"> <em>pDst</em>, </td>
 145         </tr>
 146         <tr>
 147           <td class="paramkey"></td>
 148           <td></td>
 149           <td class="paramtype">uint32_t&#160;</td>
 150           <td class="paramname"> <em>numSamples</em>&#160;</td>
 151         </tr>
 152         <tr>
 153           <td></td>
 154           <td>)</td>
 155           <td></td><td></td>
 156         </tr>
 157       </table>
 158 </div>
 159 <div class="memdoc">
 160
 161 <p>Q31 complex-by-complex multiplication. </p>
 162 <dl><dt><b>Parameters:</b></dt><dd>
 163   <table class="params">
 164     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input vector </td></tr>
 165     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input vector </td></tr>
 166     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output vector </td></tr>
 167     <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of complex samples in each vector </td></tr>
 168   </table>
 169   </dd>
 170 </dl>
 171 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 172 <p><b>Scaling and Overflow Behavior:</b> </p>
 173 <dl class="user"><dt><b></b></dt><dd>The function implements 1.31 by 1.31 multiplications and finally output is converted into 3.29 format. Input down scaling is not required. </dd></dl>
 174
 175 <p>Definition at line <a class="el" href="arm__cmplx__mult__cmplx__q31_8c_source.html#l00056">56</a> of file <a class="el" href="arm__cmplx__mult__cmplx__q31_8c_source.html">arm_cmplx_mult_cmplx_q31.c</a>.</p>
 176
 177 </div>
 178 </div>
 179 <a class="anchor" id="ga67e96abfc9c3e30efb70a2ec9d0fe7e8"></a><!-- doxytag: member="arm_cmplx_mult_cmplx_q15.c::arm_cmplx_mult_cmplx_q15" ref="ga67e96abfc9c3e30efb70a2ec9d0fe7e8" args="(q15_t *pSrcA, q15_t *pSrcB, q15_t *pDst, uint32_t numSamples)" -->
 180 <div class="memitem">
 181 <div class="memproto">
 182       <table class="memname">
 183         <tr>
 184           <td class="memname">void arm_cmplx_mult_cmplx_q15 </td>
 185           <td>(</td>
 186           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
 187           <td class="paramname"> <em>pSrcA</em>, </td>
 188         </tr>
 189         <tr>
 190           <td class="paramkey"></td>
 191           <td></td>
 192           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
 193           <td class="paramname"> <em>pSrcB</em>, </td>
 194         </tr>
 195         <tr>
 196           <td class="paramkey"></td>
 197           <td></td>
 198           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
 199           <td class="paramname"> <em>pDst</em>, </td>
 200         </tr>
 201         <tr>
 202           <td class="paramkey"></td>
 203           <td></td>
 204           <td class="paramtype">uint32_t&#160;</td>
 205           <td class="paramname"> <em>numSamples</em>&#160;</td>
 206         </tr>
 207         <tr>
 208           <td></td>
 209           <td>)</td>
 210           <td></td><td></td>
 211         </tr>
 212       </table>
 213 </div>
 214 <div class="memdoc">
 215
 216 <p>Q15 complex-by-complex multiplication. </p>
 217 <dl><dt><b>Parameters:</b></dt><dd>
 218   <table class="params">
 219     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input vector </td></tr>
 220     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input vector </td></tr>
 221     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output vector </td></tr>
 222     <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of complex samples in each vector </td></tr>
 223   </table>
 224   </dd>
 225 </dl>
 226 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 227 <p><b>Scaling and Overflow Behavior:</b> </p>
 228 <dl class="user"><dt><b></b></dt><dd>The function implements 1.15 by 1.15 multiplications and finally output is converted into 3.13 format. </dd></dl>
 229
 230 <p>Definition at line <a class="el" href="arm__cmplx__mult__cmplx__q15_8c_source.html#l00054">54</a> of file <a class="el" href="arm__cmplx__mult__cmplx__q15_8c_source.html">arm_cmplx_mult_cmplx_q15.c</a>.</p>
 231
 232 </div>
 233 </div>
 234 </div>
 235 <!--- window showing the filter options -->
 236 <div id="MSearchSelectWindow"
 237      onmouseover="return searchBox.OnSearchSelectShow()"
 238      onmouseout="return searchBox.OnSearchSelectHide()"
 239      onkeydown="return searchBox.OnSearchSelectKey(event)">
 240 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>
 241
 242 <!-- iframe showing the search results (closed by default) -->
 243 <div id="MSearchResultsWindow">
 244 <iframe src="" frameborder="0"
 245         name="MSearchResults" id="MSearchResults">
 246 </iframe>
 247 </div>
 248
 249 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:20 for CMSIS DSP Software Library by&#160;
 250 <a href="http://www.doxygen.org/index.html">
 251 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 252 </body>
 253 </html>