git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/Documentation/DSP_Lib/html/group__float__to__x.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: Convert 32-bit floating point value</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>Convert 32-bit floating point value<br/>
  48 <small>
  49 [<a class="el" href="group__group_support.html">Support 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__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>
  57 <tr><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>
  58 <tr><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>
  59 </table>
  60 <hr/><h2>Function Documentation</h2>
  61 <a class="anchor" id="ga177704107f94564e9abe4daaa36f4554"></a><!-- doxytag: member="arm_float_to_q31.c::arm_float_to_q31" ref="ga177704107f94564e9abe4daaa36f4554" args="(float32_t *pSrc, q31_t *pDst, uint32_t blockSize)" -->
  62 <div class="memitem">
  63 <div class="memproto">
  64       <table class="memname">
  65         <tr>
  66           <td class="memname">void arm_float_to_q31 </td>
  67           <td>(</td>
  68           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  69           <td class="paramname"> <em>pSrc</em>, </td>
  70         </tr>
  71         <tr>
  72           <td class="paramkey"></td>
  73           <td></td>
  74           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
  75           <td class="paramname"> <em>pDst</em>, </td>
  76         </tr>
  77         <tr>
  78           <td class="paramkey"></td>
  79           <td></td>
  80           <td class="paramtype">uint32_t&#160;</td>
  81           <td class="paramname"> <em>blockSize</em>&#160;</td>
  82         </tr>
  83         <tr>
  84           <td></td>
  85           <td>)</td>
  86           <td></td><td></td>
  87         </tr>
  88       </table>
  89 </div>
  90 <div class="memdoc">
  91
  92 <p>Converts the elements of the floating-point vector to Q31 vector. </p>
  93 <dl><dt><b>Parameters:</b></dt><dd>
  94   <table class="params">
  95     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the floating-point input vector </td></tr>
  96     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the Q31 output vector </td></tr>
  97     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr>
  98   </table>
  99   </dd>
 100 </dl>
 101 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 102 <dl class="user"><dt><b>Description: </b></dt><dd></dd></dl>
 103 <dl class="user"><dt><b></b></dt><dd>The equation used for the conversion process is:</dd></dl>
 104 <pre>
 105         pDst[n] = (q31_t)(pSrc[n] * 2147483648);   0 &lt;= n &lt; blockSize.
 106  </pre><p> <b>Scaling and Overflow Behavior:</b> </p>
 107 <dl class="user"><dt><b></b></dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q31 range[0x80000000 0x7FFFFFFF] will be saturated.</dd></dl>
 108 <dl class="note"><dt><b>Note:</b></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>
 109 <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>
 110 </dl>
 111 <p>Definition at line <a class="el" href="arm__float__to__q31_8c_source.html#l00069">69</a> of file <a class="el" href="arm__float__to__q31_8c_source.html">arm_float_to_q31.c</a>.</p>
 112
 113 </div>
 114 </div>
 115 <a class="anchor" id="ga215456e35a18db86882e1d3f0d24e1f2"></a><!-- doxytag: member="arm_float_to_q15.c::arm_float_to_q15" ref="ga215456e35a18db86882e1d3f0d24e1f2" args="(float32_t *pSrc, q15_t *pDst, uint32_t blockSize)" -->
 116 <div class="memitem">
 117 <div class="memproto">
 118       <table class="memname">
 119         <tr>
 120           <td class="memname">void arm_float_to_q15 </td>
 121           <td>(</td>
 122           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
 123           <td class="paramname"> <em>pSrc</em>, </td>
 124         </tr>
 125         <tr>
 126           <td class="paramkey"></td>
 127           <td></td>
 128           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
 129           <td class="paramname"> <em>pDst</em>, </td>
 130         </tr>
 131         <tr>
 132           <td class="paramkey"></td>
 133           <td></td>
 134           <td class="paramtype">uint32_t&#160;</td>
 135           <td class="paramname"> <em>blockSize</em>&#160;</td>
 136         </tr>
 137         <tr>
 138           <td></td>
 139           <td>)</td>
 140           <td></td><td></td>
 141         </tr>
 142       </table>
 143 </div>
 144 <div class="memdoc">
 145
 146 <p>Converts the elements of the floating-point vector to Q15 vector. </p>
 147 <dl><dt><b>Parameters:</b></dt><dd>
 148   <table class="params">
 149     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the floating-point input vector </td></tr>
 150     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the Q15 output vector </td></tr>
 151     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr>
 152   </table>
 153   </dd>
 154 </dl>
 155 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 156 <dl class="user"><dt><b>Description: </b></dt><dd></dd></dl>
 157 <dl class="user"><dt><b></b></dt><dd>The equation used for the conversion process is: <pre>
 158         pDst[n] = (q15_t)(pSrc[n] * 32768);   0 &lt;= n &lt; blockSize.
 159  </pre> </dd></dl>
 160 <dl class="user"><dt><b>Scaling and Overflow Behavior: </b></dt><dd></dd></dl>
 161 <dl class="user"><dt><b></b></dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q15 range [0x8000 0x7FFF] will be saturated. </dd></dl>
 162 <dl class="note"><dt><b>Note:</b></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>
 163
 164 <p>Definition at line <a class="el" href="arm__float__to__q15_8c_source.html#l00065">65</a> of file <a class="el" href="arm__float__to__q15_8c_source.html">arm_float_to_q15.c</a>.</p>
 165
 166 </div>
 167 </div>
 168 <a class="anchor" id="ga44a393818cdee8dce80f2d66add25411"></a><!-- doxytag: member="arm_float_to_q7.c::arm_float_to_q7" ref="ga44a393818cdee8dce80f2d66add25411" args="(float32_t *pSrc, q7_t *pDst, uint32_t blockSize)" -->
 169 <div class="memitem">
 170 <div class="memproto">
 171       <table class="memname">
 172         <tr>
 173           <td class="memname">void arm_float_to_q7 </td>
 174           <td>(</td>
 175           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
 176           <td class="paramname"> <em>pSrc</em>, </td>
 177         </tr>
 178         <tr>
 179           <td class="paramkey"></td>
 180           <td></td>
 181           <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *&#160;</td>
 182           <td class="paramname"> <em>pDst</em>, </td>
 183         </tr>
 184         <tr>
 185           <td class="paramkey"></td>
 186           <td></td>
 187           <td class="paramtype">uint32_t&#160;</td>
 188           <td class="paramname"> <em>blockSize</em>&#160;</td>
 189         </tr>
 190         <tr>
 191           <td></td>
 192           <td>)</td>
 193           <td></td><td></td>
 194         </tr>
 195       </table>
 196 </div>
 197 <div class="memdoc">
 198
 199 <p>Converts the elements of the floating-point vector to Q7 vector. </p>
 200 <dl><dt><b>Parameters:</b></dt><dd>
 201   <table class="params">
 202     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the floating-point input vector </td></tr>
 203     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the Q7 output vector </td></tr>
 204     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr>
 205   </table>
 206   </dd>
 207 </dl>
 208 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 209 <dl class="user"><dt><b>Description: </b></dt><dd></dd></dl>
 210 <dl class="user"><dt><b></b></dt><dd>The equation used for the conversion process is: <pre>
 211         pDst[n] = (q7_t)(pSrc[n] * 128);   0 &lt;= n &lt; blockSize.
 212  </pre> </dd></dl>
 213 <dl class="user"><dt><b>Scaling and Overflow Behavior: </b></dt><dd></dd></dl>
 214 <dl class="user"><dt><b></b></dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q7 range [0x80 0x7F] will be saturated. </dd></dl>
 215 <dl class="note"><dt><b>Note:</b></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>
 216
 217 <p>Definition at line <a class="el" href="arm__float__to__q7_8c_source.html#l00064">64</a> of file <a class="el" href="arm__float__to__q7_8c_source.html">arm_float_to_q7.c</a>.</p>
 218
 219 </div>
 220 </div>
 221 </div>
 222 <!--- window showing the filter options -->
 223 <div id="MSearchSelectWindow"
 224      onmouseover="return searchBox.OnSearchSelectShow()"
 225      onmouseout="return searchBox.OnSearchSelectHide()"
 226      onkeydown="return searchBox.OnSearchSelectKey(event)">
 227 <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>
 228
 229 <!-- iframe showing the search results (closed by default) -->
 230 <div id="MSearchResultsWindow">
 231 <iframe src="" frameborder="0"
 232         name="MSearchResults" id="MSearchResults">
 233 </iframe>
 234 </div>
 235
 236 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:21 for CMSIS DSP Software Library by&#160;
 237 <a href="http://www.doxygen.org/index.html">
 238 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 239 </body>
 240 </html>