group__CmplxByRealMult.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299
  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. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>Complex-by-Real Multiplication</title>
  7. <title>CMSIS-DSP: Complex-by-Real Multiplication</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="printComponentTabs.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="resize.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-DSP
  35. &#160;<span id="projectnumber">Version 1.8.0</span>
  36. </div>
  37. <div id="projectbrief">CMSIS DSP Software Library</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('group__CmplxByRealMult.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="summary">
  109. <a href="#func-members">Functions</a> </div>
  110. <div class="headertitle">
  111. <div class="title">Complex-by-Real Multiplication<div class="ingroups"><a class="el" href="group__groupCmplxMath.html">Complex Math Functions</a></div></div> </div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <table class="memberdecls">
  115. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  116. Functions</h2></td></tr>
  117. <tr class="memitem:ga903eb30a02343574e46cb123b52232f4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CmplxByRealMult.html#ga903eb30a02343574e46cb123b52232f4">arm_cmplx_mult_real_f32</a> (const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrcCmplx, const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrcReal, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pCmplxDst, uint32_t numSamples)</td></tr>
  118. <tr class="memdesc:ga903eb30a02343574e46cb123b52232f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Floating-point complex-by-real multiplication. <a href="#ga903eb30a02343574e46cb123b52232f4">More...</a><br/></td></tr>
  119. <tr class="separator:ga903eb30a02343574e46cb123b52232f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:gaa41d60a567652bf6a783b916931bf20b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CmplxByRealMult.html#gaa41d60a567652bf6a783b916931bf20b">arm_cmplx_mult_real_q15</a> (const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcCmplx, const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcReal, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pCmplxDst, uint32_t numSamples)</td></tr>
  121. <tr class="memdesc:gaa41d60a567652bf6a783b916931bf20b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q15 complex-by-real multiplication. <a href="#gaa41d60a567652bf6a783b916931bf20b">More...</a><br/></td></tr>
  122. <tr class="separator:gaa41d60a567652bf6a783b916931bf20b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:ga0fe1cd71d35b4481f8ab69d502c96ace"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CmplxByRealMult.html#ga0fe1cd71d35b4481f8ab69d502c96ace">arm_cmplx_mult_real_q31</a> (const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrcCmplx, const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrcReal, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pCmplxDst, uint32_t numSamples)</td></tr>
  124. <tr class="memdesc:ga0fe1cd71d35b4481f8ab69d502c96ace"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q31 complex-by-real multiplication. <a href="#ga0fe1cd71d35b4481f8ab69d502c96ace">More...</a><br/></td></tr>
  125. <tr class="separator:ga0fe1cd71d35b4481f8ab69d502c96ace"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table>
  127. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  128. <p>Multiplies a complex vector by a real 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 while the real array has a total of <code>numSamples</code> real values.</p>
  129. <p>The underlying algorithm is used:</p>
  130. <pre>
  131. for (n = 0; n &lt; numSamples; n++) {
  132. pCmplxDst[(2*n)+0] = pSrcCmplx[(2*n)+0] * pSrcReal[n];
  133. pCmplxDst[(2*n)+1] = pSrcCmplx[(2*n)+1] * pSrcReal[n];
  134. }
  135. </pre><p>There are separate functions for floating-point, Q15, and Q31 data types. </p>
  136. <h2 class="groupheader">Function Documentation</h2>
  137. <a class="anchor" id="ga903eb30a02343574e46cb123b52232f4"></a>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">void arm_cmplx_mult_real_f32 </td>
  143. <td>(</td>
  144. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  145. <td class="paramname"><em>pSrcCmplx</em>, </td>
  146. </tr>
  147. <tr>
  148. <td class="paramkey"></td>
  149. <td></td>
  150. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  151. <td class="paramname"><em>pSrcReal</em>, </td>
  152. </tr>
  153. <tr>
  154. <td class="paramkey"></td>
  155. <td></td>
  156. <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  157. <td class="paramname"><em>pCmplxDst</em>, </td>
  158. </tr>
  159. <tr>
  160. <td class="paramkey"></td>
  161. <td></td>
  162. <td class="paramtype">uint32_t&#160;</td>
  163. <td class="paramname"><em>numSamples</em>&#160;</td>
  164. </tr>
  165. <tr>
  166. <td></td>
  167. <td>)</td>
  168. <td></td><td></td>
  169. </tr>
  170. </table>
  171. </div><div class="memdoc">
  172. <dl class="params"><dt>Parameters</dt><dd>
  173. <table class="params">
  174. <tr><td class="paramdir">[in]</td><td class="paramname">pSrcCmplx</td><td>points to complex input vector </td></tr>
  175. <tr><td class="paramdir">[in]</td><td class="paramname">pSrcReal</td><td>points to real input vector </td></tr>
  176. <tr><td class="paramdir">[out]</td><td class="paramname">pCmplxDst</td><td>points to complex output vector </td></tr>
  177. <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of samples in each vector </td></tr>
  178. </table>
  179. </dd>
  180. </dl>
  181. <dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
  182. </div>
  183. </div>
  184. <a class="anchor" id="gaa41d60a567652bf6a783b916931bf20b"></a>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname">void arm_cmplx_mult_real_q15 </td>
  190. <td>(</td>
  191. <td class="paramtype">const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
  192. <td class="paramname"><em>pSrcCmplx</em>, </td>
  193. </tr>
  194. <tr>
  195. <td class="paramkey"></td>
  196. <td></td>
  197. <td class="paramtype">const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
  198. <td class="paramname"><em>pSrcReal</em>, </td>
  199. </tr>
  200. <tr>
  201. <td class="paramkey"></td>
  202. <td></td>
  203. <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
  204. <td class="paramname"><em>pCmplxDst</em>, </td>
  205. </tr>
  206. <tr>
  207. <td class="paramkey"></td>
  208. <td></td>
  209. <td class="paramtype">uint32_t&#160;</td>
  210. <td class="paramname"><em>numSamples</em>&#160;</td>
  211. </tr>
  212. <tr>
  213. <td></td>
  214. <td>)</td>
  215. <td></td><td></td>
  216. </tr>
  217. </table>
  218. </div><div class="memdoc">
  219. <dl class="params"><dt>Parameters</dt><dd>
  220. <table class="params">
  221. <tr><td class="paramdir">[in]</td><td class="paramname">pSrcCmplx</td><td>points to complex input vector </td></tr>
  222. <tr><td class="paramdir">[in]</td><td class="paramname">pSrcReal</td><td>points to real input vector </td></tr>
  223. <tr><td class="paramdir">[out]</td><td class="paramname">pCmplxDst</td><td>points to complex output vector </td></tr>
  224. <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of samples in each vector </td></tr>
  225. </table>
  226. </dd>
  227. </dl>
  228. <dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
  229. <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>
  230. </div>
  231. </div>
  232. <a class="anchor" id="ga0fe1cd71d35b4481f8ab69d502c96ace"></a>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname">void arm_cmplx_mult_real_q31 </td>
  238. <td>(</td>
  239. <td class="paramtype">const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
  240. <td class="paramname"><em>pSrcCmplx</em>, </td>
  241. </tr>
  242. <tr>
  243. <td class="paramkey"></td>
  244. <td></td>
  245. <td class="paramtype">const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
  246. <td class="paramname"><em>pSrcReal</em>, </td>
  247. </tr>
  248. <tr>
  249. <td class="paramkey"></td>
  250. <td></td>
  251. <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
  252. <td class="paramname"><em>pCmplxDst</em>, </td>
  253. </tr>
  254. <tr>
  255. <td class="paramkey"></td>
  256. <td></td>
  257. <td class="paramtype">uint32_t&#160;</td>
  258. <td class="paramname"><em>numSamples</em>&#160;</td>
  259. </tr>
  260. <tr>
  261. <td></td>
  262. <td>)</td>
  263. <td></td><td></td>
  264. </tr>
  265. </table>
  266. </div><div class="memdoc">
  267. <dl class="params"><dt>Parameters</dt><dd>
  268. <table class="params">
  269. <tr><td class="paramdir">[in]</td><td class="paramname">pSrcCmplx</td><td>points to complex input vector </td></tr>
  270. <tr><td class="paramdir">[in]</td><td class="paramname">pSrcReal</td><td>points to real input vector </td></tr>
  271. <tr><td class="paramdir">[out]</td><td class="paramname">pCmplxDst</td><td>points to complex output vector </td></tr>
  272. <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of samples in each vector </td></tr>
  273. </table>
  274. </dd>
  275. </dl>
  276. <dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
  277. <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>
  278. </div>
  279. </div>
  280. </div><!-- contents -->
  281. </div><!-- doc-content -->
  282. <!-- start footer part -->
  283. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  284. <ul>
  285. <li class="footer">Generated on Thu Apr 9 2020 15:49:23 for CMSIS-DSP Version 1.8.0 by Arm Ltd. All rights reserved.
  286. <!--
  287. <a href="http://www.doxygen.org/index.html">
  288. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  289. -->
  290. </li>
  291. </ul>
  292. </div>
  293. </body>
  294. </html>