git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/Documentation/DSP_Lib/html/group__shift.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: Vector Shift</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>Vector Shift<br/>
  48 <small>
  49 [<a class="el" href="group__group_math.html">Basic Math Functions</a>]</small>
  50 </h1>  </div>
  51 </div>
  52 <div class="contents">
  53 <table class="memberdecls">
  54 <tr><td colspan="2"><h2><a name="func-members"></a>
  55 Functions</h2></td></tr>
  56 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__shift.html#ga387dd8b7b87377378280978f16cdb13d">arm_shift_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, int8_t shiftBits, <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__shift.html#gaa1757e53279780107acc92cf100adb61">arm_shift_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrc, int8_t shiftBits, <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__shift.html#ga47295d08a685f7de700a48dafb4db6fb">arm_shift_q7</a> (<a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrc, int8_t shiftBits, <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/><a name="_details"></a><h2>Detailed Description</h2>
  61 <p>Shifts the elements of a fixed-point vector by a specified number of bits. There are separate functions for Q7, Q15, and Q31 data types. The underlying algorithm used is:</p>
  62 <pre>
  63      pDst[n] = pSrc[n] &lt;&lt; shift,   0 &lt;= n &lt; blockSize.
  64  </pre><p>If <code>shift</code> is positive then the elements of the vector are shifted to the left. If <code>shift</code> is negative then the elements of the vector are shifted to the right. </p>
  65 <hr/><h2>Function Documentation</h2>
  66 <a class="anchor" id="ga387dd8b7b87377378280978f16cdb13d"></a><!-- doxytag: member="arm_shift_q31.c::arm_shift_q31" ref="ga387dd8b7b87377378280978f16cdb13d" args="(q31_t *pSrc, int8_t shiftBits, q31_t *pDst, uint32_t blockSize)" -->
  67 <div class="memitem">
  68 <div class="memproto">
  69       <table class="memname">
  70         <tr>
  71           <td class="memname">void arm_shift_q31 </td>
  72           <td>(</td>
  73           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
  74           <td class="paramname"> <em>pSrc</em>, </td>
  75         </tr>
  76         <tr>
  77           <td class="paramkey"></td>
  78           <td></td>
  79           <td class="paramtype">int8_t&#160;</td>
  80           <td class="paramname"> <em>shiftBits</em>, </td>
  81         </tr>
  82         <tr>
  83           <td class="paramkey"></td>
  84           <td></td>
  85           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
  86           <td class="paramname"> <em>pDst</em>, </td>
  87         </tr>
  88         <tr>
  89           <td class="paramkey"></td>
  90           <td></td>
  91           <td class="paramtype">uint32_t&#160;</td>
  92           <td class="paramname"> <em>blockSize</em>&#160;</td>
  93         </tr>
  94         <tr>
  95           <td></td>
  96           <td>)</td>
  97           <td></td><td></td>
  98         </tr>
  99       </table>
 100 </div>
 101 <div class="memdoc">
 102
 103 <p>Shifts the elements of a Q31 vector a specified number of bits. </p>
 104 <dl><dt><b>Parameters:</b></dt><dd>
 105   <table class="params">
 106     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input vector </td></tr>
 107     <tr><td class="paramdir">[in]</td><td class="paramname">shiftBits</td><td>number of bits to shift. A positive value shifts left; a negative value shifts right. </td></tr>
 108     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output vector </td></tr>
 109     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in the vector </td></tr>
 110   </table>
 111   </dd>
 112 </dl>
 113 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 114 <p><b>Scaling and Overflow Behavior:</b> </p>
 115 <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>
 116
 117 <p>Definition at line <a class="el" href="arm__shift__q31_8c_source.html#l00073">73</a> of file <a class="el" href="arm__shift__q31_8c_source.html">arm_shift_q31.c</a>.</p>
 118
 119 </div>
 120 </div>
 121 <a class="anchor" id="gaa1757e53279780107acc92cf100adb61"></a><!-- doxytag: member="arm_shift_q15.c::arm_shift_q15" ref="gaa1757e53279780107acc92cf100adb61" args="(q15_t *pSrc, int8_t shiftBits, q15_t *pDst, uint32_t blockSize)" -->
 122 <div class="memitem">
 123 <div class="memproto">
 124       <table class="memname">
 125         <tr>
 126           <td class="memname">void arm_shift_q15 </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>pSrc</em>, </td>
 130         </tr>
 131         <tr>
 132           <td class="paramkey"></td>
 133           <td></td>
 134           <td class="paramtype">int8_t&#160;</td>
 135           <td class="paramname"> <em>shiftBits</em>, </td>
 136         </tr>
 137         <tr>
 138           <td class="paramkey"></td>
 139           <td></td>
 140           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
 141           <td class="paramname"> <em>pDst</em>, </td>
 142         </tr>
 143         <tr>
 144           <td class="paramkey"></td>
 145           <td></td>
 146           <td class="paramtype">uint32_t&#160;</td>
 147           <td class="paramname"> <em>blockSize</em>&#160;</td>
 148         </tr>
 149         <tr>
 150           <td></td>
 151           <td>)</td>
 152           <td></td><td></td>
 153         </tr>
 154       </table>
 155 </div>
 156 <div class="memdoc">
 157
 158 <p>Shifts the elements of a Q15 vector a specified number of bits. </p>
 159 <dl><dt><b>Parameters:</b></dt><dd>
 160   <table class="params">
 161     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input vector </td></tr>
 162     <tr><td class="paramdir">[in]</td><td class="paramname">shiftBits</td><td>number of bits to shift. A positive value shifts left; a negative value shifts right. </td></tr>
 163     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output vector </td></tr>
 164     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in the vector </td></tr>
 165   </table>
 166   </dd>
 167 </dl>
 168 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 169 <p><b>Scaling and Overflow Behavior:</b> </p>
 170 <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>
 171
 172 <p>Definition at line <a class="el" href="arm__shift__q15_8c_source.html#l00058">58</a> of file <a class="el" href="arm__shift__q15_8c_source.html">arm_shift_q15.c</a>.</p>
 173
 174 </div>
 175 </div>
 176 <a class="anchor" id="ga47295d08a685f7de700a48dafb4db6fb"></a><!-- doxytag: member="arm_shift_q7.c::arm_shift_q7" ref="ga47295d08a685f7de700a48dafb4db6fb" args="(q7_t *pSrc, int8_t shiftBits, q7_t *pDst, uint32_t blockSize)" -->
 177 <div class="memitem">
 178 <div class="memproto">
 179       <table class="memname">
 180         <tr>
 181           <td class="memname">void arm_shift_q7 </td>
 182           <td>(</td>
 183           <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *&#160;</td>
 184           <td class="paramname"> <em>pSrc</em>, </td>
 185         </tr>
 186         <tr>
 187           <td class="paramkey"></td>
 188           <td></td>
 189           <td class="paramtype">int8_t&#160;</td>
 190           <td class="paramname"> <em>shiftBits</em>, </td>
 191         </tr>
 192         <tr>
 193           <td class="paramkey"></td>
 194           <td></td>
 195           <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *&#160;</td>
 196           <td class="paramname"> <em>pDst</em>, </td>
 197         </tr>
 198         <tr>
 199           <td class="paramkey"></td>
 200           <td></td>
 201           <td class="paramtype">uint32_t&#160;</td>
 202           <td class="paramname"> <em>blockSize</em>&#160;</td>
 203         </tr>
 204         <tr>
 205           <td></td>
 206           <td>)</td>
 207           <td></td><td></td>
 208         </tr>
 209       </table>
 210 </div>
 211 <div class="memdoc">
 212
 213 <p>Shifts the elements of a Q7 vector a specified number of bits. </p>
 214 <dl><dt><b>Parameters:</b></dt><dd>
 215   <table class="params">
 216     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input vector </td></tr>
 217     <tr><td class="paramdir">[in]</td><td class="paramname">shiftBits</td><td>number of bits to shift. A positive value shifts left; a negative value shifts right. </td></tr>
 218     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output vector </td></tr>
 219     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in the vector </td></tr>
 220   </table>
 221   </dd>
 222 </dl>
 223 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 224 <p><b>Scaling and Overflow Behavior:</b> </p>
 225 <dl class="user"><dt><b></b></dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q7 range [0x8 0x7F] will be saturated. </dd></dl>
 226
 227 <p>Definition at line <a class="el" href="arm__shift__q7_8c_source.html#l00059">59</a> of file <a class="el" href="arm__shift__q7_8c_source.html">arm_shift_q7.c</a>.</p>
 228
 229 </div>
 230 </div>
 231 </div>
 232 <!--- window showing the filter options -->
 233 <div id="MSearchSelectWindow"
 234      onmouseover="return searchBox.OnSearchSelectShow()"
 235      onmouseout="return searchBox.OnSearchSelectHide()"
 236      onkeydown="return searchBox.OnSearchSelectKey(event)">
 237 <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>
 238
 239 <!-- iframe showing the search results (closed by default) -->
 240 <div id="MSearchResultsWindow">
 241 <iframe src="" frameborder="0"
 242         name="MSearchResults" id="MSearchResults">
 243 </iframe>
 244 </div>
 245
 246 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:20 for CMSIS DSP Software Library by&#160;
 247 <a href="http://www.doxygen.org/index.html">
 248 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 249 </body>
 250 </html>