arm__fir__example_2math__helper_8h.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709
  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>math_helper.h File Reference</title>
  7. <title>CMSIS-DSP: math_helper.h File Reference</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('arm__fir__example_2math__helper_8h.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">arm_fir_example/math_helper.h File Reference</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:aeea2952e70a1040a6efa555564bbeeab"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__fir__example_2math__helper_8h.html#aeea2952e70a1040a6efa555564bbeeab">arm_snr_f32</a> (float *pRef, float *pTest, uint32_t buffSize)</td></tr>
  118. <tr class="memdesc:aeea2952e70a1040a6efa555564bbeeab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Caluclation of SNR. <a href="#aeea2952e70a1040a6efa555564bbeeab">More...</a><br/></td></tr>
  119. <tr class="separator:aeea2952e70a1040a6efa555564bbeeab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a23f94b0fbfed6d620f38e26bc64cf2f8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__fir__example_2math__helper_8h.html#a23f94b0fbfed6d620f38e26bc64cf2f8">arm_float_to_q12_20</a> (float *pIn, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pOut, uint32_t numSamples)</td></tr>
  121. <tr class="memdesc:a23f94b0fbfed6d620f38e26bc64cf2f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts float to fixed in q12.20 format. <a href="#a23f94b0fbfed6d620f38e26bc64cf2f8">More...</a><br/></td></tr>
  122. <tr class="separator:a23f94b0fbfed6d620f38e26bc64cf2f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:ac8209be1b8081e833c3ec2e85ad2255b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__fir__example_2math__helper_8h.html#ac8209be1b8081e833c3ec2e85ad2255b">arm_provide_guard_bits_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *input_buf, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, uint32_t guard_bits)</td></tr>
  124. <tr class="memdesc:ac8209be1b8081e833c3ec2e85ad2255b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provide guard bits for Input buffer. <a href="#ac8209be1b8081e833c3ec2e85ad2255b">More...</a><br/></td></tr>
  125. <tr class="separator:ac8209be1b8081e833c3ec2e85ad2255b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:aead320f821f927000386d9d7d5ad6d27"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__fir__example_2math__helper_8h.html#aead320f821f927000386d9d7d5ad6d27">arm_provide_guard_bits_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *input_buf, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, uint32_t guard_bits)</td></tr>
  127. <tr class="memdesc:aead320f821f927000386d9d7d5ad6d27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provide guard bits for Input buffer. <a href="#aead320f821f927000386d9d7d5ad6d27">More...</a><br/></td></tr>
  128. <tr class="separator:aead320f821f927000386d9d7d5ad6d27"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a23cdb5202efd9233f4e92b5f22287eac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__fir__example_2math__helper_8h.html#a23cdb5202efd9233f4e92b5f22287eac">arm_float_to_q14</a> (float *pIn, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pOut, uint32_t numSamples)</td></tr>
  130. <tr class="memdesc:a23cdb5202efd9233f4e92b5f22287eac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts float to fixed q14. <a href="#a23cdb5202efd9233f4e92b5f22287eac">More...</a><br/></td></tr>
  131. <tr class="separator:a23cdb5202efd9233f4e92b5f22287eac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a098c587b93469a7a6bcc521d42fdf6f9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__fir__example_2math__helper_8h.html#a098c587b93469a7a6bcc521d42fdf6f9">arm_float_to_q29</a> (float *pIn, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pOut, uint32_t numSamples)</td></tr>
  133. <tr class="memdesc:a098c587b93469a7a6bcc521d42fdf6f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts float to fixed q30 format. <a href="#a098c587b93469a7a6bcc521d42fdf6f9">More...</a><br/></td></tr>
  134. <tr class="separator:a098c587b93469a7a6bcc521d42fdf6f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:aa1049b3adb14331612bb762237391625"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__fir__example_2math__helper_8h.html#aa1049b3adb14331612bb762237391625">arm_float_to_q28</a> (float *pIn, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pOut, uint32_t numSamples)</td></tr>
  136. <tr class="memdesc:aa1049b3adb14331612bb762237391625"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts float to fixed q28 format. <a href="#aa1049b3adb14331612bb762237391625">More...</a><br/></td></tr>
  137. <tr class="separator:aa1049b3adb14331612bb762237391625"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a16764fdbc174a79f04b07032cf902079"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__fir__example_2math__helper_8h.html#a16764fdbc174a79f04b07032cf902079">arm_float_to_q30</a> (float *pIn, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pOut, uint32_t numSamples)</td></tr>
  139. <tr class="memdesc:a16764fdbc174a79f04b07032cf902079"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts float to fixed q30 format. <a href="#a16764fdbc174a79f04b07032cf902079">More...</a><br/></td></tr>
  140. <tr class="separator:a16764fdbc174a79f04b07032cf902079"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:ab9768d92bb94894d8294047bdf76a16a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__fir__example_2math__helper_8h.html#ab9768d92bb94894d8294047bdf76a16a">arm_clip_f32</a> (float *pIn, uint32_t numSamples)</td></tr>
  142. <tr class="memdesc:ab9768d92bb94894d8294047bdf76a16a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clip the float values to +/- 1. <a href="#ab9768d92bb94894d8294047bdf76a16a">More...</a><br/></td></tr>
  143. <tr class="separator:ab9768d92bb94894d8294047bdf76a16a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a60ff6e0b31a5e9105c7280797e457742"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__fir__example_2math__helper_8h.html#a60ff6e0b31a5e9105c7280797e457742">arm_calc_guard_bits</a> (uint32_t num_adds)</td></tr>
  145. <tr class="memdesc:a60ff6e0b31a5e9105c7280797e457742"><td class="mdescLeft">&#160;</td><td class="mdescRight">Caluclates number of guard bits. <a href="#a60ff6e0b31a5e9105c7280797e457742">More...</a><br/></td></tr>
  146. <tr class="separator:a60ff6e0b31a5e9105c7280797e457742"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a13580a6ff7a8a68146de727bdf8fba88"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__fir__example_2math__helper_8h.html#a13580a6ff7a8a68146de727bdf8fba88">arm_apply_guard_bits</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIn, uint32_t numSamples, uint32_t guard_bits)</td></tr>
  148. <tr class="memdesc:a13580a6ff7a8a68146de727bdf8fba88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Apply guard bits to buffer. <a href="#a13580a6ff7a8a68146de727bdf8fba88">More...</a><br/></td></tr>
  149. <tr class="separator:a13580a6ff7a8a68146de727bdf8fba88"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a64d5207c035db13cddde479317dd131e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__fir__example_2math__helper_8h.html#a64d5207c035db13cddde479317dd131e">arm_compare_fixed_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pIn, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pOut, uint32_t numSamples)</td></tr>
  151. <tr class="memdesc:a64d5207c035db13cddde479317dd131e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare MATLAB Reference Output and ARM Test output. <a href="#a64d5207c035db13cddde479317dd131e">More...</a><br/></td></tr>
  152. <tr class="separator:a64d5207c035db13cddde479317dd131e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a32f9f3d19e53161382c5bd39e3df50fb"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__fir__example_2math__helper_8h.html#a32f9f3d19e53161382c5bd39e3df50fb">arm_compare_fixed_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIn, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pOut, uint32_t numSamples)</td></tr>
  154. <tr class="memdesc:a32f9f3d19e53161382c5bd39e3df50fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare MATLAB Reference Output and ARM Test output. <a href="#a32f9f3d19e53161382c5bd39e3df50fb">More...</a><br/></td></tr>
  155. <tr class="separator:a32f9f3d19e53161382c5bd39e3df50fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a7c94faac575a175e824d5f9879c97c68"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__fir__example_2math__helper_8h.html#a7c94faac575a175e824d5f9879c97c68">arm_calc_2pow</a> (uint32_t guard_bits)</td></tr>
  157. <tr class="memdesc:a7c94faac575a175e824d5f9879c97c68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates pow(2, numShifts) <a href="#a7c94faac575a175e824d5f9879c97c68">More...</a><br/></td></tr>
  158. <tr class="separator:a7c94faac575a175e824d5f9879c97c68"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. </table>
  160. <h2 class="groupheader">Function Documentation</h2>
  161. <a class="anchor" id="a13580a6ff7a8a68146de727bdf8fba88"></a>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname">void arm_apply_guard_bits </td>
  167. <td>(</td>
  168. <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  169. <td class="paramname"><em>pIn</em>, </td>
  170. </tr>
  171. <tr>
  172. <td class="paramkey"></td>
  173. <td></td>
  174. <td class="paramtype">uint32_t&#160;</td>
  175. <td class="paramname"><em>numSamples</em>, </td>
  176. </tr>
  177. <tr>
  178. <td class="paramkey"></td>
  179. <td></td>
  180. <td class="paramtype">uint32_t&#160;</td>
  181. <td class="paramname"><em>guard_bits</em>&#160;</td>
  182. </tr>
  183. <tr>
  184. <td></td>
  185. <td>)</td>
  186. <td></td><td></td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <dl class="params"><dt>Parameters</dt><dd>
  191. <table class="params">
  192. <tr><td class="paramdir">[in,out]</td><td class="paramname">pIn</td><td>pointer to input buffer </td></tr>
  193. <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of samples in the input buffer </td></tr>
  194. <tr><td class="paramdir">[in]</td><td class="paramname">guard_bits</td><td>guard bits </td></tr>
  195. </table>
  196. </dd>
  197. </dl>
  198. <dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
  199. </div>
  200. </div>
  201. <a class="anchor" id="a7c94faac575a175e824d5f9879c97c68"></a>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="memname">
  205. <tr>
  206. <td class="memname">uint32_t arm_calc_2pow </td>
  207. <td>(</td>
  208. <td class="paramtype">uint32_t&#160;</td>
  209. <td class="paramname"><em>numShifts</em></td><td>)</td>
  210. <td></td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <dl class="params"><dt>Parameters</dt><dd>
  215. <table class="params">
  216. <tr><td class="paramdir">[in]</td><td class="paramname">numShifts</td><td>number of shifts </td></tr>
  217. </table>
  218. </dd>
  219. </dl>
  220. <dl class="section return"><dt>Returns</dt><dd>pow(2, numShifts) </dd></dl>
  221. </div>
  222. </div>
  223. <a class="anchor" id="a60ff6e0b31a5e9105c7280797e457742"></a>
  224. <div class="memitem">
  225. <div class="memproto">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">uint32_t arm_calc_guard_bits </td>
  229. <td>(</td>
  230. <td class="paramtype">uint32_t&#160;</td>
  231. <td class="paramname"><em>num_adds</em></td><td>)</td>
  232. <td></td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. <dl class="params"><dt>Parameters</dt><dd>
  237. <table class="params">
  238. <tr><td class="paramdir">[in]</td><td class="paramname">num_adds</td><td>number of additions </td></tr>
  239. </table>
  240. </dd>
  241. </dl>
  242. <dl class="section return"><dt>Returns</dt><dd>guard bits The function Caluclates the number of guard bits depending on the numtaps </dd></dl>
  243. </div>
  244. </div>
  245. <a class="anchor" id="ab9768d92bb94894d8294047bdf76a16a"></a>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname">void arm_clip_f32 </td>
  251. <td>(</td>
  252. <td class="paramtype">float *&#160;</td>
  253. <td class="paramname"><em>pIn</em>, </td>
  254. </tr>
  255. <tr>
  256. <td class="paramkey"></td>
  257. <td></td>
  258. <td class="paramtype">uint32_t&#160;</td>
  259. <td class="paramname"><em>numSamples</em>&#160;</td>
  260. </tr>
  261. <tr>
  262. <td></td>
  263. <td>)</td>
  264. <td></td><td></td>
  265. </tr>
  266. </table>
  267. </div><div class="memdoc">
  268. <dl class="params"><dt>Parameters</dt><dd>
  269. <table class="params">
  270. <tr><td class="paramdir">[in,out]</td><td class="paramname">pIn</td><td>input buffer </td></tr>
  271. <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of samples in the buffer </td></tr>
  272. </table>
  273. </dd>
  274. </dl>
  275. <dl class="section return"><dt>Returns</dt><dd>none The function converts floating point values to fixed point values </dd></dl>
  276. </div>
  277. </div>
  278. <a class="anchor" id="a64d5207c035db13cddde479317dd131e"></a>
  279. <div class="memitem">
  280. <div class="memproto">
  281. <table class="memname">
  282. <tr>
  283. <td class="memname">uint32_t arm_compare_fixed_q15 </td>
  284. <td>(</td>
  285. <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
  286. <td class="paramname"><em>pIn</em>, </td>
  287. </tr>
  288. <tr>
  289. <td class="paramkey"></td>
  290. <td></td>
  291. <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
  292. <td class="paramname"><em>pOut</em>, </td>
  293. </tr>
  294. <tr>
  295. <td class="paramkey"></td>
  296. <td></td>
  297. <td class="paramtype">uint32_t&#160;</td>
  298. <td class="paramname"><em>numSamples</em>&#160;</td>
  299. </tr>
  300. <tr>
  301. <td></td>
  302. <td>)</td>
  303. <td></td><td></td>
  304. </tr>
  305. </table>
  306. </div><div class="memdoc">
  307. <dl class="params"><dt>Parameters</dt><dd>
  308. <table class="params">
  309. <tr><td class="paramdir">[in]</td><td class="paramname">pIn</td><td>Pointer to Ref buffer </td></tr>
  310. <tr><td class="paramdir">[in]</td><td class="paramname">pOut</td><td>Pointer to Test buffer </td></tr>
  311. <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of samples in the buffer </td></tr>
  312. </table>
  313. </dd>
  314. </dl>
  315. <dl class="section return"><dt>Returns</dt><dd>maximum difference </dd></dl>
  316. </div>
  317. </div>
  318. <a class="anchor" id="a32f9f3d19e53161382c5bd39e3df50fb"></a>
  319. <div class="memitem">
  320. <div class="memproto">
  321. <table class="memname">
  322. <tr>
  323. <td class="memname">uint32_t arm_compare_fixed_q31 </td>
  324. <td>(</td>
  325. <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
  326. <td class="paramname"><em>pIn</em>, </td>
  327. </tr>
  328. <tr>
  329. <td class="paramkey"></td>
  330. <td></td>
  331. <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
  332. <td class="paramname"><em>pOut</em>, </td>
  333. </tr>
  334. <tr>
  335. <td class="paramkey"></td>
  336. <td></td>
  337. <td class="paramtype">uint32_t&#160;</td>
  338. <td class="paramname"><em>numSamples</em>&#160;</td>
  339. </tr>
  340. <tr>
  341. <td></td>
  342. <td>)</td>
  343. <td></td><td></td>
  344. </tr>
  345. </table>
  346. </div><div class="memdoc">
  347. <dl class="params"><dt>Parameters</dt><dd>
  348. <table class="params">
  349. <tr><td class="paramdir">[in]</td><td class="paramname">pIn</td><td>Pointer to Ref buffer </td></tr>
  350. <tr><td class="paramdir">[in]</td><td class="paramname">pOut</td><td>Pointer to Test buffer </td></tr>
  351. <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of samples in the buffer </td></tr>
  352. </table>
  353. </dd>
  354. </dl>
  355. <dl class="section return"><dt>Returns</dt><dd>maximum difference </dd></dl>
  356. </div>
  357. </div>
  358. <a class="anchor" id="a23f94b0fbfed6d620f38e26bc64cf2f8"></a>
  359. <div class="memitem">
  360. <div class="memproto">
  361. <table class="memname">
  362. <tr>
  363. <td class="memname">void arm_float_to_q12_20 </td>
  364. <td>(</td>
  365. <td class="paramtype">float *&#160;</td>
  366. <td class="paramname"><em>pIn</em>, </td>
  367. </tr>
  368. <tr>
  369. <td class="paramkey"></td>
  370. <td></td>
  371. <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
  372. <td class="paramname"><em>pOut</em>, </td>
  373. </tr>
  374. <tr>
  375. <td class="paramkey"></td>
  376. <td></td>
  377. <td class="paramtype">uint32_t&#160;</td>
  378. <td class="paramname"><em>numSamples</em>&#160;</td>
  379. </tr>
  380. <tr>
  381. <td></td>
  382. <td>)</td>
  383. <td></td><td></td>
  384. </tr>
  385. </table>
  386. </div><div class="memdoc">
  387. <dl class="params"><dt>Parameters</dt><dd>
  388. <table class="params">
  389. <tr><td class="paramdir">[in]</td><td class="paramname">pIn</td><td>pointer to input buffer </td></tr>
  390. <tr><td class="paramdir">[out]</td><td class="paramname">pOut</td><td>pointer to outputbuffer </td></tr>
  391. <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of samples in the input buffer </td></tr>
  392. </table>
  393. </dd>
  394. </dl>
  395. <dl class="section return"><dt>Returns</dt><dd>none The function converts floating point values to fixed point(q12.20) values </dd></dl>
  396. </div>
  397. </div>
  398. <a class="anchor" id="a23cdb5202efd9233f4e92b5f22287eac"></a>
  399. <div class="memitem">
  400. <div class="memproto">
  401. <table class="memname">
  402. <tr>
  403. <td class="memname">void arm_float_to_q14 </td>
  404. <td>(</td>
  405. <td class="paramtype">float *&#160;</td>
  406. <td class="paramname"><em>pIn</em>, </td>
  407. </tr>
  408. <tr>
  409. <td class="paramkey"></td>
  410. <td></td>
  411. <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
  412. <td class="paramname"><em>pOut</em>, </td>
  413. </tr>
  414. <tr>
  415. <td class="paramkey"></td>
  416. <td></td>
  417. <td class="paramtype">uint32_t&#160;</td>
  418. <td class="paramname"><em>numSamples</em>&#160;</td>
  419. </tr>
  420. <tr>
  421. <td></td>
  422. <td>)</td>
  423. <td></td><td></td>
  424. </tr>
  425. </table>
  426. </div><div class="memdoc">
  427. <dl class="params"><dt>Parameters</dt><dd>
  428. <table class="params">
  429. <tr><td class="paramdir">[in]</td><td class="paramname">pIn</td><td>pointer to input buffer </td></tr>
  430. <tr><td class="paramdir">[out]</td><td class="paramname">pOut</td><td>pointer to output buffer </td></tr>
  431. <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of samples in the buffer </td></tr>
  432. </table>
  433. </dd>
  434. </dl>
  435. <dl class="section return"><dt>Returns</dt><dd>none The function converts floating point values to fixed point values </dd></dl>
  436. </div>
  437. </div>
  438. <a class="anchor" id="aa1049b3adb14331612bb762237391625"></a>
  439. <div class="memitem">
  440. <div class="memproto">
  441. <table class="memname">
  442. <tr>
  443. <td class="memname">void arm_float_to_q28 </td>
  444. <td>(</td>
  445. <td class="paramtype">float *&#160;</td>
  446. <td class="paramname"><em>pIn</em>, </td>
  447. </tr>
  448. <tr>
  449. <td class="paramkey"></td>
  450. <td></td>
  451. <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
  452. <td class="paramname"><em>pOut</em>, </td>
  453. </tr>
  454. <tr>
  455. <td class="paramkey"></td>
  456. <td></td>
  457. <td class="paramtype">uint32_t&#160;</td>
  458. <td class="paramname"><em>numSamples</em>&#160;</td>
  459. </tr>
  460. <tr>
  461. <td></td>
  462. <td>)</td>
  463. <td></td><td></td>
  464. </tr>
  465. </table>
  466. </div><div class="memdoc">
  467. <dl class="params"><dt>Parameters</dt><dd>
  468. <table class="params">
  469. <tr><td class="paramdir">[in]</td><td class="paramname">pIn</td><td>pointer to input buffer </td></tr>
  470. <tr><td class="paramdir">[out]</td><td class="paramname">pOut</td><td>pointer to output buffer </td></tr>
  471. <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of samples in the buffer </td></tr>
  472. </table>
  473. </dd>
  474. </dl>
  475. <dl class="section return"><dt>Returns</dt><dd>none The function converts floating point values to fixed point values </dd></dl>
  476. </div>
  477. </div>
  478. <a class="anchor" id="a098c587b93469a7a6bcc521d42fdf6f9"></a>
  479. <div class="memitem">
  480. <div class="memproto">
  481. <table class="memname">
  482. <tr>
  483. <td class="memname">void arm_float_to_q29 </td>
  484. <td>(</td>
  485. <td class="paramtype">float *&#160;</td>
  486. <td class="paramname"><em>pIn</em>, </td>
  487. </tr>
  488. <tr>
  489. <td class="paramkey"></td>
  490. <td></td>
  491. <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
  492. <td class="paramname"><em>pOut</em>, </td>
  493. </tr>
  494. <tr>
  495. <td class="paramkey"></td>
  496. <td></td>
  497. <td class="paramtype">uint32_t&#160;</td>
  498. <td class="paramname"><em>numSamples</em>&#160;</td>
  499. </tr>
  500. <tr>
  501. <td></td>
  502. <td>)</td>
  503. <td></td><td></td>
  504. </tr>
  505. </table>
  506. </div><div class="memdoc">
  507. <dl class="params"><dt>Parameters</dt><dd>
  508. <table class="params">
  509. <tr><td class="paramdir">[in]</td><td class="paramname">pIn</td><td>pointer to input buffer </td></tr>
  510. <tr><td class="paramdir">[out]</td><td class="paramname">pOut</td><td>pointer to output buffer </td></tr>
  511. <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of samples in the buffer </td></tr>
  512. </table>
  513. </dd>
  514. </dl>
  515. <dl class="section return"><dt>Returns</dt><dd>none The function converts floating point values to fixed point values </dd></dl>
  516. </div>
  517. </div>
  518. <a class="anchor" id="a16764fdbc174a79f04b07032cf902079"></a>
  519. <div class="memitem">
  520. <div class="memproto">
  521. <table class="memname">
  522. <tr>
  523. <td class="memname">void arm_float_to_q30 </td>
  524. <td>(</td>
  525. <td class="paramtype">float *&#160;</td>
  526. <td class="paramname"><em>pIn</em>, </td>
  527. </tr>
  528. <tr>
  529. <td class="paramkey"></td>
  530. <td></td>
  531. <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
  532. <td class="paramname"><em>pOut</em>, </td>
  533. </tr>
  534. <tr>
  535. <td class="paramkey"></td>
  536. <td></td>
  537. <td class="paramtype">uint32_t&#160;</td>
  538. <td class="paramname"><em>numSamples</em>&#160;</td>
  539. </tr>
  540. <tr>
  541. <td></td>
  542. <td>)</td>
  543. <td></td><td></td>
  544. </tr>
  545. </table>
  546. </div><div class="memdoc">
  547. <dl class="params"><dt>Parameters</dt><dd>
  548. <table class="params">
  549. <tr><td class="paramdir">[in]</td><td class="paramname">pIn</td><td>pointer to input buffer </td></tr>
  550. <tr><td class="paramdir">[out]</td><td class="paramname">pOut</td><td>pointer to output buffer </td></tr>
  551. <tr><td class="paramdir">[in]</td><td class="paramname">numSamples</td><td>number of samples in the buffer </td></tr>
  552. </table>
  553. </dd>
  554. </dl>
  555. <dl class="section return"><dt>Returns</dt><dd>none The function converts floating point values to fixed point values </dd></dl>
  556. </div>
  557. </div>
  558. <a class="anchor" id="ac8209be1b8081e833c3ec2e85ad2255b"></a>
  559. <div class="memitem">
  560. <div class="memproto">
  561. <table class="memname">
  562. <tr>
  563. <td class="memname">void arm_provide_guard_bits_q15 </td>
  564. <td>(</td>
  565. <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
  566. <td class="paramname"><em>input_buf</em>, </td>
  567. </tr>
  568. <tr>
  569. <td class="paramkey"></td>
  570. <td></td>
  571. <td class="paramtype">uint32_t&#160;</td>
  572. <td class="paramname"><em>blockSize</em>, </td>
  573. </tr>
  574. <tr>
  575. <td class="paramkey"></td>
  576. <td></td>
  577. <td class="paramtype">uint32_t&#160;</td>
  578. <td class="paramname"><em>guard_bits</em>&#160;</td>
  579. </tr>
  580. <tr>
  581. <td></td>
  582. <td>)</td>
  583. <td></td><td></td>
  584. </tr>
  585. </table>
  586. </div><div class="memdoc">
  587. <dl class="params"><dt>Parameters</dt><dd>
  588. <table class="params">
  589. <tr><td class="paramdir">[in,out]</td><td class="paramname">input_buf</td><td>Pointer to input buffer </td></tr>
  590. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>block Size </td></tr>
  591. <tr><td class="paramdir">[in]</td><td class="paramname">guard_bits</td><td>guard bits </td></tr>
  592. </table>
  593. </dd>
  594. </dl>
  595. <dl class="section return"><dt>Returns</dt><dd>none The function Provides the guard bits for the buffer to avoid overflow </dd></dl>
  596. </div>
  597. </div>
  598. <a class="anchor" id="aead320f821f927000386d9d7d5ad6d27"></a>
  599. <div class="memitem">
  600. <div class="memproto">
  601. <table class="memname">
  602. <tr>
  603. <td class="memname">void arm_provide_guard_bits_q31 </td>
  604. <td>(</td>
  605. <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
  606. <td class="paramname"><em>input_buf</em>, </td>
  607. </tr>
  608. <tr>
  609. <td class="paramkey"></td>
  610. <td></td>
  611. <td class="paramtype">uint32_t&#160;</td>
  612. <td class="paramname"><em>blockSize</em>, </td>
  613. </tr>
  614. <tr>
  615. <td class="paramkey"></td>
  616. <td></td>
  617. <td class="paramtype">uint32_t&#160;</td>
  618. <td class="paramname"><em>guard_bits</em>&#160;</td>
  619. </tr>
  620. <tr>
  621. <td></td>
  622. <td>)</td>
  623. <td></td><td></td>
  624. </tr>
  625. </table>
  626. </div><div class="memdoc">
  627. <dl class="params"><dt>Parameters</dt><dd>
  628. <table class="params">
  629. <tr><td class="paramdir">[in,out]</td><td class="paramname">input_buf</td><td>Pointer to input buffer </td></tr>
  630. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>block Size </td></tr>
  631. <tr><td class="paramdir">[in]</td><td class="paramname">guard_bits</td><td>guard bits </td></tr>
  632. </table>
  633. </dd>
  634. </dl>
  635. <dl class="section return"><dt>Returns</dt><dd>none The function Provides the guard bits for the buffer to avoid overflow </dd></dl>
  636. </div>
  637. </div>
  638. <a class="anchor" id="aeea2952e70a1040a6efa555564bbeeab"></a>
  639. <div class="memitem">
  640. <div class="memproto">
  641. <table class="memname">
  642. <tr>
  643. <td class="memname">float arm_snr_f32 </td>
  644. <td>(</td>
  645. <td class="paramtype">float *&#160;</td>
  646. <td class="paramname"><em>pRef</em>, </td>
  647. </tr>
  648. <tr>
  649. <td class="paramkey"></td>
  650. <td></td>
  651. <td class="paramtype">float *&#160;</td>
  652. <td class="paramname"><em>pTest</em>, </td>
  653. </tr>
  654. <tr>
  655. <td class="paramkey"></td>
  656. <td></td>
  657. <td class="paramtype">uint32_t&#160;</td>
  658. <td class="paramname"><em>buffSize</em>&#160;</td>
  659. </tr>
  660. <tr>
  661. <td></td>
  662. <td>)</td>
  663. <td></td><td></td>
  664. </tr>
  665. </table>
  666. </div><div class="memdoc">
  667. <dl class="params"><dt>Parameters</dt><dd>
  668. <table class="params">
  669. <tr><td class="paramdir">[in]</td><td class="paramname">pRef</td><td>Pointer to the reference buffer </td></tr>
  670. <tr><td class="paramdir">[in]</td><td class="paramname">pTest</td><td>Pointer to the test buffer </td></tr>
  671. <tr><td class="paramdir">[in]</td><td class="paramname">buffSize</td><td>total number of samples </td></tr>
  672. </table>
  673. </dd>
  674. </dl>
  675. <dl class="section return"><dt>Returns</dt><dd>SNR The function Caluclates signal to noise ratio for the reference output and test output </dd></dl>
  676. </div>
  677. </div>
  678. </div><!-- contents -->
  679. </div><!-- doc-content -->
  680. <!-- start footer part -->
  681. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  682. <ul>
  683. <li class="navelem"><a class="el" href="dir_650d82db24a6311fa7658fced19ae149.html">DSP</a></li><li class="navelem"><a class="el" href="dir_abd1d8a41d439a254a6d729f0d888b04.html">Examples</a></li><li class="navelem"><a class="el" href="dir_dd8be1de2cb2fdb097bade8f148f6c3f.html">ARM</a></li><li class="navelem"><a class="el" href="dir_d47fe067fda502b2aac97b7803894821.html">arm_fir_example</a></li><li class="navelem"><a class="el" href="arm__fir__example_2math__helper_8h.html">math_helper.h</a></li>
  684. <li class="footer">Generated on Thu Apr 9 2020 15:49:22 for CMSIS-DSP Version 1.8.0 by Arm Ltd. All rights reserved.
  685. <!--
  686. <a href="http://www.doxygen.org/index.html">
  687. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  688. -->
  689. </li>
  690. </ul>
  691. </div>
  692. </body>
  693. </html>