git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/Documentation/DSP_Lib/html/group___basic_add.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 Addition</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 Addition<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___basic_add.html#ga6a904a547413b10565dd1d251c6bafbd">arm_add_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrcA, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrcB, <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___basic_add.html#ga24d6c3f7f8b9fae4847c0c3f26a39a3b">arm_add_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrcA, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrcB, <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___basic_add.html#gabb51285a41f511670bbff62fc0e1bf62">arm_add_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcA, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrcB, <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___basic_add.html#gaed633f415a7840a66861debca2dfb96b">arm_add_q7</a> (<a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrcA, <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrcB, <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>Element-by-element addition of two vectors.</p>
  63 <pre>
  64      pDst[n] = pSrcA[n] + pSrcB[n],   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="ga6a904a547413b10565dd1d251c6bafbd"></a><!-- doxytag: member="arm_add_f32.c::arm_add_f32" ref="ga6a904a547413b10565dd1d251c6bafbd" args="(float32_t *pSrcA, float32_t *pSrcB, 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_add_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>pSrcA</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>pSrcB</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>Floating-point vector addition. </p>
 105 <dl><dt><b>Parameters:</b></dt><dd>
 106   <table class="params">
 107     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input vector </td></tr>
 108     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input vector </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 each vector </td></tr>
 111   </table>
 112   </dd>
 113 </dl>
 114 <dl class="return"><dt><b>Returns:</b></dt><dd>none. </dd></dl>
 115 <dl><dt><b>Examples: </b></dt><dd><a class="el" href="arm_dotproduct_example_f32_8c-example.html#a9">arm_dotproduct_example_f32.c</a>, and <a class="el" href="arm_sin_cos_example_f32_8c-example.html#a14">arm_sin_cos_example_f32.c</a>.</dd>
 116 </dl>
 117 <p>Definition at line <a class="el" href="arm__add__f32_8c_source.html#l00065">65</a> of file <a class="el" href="arm__add__f32_8c_source.html">arm_add_f32.c</a>.</p>
 118
 119 </div>
 120 </div>
 121 <a class="anchor" id="ga24d6c3f7f8b9fae4847c0c3f26a39a3b"></a><!-- doxytag: member="arm_add_q31.c::arm_add_q31" ref="ga24d6c3f7f8b9fae4847c0c3f26a39a3b" args="(q31_t *pSrcA, q31_t *pSrcB, q31_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_add_q31 </td>
 127           <td>(</td>
 128           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
 129           <td class="paramname"> <em>pSrcA</em>, </td>
 130         </tr>
 131         <tr>
 132           <td class="paramkey"></td>
 133           <td></td>
 134           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
 135           <td class="paramname"> <em>pSrcB</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#adc89a3547f5324b7b3b95adec3806bc0">q31_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>Q31 vector addition. </p>
 159 <dl><dt><b>Parameters:</b></dt><dd>
 160   <table class="params">
 161     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input vector </td></tr>
 162     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input vector </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 each 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 Q31 range[0x80000000 0x7FFFFFFF] will be saturated. </dd></dl>
 171
 172 <p>Definition at line <a class="el" href="arm__add__q31_8c_source.html#l00059">59</a> of file <a class="el" href="arm__add__q31_8c_source.html">arm_add_q31.c</a>.</p>
 173
 174 </div>
 175 </div>
 176 <a class="anchor" id="gabb51285a41f511670bbff62fc0e1bf62"></a><!-- doxytag: member="arm_add_q15.c::arm_add_q15" ref="gabb51285a41f511670bbff62fc0e1bf62" args="(q15_t *pSrcA, q15_t *pSrcB, q15_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_add_q15 </td>
 182           <td>(</td>
 183           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
 184           <td class="paramname"> <em>pSrcA</em>, </td>
 185         </tr>
 186         <tr>
 187           <td class="paramkey"></td>
 188           <td></td>
 189           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
 190           <td class="paramname"> <em>pSrcB</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#ab5a8fb21a5b3b983d5f54f31614052ea">q15_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>Q15 vector addition. </p>
 214 <dl><dt><b>Parameters:</b></dt><dd>
 215   <table class="params">
 216     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input vector </td></tr>
 217     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input vector </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 each 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 Q15 range [0x8000 0x7FFF] will be saturated. </dd></dl>
 226
 227 <p>Definition at line <a class="el" href="arm__add__q15_8c_source.html#l00058">58</a> of file <a class="el" href="arm__add__q15_8c_source.html">arm_add_q15.c</a>.</p>
 228
 229 </div>
 230 </div>
 231 <a class="anchor" id="gaed633f415a7840a66861debca2dfb96b"></a><!-- doxytag: member="arm_add_q7.c::arm_add_q7" ref="gaed633f415a7840a66861debca2dfb96b" args="(q7_t *pSrcA, q7_t *pSrcB, q7_t *pDst, uint32_t blockSize)" -->
 232 <div class="memitem">
 233 <div class="memproto">
 234       <table class="memname">
 235         <tr>
 236           <td class="memname">void arm_add_q7 </td>
 237           <td>(</td>
 238           <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *&#160;</td>
 239           <td class="paramname"> <em>pSrcA</em>, </td>
 240         </tr>
 241         <tr>
 242           <td class="paramkey"></td>
 243           <td></td>
 244           <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *&#160;</td>
 245           <td class="paramname"> <em>pSrcB</em>, </td>
 246         </tr>
 247         <tr>
 248           <td class="paramkey"></td>
 249           <td></td>
 250           <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *&#160;</td>
 251           <td class="paramname"> <em>pDst</em>, </td>
 252         </tr>
 253         <tr>
 254           <td class="paramkey"></td>
 255           <td></td>
 256           <td class="paramtype">uint32_t&#160;</td>
 257           <td class="paramname"> <em>blockSize</em>&#160;</td>
 258         </tr>
 259         <tr>
 260           <td></td>
 261           <td>)</td>
 262           <td></td><td></td>
 263         </tr>
 264       </table>
 265 </div>
 266 <div class="memdoc">
 267
 268 <p>Q7 vector addition. </p>
 269 <dl><dt><b>Parameters:</b></dt><dd>
 270   <table class="params">
 271     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input vector </td></tr>
 272     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input vector </td></tr>
 273     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output vector </td></tr>
 274     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in each vector </td></tr>
 275   </table>
 276   </dd>
 277 </dl>
 278 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 279 <p><b>Scaling and Overflow Behavior:</b> </p>
 280 <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>
 281
 282 <p>Definition at line <a class="el" href="arm__add__q7_8c_source.html#l00058">58</a> of file <a class="el" href="arm__add__q7_8c_source.html">arm_add_q7.c</a>.</p>
 283
 284 </div>
 285 </div>
 286 </div>
 287 <!--- window showing the filter options -->
 288 <div id="MSearchSelectWindow"
 289      onmouseover="return searchBox.OnSearchSelectShow()"
 290      onmouseout="return searchBox.OnSearchSelectHide()"
 291      onkeydown="return searchBox.OnSearchSelectKey(event)">
 292 <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>
 293
 294 <!-- iframe showing the search results (closed by default) -->
 295 <div id="MSearchResultsWindow">
 296 <iframe src="" frameborder="0"
 297         name="MSearchResults" id="MSearchResults">
 298 </iframe>
 299 </div>
 300
 301 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:19 for CMSIS DSP Software Library by&#160;
 302 <a href="http://www.doxygen.org/index.html">
 303 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 304 </body>
 305 </html>