git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/Documentation/DSP_Lib/html/group__dot__prod.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 Dot Product</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 Dot Product<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__dot__prod.html#ga55418d4362f6ba84c327f9b4f089a8c3">arm_dot_prod_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, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *result)</td></tr>
  57 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dot__prod.html#gab15d8fa060fc85b4d948d091b7deaa11">arm_dot_prod_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, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#a5aea1cb12fc02d9d44c8abf217eaa5c6">q63_t</a> *result)</td></tr>
  58 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dot__prod.html#ga436d5bed28a4b73b24acbde436a3044b">arm_dot_prod_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, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#a5aea1cb12fc02d9d44c8abf217eaa5c6">q63_t</a> *result)</td></tr>
  59 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dot__prod.html#ga9c3293a50ac7ec8ba928bf8e3aaea6c1">arm_dot_prod_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, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *result)</td></tr>
  60 </table>
  61 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  62 <p>Computes the dot product of two vectors. The vectors are multiplied element-by-element and then summed. There are separate functions for floating-point, Q7, Q15, and Q31 data types. </p>
  63 <hr/><h2>Function Documentation</h2>
  64 <a class="anchor" id="ga55418d4362f6ba84c327f9b4f089a8c3"></a><!-- doxytag: member="arm_dot_prod_f32.c::arm_dot_prod_f32" ref="ga55418d4362f6ba84c327f9b4f089a8c3" args="(float32_t *pSrcA, float32_t *pSrcB, uint32_t blockSize, float32_t *result)" -->
  65 <div class="memitem">
  66 <div class="memproto">
  67       <table class="memname">
  68         <tr>
  69           <td class="memname">void arm_dot_prod_f32 </td>
  70           <td>(</td>
  71           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  72           <td class="paramname"> <em>pSrcA</em>, </td>
  73         </tr>
  74         <tr>
  75           <td class="paramkey"></td>
  76           <td></td>
  77           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  78           <td class="paramname"> <em>pSrcB</em>, </td>
  79         </tr>
  80         <tr>
  81           <td class="paramkey"></td>
  82           <td></td>
  83           <td class="paramtype">uint32_t&#160;</td>
  84           <td class="paramname"> <em>blockSize</em>, </td>
  85         </tr>
  86         <tr>
  87           <td class="paramkey"></td>
  88           <td></td>
  89           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  90           <td class="paramname"> <em>result</em>&#160;</td>
  91         </tr>
  92         <tr>
  93           <td></td>
  94           <td>)</td>
  95           <td></td><td></td>
  96         </tr>
  97       </table>
  98 </div>
  99 <div class="memdoc">
 100
 101 <p>Dot product of floating-point vectors. </p>
 102 <dl><dt><b>Parameters:</b></dt><dd>
 103   <table class="params">
 104     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input vector </td></tr>
 105     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input vector </td></tr>
 106     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in each vector </td></tr>
 107     <tr><td class="paramdir">[out]</td><td class="paramname">*result</td><td>output result returned here </td></tr>
 108   </table>
 109   </dd>
 110 </dl>
 111 <dl class="return"><dt><b>Returns:</b></dt><dd>none. </dd></dl>
 112 <dl><dt><b>Examples: </b></dt><dd><a class="el" href="arm_variance_example_f32_8c-example.html#a12">arm_variance_example_f32.c</a>.</dd>
 113 </dl>
 114 <p>Definition at line <a class="el" href="arm__dot__prod__f32_8c_source.html#l00062">62</a> of file <a class="el" href="arm__dot__prod__f32_8c_source.html">arm_dot_prod_f32.c</a>.</p>
 115
 116 </div>
 117 </div>
 118 <a class="anchor" id="gab15d8fa060fc85b4d948d091b7deaa11"></a><!-- doxytag: member="arm_dot_prod_q31.c::arm_dot_prod_q31" ref="gab15d8fa060fc85b4d948d091b7deaa11" args="(q31_t *pSrcA, q31_t *pSrcB, uint32_t blockSize, q63_t *result)" -->
 119 <div class="memitem">
 120 <div class="memproto">
 121       <table class="memname">
 122         <tr>
 123           <td class="memname">void arm_dot_prod_q31 </td>
 124           <td>(</td>
 125           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
 126           <td class="paramname"> <em>pSrcA</em>, </td>
 127         </tr>
 128         <tr>
 129           <td class="paramkey"></td>
 130           <td></td>
 131           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
 132           <td class="paramname"> <em>pSrcB</em>, </td>
 133         </tr>
 134         <tr>
 135           <td class="paramkey"></td>
 136           <td></td>
 137           <td class="paramtype">uint32_t&#160;</td>
 138           <td class="paramname"> <em>blockSize</em>, </td>
 139         </tr>
 140         <tr>
 141           <td class="paramkey"></td>
 142           <td></td>
 143           <td class="paramtype"><a class="el" href="arm__math_8h.html#a5aea1cb12fc02d9d44c8abf217eaa5c6">q63_t</a> *&#160;</td>
 144           <td class="paramname"> <em>result</em>&#160;</td>
 145         </tr>
 146         <tr>
 147           <td></td>
 148           <td>)</td>
 149           <td></td><td></td>
 150         </tr>
 151       </table>
 152 </div>
 153 <div class="memdoc">
 154
 155 <p>Dot product of Q31 vectors. </p>
 156 <dl><dt><b>Parameters:</b></dt><dd>
 157   <table class="params">
 158     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input vector </td></tr>
 159     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input vector </td></tr>
 160     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in each vector </td></tr>
 161     <tr><td class="paramdir">[out]</td><td class="paramname">*result</td><td>output result returned here </td></tr>
 162   </table>
 163   </dd>
 164 </dl>
 165 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 166 <p><b>Scaling and Overflow Behavior:</b> </p>
 167 <dl class="user"><dt><b></b></dt><dd>The intermediate multiplications are in 1.31 x 1.31 = 2.62 format and these are truncated to 2.48 format by discarding the lower 14 bits. The 2.48 result is then added without saturation to a 64-bit accumulator in 16.48 format. There are 15 guard bits in the accumulator and there is no risk of overflow as long as the length of the vectors is less than 2^16 elements. The return result is in 16.48 format. </dd></dl>
 168
 169 <p>Definition at line <a class="el" href="arm__dot__prod__q31_8c_source.html#l00062">62</a> of file <a class="el" href="arm__dot__prod__q31_8c_source.html">arm_dot_prod_q31.c</a>.</p>
 170
 171 </div>
 172 </div>
 173 <a class="anchor" id="ga436d5bed28a4b73b24acbde436a3044b"></a><!-- doxytag: member="arm_dot_prod_q15.c::arm_dot_prod_q15" ref="ga436d5bed28a4b73b24acbde436a3044b" args="(q15_t *pSrcA, q15_t *pSrcB, uint32_t blockSize, q63_t *result)" -->
 174 <div class="memitem">
 175 <div class="memproto">
 176       <table class="memname">
 177         <tr>
 178           <td class="memname">void arm_dot_prod_q15 </td>
 179           <td>(</td>
 180           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
 181           <td class="paramname"> <em>pSrcA</em>, </td>
 182         </tr>
 183         <tr>
 184           <td class="paramkey"></td>
 185           <td></td>
 186           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
 187           <td class="paramname"> <em>pSrcB</em>, </td>
 188         </tr>
 189         <tr>
 190           <td class="paramkey"></td>
 191           <td></td>
 192           <td class="paramtype">uint32_t&#160;</td>
 193           <td class="paramname"> <em>blockSize</em>, </td>
 194         </tr>
 195         <tr>
 196           <td class="paramkey"></td>
 197           <td></td>
 198           <td class="paramtype"><a class="el" href="arm__math_8h.html#a5aea1cb12fc02d9d44c8abf217eaa5c6">q63_t</a> *&#160;</td>
 199           <td class="paramname"> <em>result</em>&#160;</td>
 200         </tr>
 201         <tr>
 202           <td></td>
 203           <td>)</td>
 204           <td></td><td></td>
 205         </tr>
 206       </table>
 207 </div>
 208 <div class="memdoc">
 209
 210 <p>Dot product of Q15 vectors. </p>
 211 <dl><dt><b>Parameters:</b></dt><dd>
 212   <table class="params">
 213     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input vector </td></tr>
 214     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input vector </td></tr>
 215     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in each vector </td></tr>
 216     <tr><td class="paramdir">[out]</td><td class="paramname">*result</td><td>output result returned here </td></tr>
 217   </table>
 218   </dd>
 219 </dl>
 220 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 221 <p><b>Scaling and Overflow Behavior:</b> </p>
 222 <dl class="user"><dt><b></b></dt><dd>The intermediate multiplications are in 1.15 x 1.15 = 2.30 format and these results are added to a 64-bit accumulator in 34.30 format. Nonsaturating additions are used and given that there are 33 guard bits in the accumulator there is no risk of overflow. The return result is in 34.30 format. </dd></dl>
 223
 224 <p>Definition at line <a class="el" href="arm__dot__prod__q15_8c_source.html#l00061">61</a> of file <a class="el" href="arm__dot__prod__q15_8c_source.html">arm_dot_prod_q15.c</a>.</p>
 225
 226 </div>
 227 </div>
 228 <a class="anchor" id="ga9c3293a50ac7ec8ba928bf8e3aaea6c1"></a><!-- doxytag: member="arm_dot_prod_q7.c::arm_dot_prod_q7" ref="ga9c3293a50ac7ec8ba928bf8e3aaea6c1" args="(q7_t *pSrcA, q7_t *pSrcB, uint32_t blockSize, q31_t *result)" -->
 229 <div class="memitem">
 230 <div class="memproto">
 231       <table class="memname">
 232         <tr>
 233           <td class="memname">void arm_dot_prod_q7 </td>
 234           <td>(</td>
 235           <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *&#160;</td>
 236           <td class="paramname"> <em>pSrcA</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>pSrcB</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>, </td>
 249         </tr>
 250         <tr>
 251           <td class="paramkey"></td>
 252           <td></td>
 253           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
 254           <td class="paramname"> <em>result</em>&#160;</td>
 255         </tr>
 256         <tr>
 257           <td></td>
 258           <td>)</td>
 259           <td></td><td></td>
 260         </tr>
 261       </table>
 262 </div>
 263 <div class="memdoc">
 264
 265 <p>Dot product of Q7 vectors. </p>
 266 <dl><dt><b>Parameters:</b></dt><dd>
 267   <table class="params">
 268     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input vector </td></tr>
 269     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input vector </td></tr>
 270     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in each vector </td></tr>
 271     <tr><td class="paramdir">[out]</td><td class="paramname">*result</td><td>output result returned here </td></tr>
 272   </table>
 273   </dd>
 274 </dl>
 275 <dl class="return"><dt><b>Returns:</b></dt><dd>none.</dd></dl>
 276 <p><b>Scaling and Overflow Behavior:</b> </p>
 277 <dl class="user"><dt><b></b></dt><dd>The intermediate multiplications are in 1.7 x 1.7 = 2.14 format and these results are added to an accumulator in 18.14 format. Nonsaturating additions are used and there is no danger of wrap around as long as the vectors are less than 2^18 elements long. The return result is in 18.14 format. </dd></dl>
 278
 279 <p>Definition at line <a class="el" href="arm__dot__prod__q7_8c_source.html#l00061">61</a> of file <a class="el" href="arm__dot__prod__q7_8c_source.html">arm_dot_prod_q7.c</a>.</p>
 280
 281 </div>
 282 </div>
 283 </div>
 284 <!--- window showing the filter options -->
 285 <div id="MSearchSelectWindow"
 286      onmouseover="return searchBox.OnSearchSelectShow()"
 287      onmouseout="return searchBox.OnSearchSelectHide()"
 288      onkeydown="return searchBox.OnSearchSelectKey(event)">
 289 <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>
 290
 291 <!-- iframe showing the search results (closed by default) -->
 292 <div id="MSearchResultsWindow">
 293 <iframe src="" frameborder="0"
 294         name="MSearchResults" id="MSearchResults">
 295 </iframe>
 296 </div>
 297
 298 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:19 for CMSIS DSP Software Library by&#160;
 299 <a href="http://www.doxygen.org/index.html">
 300 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 301 </body>
 302 </html>