group__float__to__x.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  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>CMSIS-DSP: Convert 32-bit floating point value</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="resize.js"></script>
  13. <script type="text/javascript" src="navtree.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(initResizable);
  16. </script>
  17. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18. <script type="text/javascript" src="search/search.js"></script>
  19. <script type="text/javascript">
  20. $(document).ready(function() { searchBox.OnSelectItem(0); });
  21. </script>
  22. <link href="stylsheetf" rel="stylesheet" type="text/css" />
  23. </head>
  24. <body>
  25. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  26. <div id="titlearea">
  27. <table cellspacing="0" cellpadding="0">
  28. <tbody>
  29. <tr style="height: 46px;">
  30. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  31. <td style="padding-left: 0.5em;">
  32. <div id="projectname">CMSIS-DSP
  33. &#160;<span id="projectnumber">Version 1.4.4</span>
  34. </div>
  35. <div id="projectbrief">CMSIS DSP Software Library</div>
  36. </td>
  37. </tr>
  38. </tbody>
  39. </table>
  40. </div>
  41. <!-- end header part -->
  42. <div id="CMSISnav" class="tabs1">
  43. <ul class="tablist">
  44. <li><a href="../../General/html/index.html"><span>CMSIS</span></a></li>
  45. <li><a href="../../Core/html/index.html"><span>CORE</span></a></li>
  46. <li><a href="../../Driver/html/index.html"><span>Driver</span></a></li>
  47. <li class="current"><a href="../../DSP/html/index.html"><span>DSP</span></a></li>
  48. <li><a href="../../RTOS/html/index.html"><span>RTOS API</span></a></li>
  49. <li><a href="../../Pack/html/index.html"><span>Pack</span></a></li>
  50. <li><a href="../../SVD/html/index.html"><span>SVD</span></a></li>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.2 -->
  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__float__to__x.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>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>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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">Convert 32-bit floating point value</div> </div>
  112. <div class="ingroups"><a class="el" href="group__group_support.html">Support Functions</a></div></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:ga215456e35a18db86882e1d3f0d24e1f2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__float__to__x.html#ga215456e35a18db86882e1d3f0d24e1f2">arm_float_to_q15</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrc, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
  118. <tr class="memdesc:ga215456e35a18db86882e1d3f0d24e1f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the elements of the floating-point vector to Q15 vector. <a href="#ga215456e35a18db86882e1d3f0d24e1f2"></a><br/></td></tr>
  119. <tr class="separator:ga215456e35a18db86882e1d3f0d24e1f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:ga177704107f94564e9abe4daaa36f4554"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__float__to__x.html#ga177704107f94564e9abe4daaa36f4554">arm_float_to_q31</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrc, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
  121. <tr class="memdesc:ga177704107f94564e9abe4daaa36f4554"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the elements of the floating-point vector to Q31 vector. <a href="#ga177704107f94564e9abe4daaa36f4554"></a><br/></td></tr>
  122. <tr class="separator:ga177704107f94564e9abe4daaa36f4554"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:ga44a393818cdee8dce80f2d66add25411"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__float__to__x.html#ga44a393818cdee8dce80f2d66add25411">arm_float_to_q7</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrc, <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
  124. <tr class="memdesc:ga44a393818cdee8dce80f2d66add25411"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the elements of the floating-point vector to Q7 vector. <a href="#ga44a393818cdee8dce80f2d66add25411"></a><br/></td></tr>
  125. <tr class="separator:ga44a393818cdee8dce80f2d66add25411"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table>
  127. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  128. <h2 class="groupheader">Function Documentation</h2>
  129. <a class="anchor" id="ga215456e35a18db86882e1d3f0d24e1f2"></a>
  130. <div class="memitem">
  131. <div class="memproto">
  132. <table class="memname">
  133. <tr>
  134. <td class="memname">void arm_float_to_q15 </td>
  135. <td>(</td>
  136. <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  137. <td class="paramname"><em>pSrc</em>, </td>
  138. </tr>
  139. <tr>
  140. <td class="paramkey"></td>
  141. <td></td>
  142. <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
  143. <td class="paramname"><em>pDst</em>, </td>
  144. </tr>
  145. <tr>
  146. <td class="paramkey"></td>
  147. <td></td>
  148. <td class="paramtype">uint32_t&#160;</td>
  149. <td class="paramname"><em>blockSize</em>&#160;</td>
  150. </tr>
  151. <tr>
  152. <td></td>
  153. <td>)</td>
  154. <td></td><td></td>
  155. </tr>
  156. </table>
  157. </div><div class="memdoc">
  158. <dl class="params"><dt>Parameters</dt><dd>
  159. <table class="params">
  160. <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the floating-point input vector </td></tr>
  161. <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the Q15 output vector </td></tr>
  162. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr>
  163. </table>
  164. </dd>
  165. </dl>
  166. <dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
  167. <dl class="section user"><dt>Description: </dt><dd></dd></dl>
  168. <dl class="section user"><dt></dt><dd>The equation used for the conversion process is: <pre>
  169. pDst[n] = (q15_t)(pSrc[n] * 32768); 0 &lt;= n &lt; blockSize.
  170. </pre> </dd></dl>
  171. <dl class="section user"><dt>Scaling and Overflow Behavior: </dt><dd></dd></dl>
  172. <dl class="section user"><dt></dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q15 range [0x8000 0x7FFF] will be saturated. </dd></dl>
  173. <dl class="section note"><dt>Note</dt><dd>In order to apply rounding, the library should be rebuilt with the ROUNDING macro defined in the preprocessor section of project options. </dd></dl>
  174. <p>References <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>.</p>
  175. </div>
  176. </div>
  177. <a class="anchor" id="ga177704107f94564e9abe4daaa36f4554"></a>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="memname">
  181. <tr>
  182. <td class="memname">void arm_float_to_q31 </td>
  183. <td>(</td>
  184. <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  185. <td class="paramname"><em>pSrc</em>, </td>
  186. </tr>
  187. <tr>
  188. <td class="paramkey"></td>
  189. <td></td>
  190. <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
  191. <td class="paramname"><em>pDst</em>, </td>
  192. </tr>
  193. <tr>
  194. <td class="paramkey"></td>
  195. <td></td>
  196. <td class="paramtype">uint32_t&#160;</td>
  197. <td class="paramname"><em>blockSize</em>&#160;</td>
  198. </tr>
  199. <tr>
  200. <td></td>
  201. <td>)</td>
  202. <td></td><td></td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. <dl class="params"><dt>Parameters</dt><dd>
  207. <table class="params">
  208. <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the floating-point input vector </td></tr>
  209. <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the Q31 output vector </td></tr>
  210. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr>
  211. </table>
  212. </dd>
  213. </dl>
  214. <dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
  215. <dl class="section user"><dt>Description: </dt><dd></dd></dl>
  216. <dl class="section user"><dt></dt><dd>The equation used for the conversion process is:</dd></dl>
  217. <pre>
  218. pDst[n] = (q31_t)(pSrc[n] * 2147483648); 0 &lt;= n &lt; blockSize.
  219. </pre><p> <b>Scaling and Overflow Behavior:</b> </p>
  220. <dl class="section user"><dt></dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q31 range[0x80000000 0x7FFFFFFF] will be saturated.</dd></dl>
  221. <dl class="section note"><dt>Note</dt><dd>In order to apply rounding, the library should be rebuilt with the ROUNDING macro defined in the preprocessor section of project options. </dd></dl>
  222. <dl><dt><b>Examples: </b></dt><dd><a class="el" href="arm_graphic_equalizer_example_q31_8c-example.html#a23">arm_graphic_equalizer_example_q31.c</a>.</dd>
  223. </dl>
  224. <p>References <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, and <a class="el" href="arm__math_8h.html#ad7373e53d3c2e1adfeafc8c2e9720b5c">clip_q63_to_q31()</a>.</p>
  225. <p>Referenced by <a class="el" href="arm__graphic__equalizer__example__q31_8c.html#a52d2cba30e6946c95578be946ac12a65">main()</a>.</p>
  226. </div>
  227. </div>
  228. <a class="anchor" id="ga44a393818cdee8dce80f2d66add25411"></a>
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">void arm_float_to_q7 </td>
  234. <td>(</td>
  235. <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  236. <td class="paramname"><em>pSrc</em>, </td>
  237. </tr>
  238. <tr>
  239. <td class="paramkey"></td>
  240. <td></td>
  241. <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *&#160;</td>
  242. <td class="paramname"><em>pDst</em>, </td>
  243. </tr>
  244. <tr>
  245. <td class="paramkey"></td>
  246. <td></td>
  247. <td class="paramtype">uint32_t&#160;</td>
  248. <td class="paramname"><em>blockSize</em>&#160;</td>
  249. </tr>
  250. <tr>
  251. <td></td>
  252. <td>)</td>
  253. <td></td><td></td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <dl class="params"><dt>Parameters</dt><dd>
  258. <table class="params">
  259. <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the floating-point input vector </td></tr>
  260. <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the Q7 output vector </td></tr>
  261. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr>
  262. </table>
  263. </dd>
  264. </dl>
  265. <dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
  266. <dl class="section user"><dt>Description: </dt><dd></dd></dl>
  267. <dl class="section user"><dt></dt><dd>The equation used for the conversion process is: <pre>
  268. pDst[n] = (q7_t)(pSrc[n] * 128); 0 &lt;= n &lt; blockSize.
  269. </pre> </dd></dl>
  270. <dl class="section user"><dt>Scaling and Overflow Behavior: </dt><dd></dd></dl>
  271. <dl class="section user"><dt></dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q7 range [0x80 0x7F] will be saturated. </dd></dl>
  272. <dl class="section note"><dt>Note</dt><dd>In order to apply rounding, the library should be rebuilt with the ROUNDING macro defined in the preprocessor section of project options. </dd></dl>
  273. <p>References <a class="el" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>.</p>
  274. </div>
  275. </div>
  276. </div><!-- contents -->
  277. </div><!-- doc-content -->
  278. <!-- start footer part -->
  279. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  280. <ul>
  281. <li class="footer">Generated on Tue Sep 23 2014 18:52:43 for CMSIS-DSP by ARM Ltd. All rights reserved.
  282. <!--
  283. <a href="http://www.doxygen.org/index.html">
  284. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.2
  285. -->
  286. </li>
  287. </ul>
  288. </div>
  289. </body>
  290. </html>