git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/Documentation/DSP_Lib/html/group__offset.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 Offset</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 Offset<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__offset.html#ga989dfae15235799d82f62ef9d356abb4">arm_offset_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrc, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> offset, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_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__offset.html#gac84ec42cbbebc5c197a87d0221819acf">arm_offset_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> offset, <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>
  58 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__offset.html#gab4c1d2391b599549e5a06fdfbc2747bf">arm_offset_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrc, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> offset, <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>
  59 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__offset.html#ga00bd9cc17c5bf905e76c91ad50886393">arm_offset_q7</a> (<a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrc, <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> offset, <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>
  60 </table>
  61 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  62 <p>Adds a constant offset to each element of a vector.</p>
  63 <pre>
  64      pDst[n] = pSrc[n] + offset,   0 &lt;= n &lt; blockSize.
  65  </pre><p>There are separate functions for floating-point, Q7, Q15, and Q31 data types. </p>
  66 <hr/><h2>Function Documentation</h2>
  67 <a class="anchor" id="ga989dfae15235799d82f62ef9d356abb4"></a><!-- doxytag: member="arm_offset_f32.c::arm_offset_f32" ref="ga989dfae15235799d82f62ef9d356abb4" args="(float32_t *pSrc, float32_t offset, float32_t *pDst, uint32_t blockSize)" -->
  68 <div class="memitem">
  69 <div class="memproto">
  70       <table class="memname">
  71         <tr>
  72           <td class="memname">void arm_offset_f32 </td>
  73           <td>(</td>
  74           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  75           <td class="paramname"> <em>pSrc</em>, </td>
  76         </tr>
  77         <tr>
  78           <td class="paramkey"></td>
  79           <td></td>
  80           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td>
  81           <td class="paramname"> <em>offset</em>, </td>
  82         </tr>
  83         <tr>
  84           <td class="paramkey"></td>
  85           <td></td>
  86           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  87           <td class="paramname"> <em>pDst</em>, </td>
  88         </tr>
  89         <tr>
  90           <td class="paramkey"></td>
  91           <td></td>
  92           <td class="paramtype">uint32_t&#160;</td>
  93           <td class="paramname"> <em>blockSize</em>&#160;</td>
  94         </tr>
  95         <tr>
  96           <td></td>
  97           <td>)</td>
  98           <td></td><td></td>
  99         </tr>
 100       </table>
 101 </div>
 102 <div class="memdoc">
 103
 104 <p>Adds a constant offset to a floating-point vector. </p>
 105 <dl><dt><b>Parameters:</b></dt><dd>
 106   <table class="params">
 107     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input vector </td></tr>
 108     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>is the offset to be added </td></tr>
 109     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output vector </td></tr>
 110     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in the vector </td></tr>
 111   </table>
 112   </dd>
 113 </dl>
 114 <dl class="return"><dt><b>Returns:</b></dt><dd>none. </dd></dl>
 115
 116 <p>Definition at line <a class="el" href="arm__offset__f32_8c_source.html#l00066">66</a> of file <a class="el" href="arm__offset__f32_8c_source.html">arm_offset_f32.c</a>.</p>
 117
 118 </div>
 119 </div>
 120 <a class="anchor" id="gac84ec42cbbebc5c197a87d0221819acf"></a><!-- doxytag: member="arm_offset_q31.c::arm_offset_q31" ref="gac84ec42cbbebc5c197a87d0221819acf" args="(q31_t *pSrc, q31_t offset, q31_t *pDst, uint32_t blockSize)" -->
 121 <div class="memitem">
 122 <div class="memproto">
 123       <table class="memname">
 124         <tr>
 125           <td class="memname">void arm_offset_q31 </td>
 126           <td>(</td>
 127           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
 128           <td class="paramname"> <em>pSrc</em>, </td>
 129         </tr>
 130         <tr>
 131           <td class="paramkey"></td>
 132           <td></td>
 133           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td>
 134           <td class="paramname"> <em>offset</em>, </td>
 135         </tr>
 136         <tr>
 137           <td class="paramkey"></td>
 138           <td></td>
 139           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
 140           <td class="paramname"> <em>pDst</em>, </td>
 141         </tr>
 142         <tr>
 143           <td class="paramkey"></td>
 144           <td></td>
 145           <td class="paramtype">uint32_t&#160;</td>
 146           <td class="paramname"> <em>blockSize</em>&#160;</td>
 147         </tr>
 148         <tr>
 149           <td></td>
 150           <td>)</td>
 151           <td></td><td></td>
 152         </tr>
 153       </table>
 154 </div>
 155 <div class="memdoc">
 156
 157 <p>Adds a constant offset to a Q31 vector. </p>
 158 <dl><dt><b>Parameters:</b></dt><dd>
 159   <table class="params">
 160     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input vector </td></tr>
 161     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>is the offset to be added </td></tr>
 162     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output vector </td></tr>
 163     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in the vector </td></tr>
 164   </table>
 165   </dd>
 166 </dl>
 167 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 168 <p><b>Scaling and Overflow Behavior:</b> </p>
 169 <dl class="user"><dt><b></b></dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q31 range [0x80000000 0x7FFFFFFF] are saturated. </dd></dl>
 170
 171 <p>Definition at line <a class="el" href="arm__offset__q31_8c_source.html#l00058">58</a> of file <a class="el" href="arm__offset__q31_8c_source.html">arm_offset_q31.c</a>.</p>
 172
 173 </div>
 174 </div>
 175 <a class="anchor" id="gab4c1d2391b599549e5a06fdfbc2747bf"></a><!-- doxytag: member="arm_offset_q15.c::arm_offset_q15" ref="gab4c1d2391b599549e5a06fdfbc2747bf" args="(q15_t *pSrc, q15_t offset, q15_t *pDst, uint32_t blockSize)" -->
 176 <div class="memitem">
 177 <div class="memproto">
 178       <table class="memname">
 179         <tr>
 180           <td class="memname">void arm_offset_q15 </td>
 181           <td>(</td>
 182           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
 183           <td class="paramname"> <em>pSrc</em>, </td>
 184         </tr>
 185         <tr>
 186           <td class="paramkey"></td>
 187           <td></td>
 188           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a>&#160;</td>
 189           <td class="paramname"> <em>offset</em>, </td>
 190         </tr>
 191         <tr>
 192           <td class="paramkey"></td>
 193           <td></td>
 194           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
 195           <td class="paramname"> <em>pDst</em>, </td>
 196         </tr>
 197         <tr>
 198           <td class="paramkey"></td>
 199           <td></td>
 200           <td class="paramtype">uint32_t&#160;</td>
 201           <td class="paramname"> <em>blockSize</em>&#160;</td>
 202         </tr>
 203         <tr>
 204           <td></td>
 205           <td>)</td>
 206           <td></td><td></td>
 207         </tr>
 208       </table>
 209 </div>
 210 <div class="memdoc">
 211
 212 <p>Adds a constant offset to a Q15 vector. </p>
 213 <dl><dt><b>Parameters:</b></dt><dd>
 214   <table class="params">
 215     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input vector </td></tr>
 216     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>is the offset to be added </td></tr>
 217     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output vector </td></tr>
 218     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in the vector </td></tr>
 219   </table>
 220   </dd>
 221 </dl>
 222 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 223 <p><b>Scaling and Overflow Behavior:</b> </p>
 224 <dl class="user"><dt><b></b></dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q15 range [0x8000 0x7FFF] are saturated. </dd></dl>
 225
 226 <p>Definition at line <a class="el" href="arm__offset__q15_8c_source.html#l00058">58</a> of file <a class="el" href="arm__offset__q15_8c_source.html">arm_offset_q15.c</a>.</p>
 227
 228 </div>
 229 </div>
 230 <a class="anchor" id="ga00bd9cc17c5bf905e76c91ad50886393"></a><!-- doxytag: member="arm_offset_q7.c::arm_offset_q7" ref="ga00bd9cc17c5bf905e76c91ad50886393" args="(q7_t *pSrc, q7_t offset, q7_t *pDst, uint32_t blockSize)" -->
 231 <div class="memitem">
 232 <div class="memproto">
 233       <table class="memname">
 234         <tr>
 235           <td class="memname">void arm_offset_q7 </td>
 236           <td>(</td>
 237           <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *&#160;</td>
 238           <td class="paramname"> <em>pSrc</em>, </td>
 239         </tr>
 240         <tr>
 241           <td class="paramkey"></td>
 242           <td></td>
 243           <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a>&#160;</td>
 244           <td class="paramname"> <em>offset</em>, </td>
 245         </tr>
 246         <tr>
 247           <td class="paramkey"></td>
 248           <td></td>
 249           <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *&#160;</td>
 250           <td class="paramname"> <em>pDst</em>, </td>
 251         </tr>
 252         <tr>
 253           <td class="paramkey"></td>
 254           <td></td>
 255           <td class="paramtype">uint32_t&#160;</td>
 256           <td class="paramname"> <em>blockSize</em>&#160;</td>
 257         </tr>
 258         <tr>
 259           <td></td>
 260           <td>)</td>
 261           <td></td><td></td>
 262         </tr>
 263       </table>
 264 </div>
 265 <div class="memdoc">
 266
 267 <p>Adds a constant offset to a Q7 vector. </p>
 268 <dl><dt><b>Parameters:</b></dt><dd>
 269   <table class="params">
 270     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input vector </td></tr>
 271     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>is the offset to be added </td></tr>
 272     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output vector </td></tr>
 273     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in the vector </td></tr>
 274   </table>
 275   </dd>
 276 </dl>
 277 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 278 <p><b>Scaling and Overflow Behavior:</b> </p>
 279 <dl class="user"><dt><b></b></dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q7 range [0x80 0x7F] are saturated. </dd></dl>
 280
 281 <p>Definition at line <a class="el" href="arm__offset__q7_8c_source.html#l00058">58</a> of file <a class="el" href="arm__offset__q7_8c_source.html">arm_offset_q7.c</a>.</p>
 282
 283 </div>
 284 </div>
 285 </div>
 286 <!--- window showing the filter options -->
 287 <div id="MSearchSelectWindow"
 288      onmouseover="return searchBox.OnSearchSelectShow()"
 289      onmouseout="return searchBox.OnSearchSelectHide()"
 290      onkeydown="return searchBox.OnSearchSelectKey(event)">
 291 <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>
 292
 293 <!-- iframe showing the search results (closed by default) -->
 294 <div id="MSearchResultsWindow">
 295 <iframe src="" frameborder="0"
 296         name="MSearchResults" id="MSearchResults">
 297 </iframe>
 298 </div>
 299
 300 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:20 for CMSIS DSP Software Library by&#160;
 301 <a href="http://www.doxygen.org/index.html">
 302 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 303 </body>
 304 </html>