group__BasicMath.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361
  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. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>Basic math functions</title>
  7. <title>CMSIS-NN: Basic math functions</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="printComponentTabs.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="resize.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-NN
  35. &#160;<span id="projectnumber">Version 1.3.0</span>
  36. </div>
  37. <div id="projectbrief">CMSIS NN Software Library</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('group__BasicMath.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</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>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="summary">
  109. <a href="#func-members">Functions</a> </div>
  110. <div class="headertitle">
  111. <div class="title">Basic math functions<div class="ingroups"><a class="el" href="group__groupNN.html">Neural Network Functions</a></div></div> </div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <table class="memberdecls">
  115. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  116. Functions</h2></td></tr>
  117. <tr class="memitem:gabc9644ba533138059baa8b582734698c"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicMath.html#gabc9644ba533138059baa8b582734698c">arm_elementwise_add_s8</a> (const int8_t *input_1_vect, const int8_t *input_2_vect, const int32_t input_1_offset, const int32_t input_1_mult, const int32_t input_1_shift, const int32_t input_2_offset, const int32_t input_2_mult, const int32_t input_2_shift, const int32_t left_shift, int8_t *output, const int32_t out_offset, const int32_t out_mult, const int32_t out_shift, const int32_t out_activation_min, const int32_t out_activation_max, const uint32_t block_size)</td></tr>
  118. <tr class="memdesc:gabc9644ba533138059baa8b582734698c"><td class="mdescLeft">&#160;</td><td class="mdescRight">s8 element wise add of two vectors <a href="#gabc9644ba533138059baa8b582734698c">More...</a><br/></td></tr>
  119. <tr class="separator:gabc9644ba533138059baa8b582734698c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:ga64125471aeb41aef308e5e729f52da1f"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasicMath.html#ga64125471aeb41aef308e5e729f52da1f">arm_elementwise_mul_s8</a> (const int8_t *input_1_vect, const int8_t *input_2_vect, const int32_t input_1_offset, const int32_t input_2_offset, int8_t *output, const int32_t out_offset, const int32_t out_mult, const int32_t out_shift, const int32_t out_activation_min, const int32_t out_activation_max, const uint32_t block_size)</td></tr>
  121. <tr class="memdesc:ga64125471aeb41aef308e5e729f52da1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">s8 element wise multiplication of two vectors <a href="#ga64125471aeb41aef308e5e729f52da1f">More...</a><br/></td></tr>
  122. <tr class="separator:ga64125471aeb41aef308e5e729f52da1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. </table>
  124. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  125. <p>Element wise add and multiplication functions. </p>
  126. <h2 class="groupheader">Function Documentation</h2>
  127. <a class="anchor" id="gabc9644ba533138059baa8b582734698c"></a>
  128. <div class="memitem">
  129. <div class="memproto">
  130. <table class="memname">
  131. <tr>
  132. <td class="memname">arm_status arm_elementwise_add_s8 </td>
  133. <td>(</td>
  134. <td class="paramtype">const int8_t *&#160;</td>
  135. <td class="paramname"><em>input_1_vect</em>, </td>
  136. </tr>
  137. <tr>
  138. <td class="paramkey"></td>
  139. <td></td>
  140. <td class="paramtype">const int8_t *&#160;</td>
  141. <td class="paramname"><em>input_2_vect</em>, </td>
  142. </tr>
  143. <tr>
  144. <td class="paramkey"></td>
  145. <td></td>
  146. <td class="paramtype">const int32_t&#160;</td>
  147. <td class="paramname"><em>input_1_offset</em>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype">const int32_t&#160;</td>
  153. <td class="paramname"><em>input_1_mult</em>, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype">const int32_t&#160;</td>
  159. <td class="paramname"><em>input_1_shift</em>, </td>
  160. </tr>
  161. <tr>
  162. <td class="paramkey"></td>
  163. <td></td>
  164. <td class="paramtype">const int32_t&#160;</td>
  165. <td class="paramname"><em>input_2_offset</em>, </td>
  166. </tr>
  167. <tr>
  168. <td class="paramkey"></td>
  169. <td></td>
  170. <td class="paramtype">const int32_t&#160;</td>
  171. <td class="paramname"><em>input_2_mult</em>, </td>
  172. </tr>
  173. <tr>
  174. <td class="paramkey"></td>
  175. <td></td>
  176. <td class="paramtype">const int32_t&#160;</td>
  177. <td class="paramname"><em>input_2_shift</em>, </td>
  178. </tr>
  179. <tr>
  180. <td class="paramkey"></td>
  181. <td></td>
  182. <td class="paramtype">const int32_t&#160;</td>
  183. <td class="paramname"><em>left_shift</em>, </td>
  184. </tr>
  185. <tr>
  186. <td class="paramkey"></td>
  187. <td></td>
  188. <td class="paramtype">int8_t *&#160;</td>
  189. <td class="paramname"><em>output</em>, </td>
  190. </tr>
  191. <tr>
  192. <td class="paramkey"></td>
  193. <td></td>
  194. <td class="paramtype">const int32_t&#160;</td>
  195. <td class="paramname"><em>out_offset</em>, </td>
  196. </tr>
  197. <tr>
  198. <td class="paramkey"></td>
  199. <td></td>
  200. <td class="paramtype">const int32_t&#160;</td>
  201. <td class="paramname"><em>out_mult</em>, </td>
  202. </tr>
  203. <tr>
  204. <td class="paramkey"></td>
  205. <td></td>
  206. <td class="paramtype">const int32_t&#160;</td>
  207. <td class="paramname"><em>out_shift</em>, </td>
  208. </tr>
  209. <tr>
  210. <td class="paramkey"></td>
  211. <td></td>
  212. <td class="paramtype">const int32_t&#160;</td>
  213. <td class="paramname"><em>out_activation_min</em>, </td>
  214. </tr>
  215. <tr>
  216. <td class="paramkey"></td>
  217. <td></td>
  218. <td class="paramtype">const int32_t&#160;</td>
  219. <td class="paramname"><em>out_activation_max</em>, </td>
  220. </tr>
  221. <tr>
  222. <td class="paramkey"></td>
  223. <td></td>
  224. <td class="paramtype">const uint32_t&#160;</td>
  225. <td class="paramname"><em>block_size</em>&#160;</td>
  226. </tr>
  227. <tr>
  228. <td></td>
  229. <td>)</td>
  230. <td></td><td></td>
  231. </tr>
  232. </table>
  233. </div><div class="memdoc">
  234. <dl class="params"><dt>Parameters</dt><dd>
  235. <table class="params">
  236. <tr><td class="paramdir">[in]</td><td class="paramname">input_1_vect</td><td>pointer to input vector 1 </td></tr>
  237. <tr><td class="paramdir">[in]</td><td class="paramname">input_2_vect</td><td>pointer to input vector 2 </td></tr>
  238. <tr><td class="paramdir">[in]</td><td class="paramname">input_1_offset</td><td>offset for input 1. Range: Range: -127 to 128 </td></tr>
  239. <tr><td class="paramdir">[in]</td><td class="paramname">input_1_mult</td><td>multiplier for input 1 </td></tr>
  240. <tr><td class="paramdir">[in]</td><td class="paramname">input_1_shift</td><td>shift for input 1 </td></tr>
  241. <tr><td class="paramdir">[in]</td><td class="paramname">input_2_offset</td><td>offset for input 2. Range: Range: -127 to 128 </td></tr>
  242. <tr><td class="paramdir">[in]</td><td class="paramname">input_2_mult</td><td>multiplier for input 2 </td></tr>
  243. <tr><td class="paramdir">[in]</td><td class="paramname">input_2_shift</td><td>shift for input 2 </td></tr>
  244. <tr><td class="paramdir">[in]</td><td class="paramname">left_shift</td><td>input left shift </td></tr>
  245. <tr><td class="paramdir">[in,out]</td><td class="paramname">output</td><td>pointer to output vector </td></tr>
  246. <tr><td class="paramdir">[in]</td><td class="paramname">out_offset</td><td>output offset </td></tr>
  247. <tr><td class="paramdir">[in]</td><td class="paramname">out_mult</td><td>output multiplier </td></tr>
  248. <tr><td class="paramdir">[in]</td><td class="paramname">out_shift</td><td>output shift </td></tr>
  249. <tr><td class="paramdir">[in]</td><td class="paramname">out_activation_min</td><td>minimum value to clamp output to </td></tr>
  250. <tr><td class="paramdir">[in]</td><td class="paramname">out_activation_max</td><td>maximum value to clamp output to </td></tr>
  251. <tr><td class="paramdir">[in]</td><td class="paramname">block_size</td><td>number of samples </td></tr>
  252. </table>
  253. </dd>
  254. </dl>
  255. <dl class="section return"><dt>Returns</dt><dd>The function returns ARM_MATH_SUCCESS </dd></dl>
  256. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#ab6dbc2fd53fae3ccdd1d0d70c8d3b491">arm_nn_divide_by_power_of_two()</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a51721c10f116c9f5b8d9908367989d44">arm_nn_sat_doubling_high_mult()</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#ad935f1ff1a50822e317bdb321ce991ad">MAX</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#adcd021ac91d43a62b2cdecf9a5b971a7">MIN</a>, and <a class="el" href="arm__elementwise__add__s8_8c.html#a1606ef9b62cb80afbf1d780c4958cf0c">SAT_INPUT</a>.</p>
  257. </div>
  258. </div>
  259. <a class="anchor" id="ga64125471aeb41aef308e5e729f52da1f"></a>
  260. <div class="memitem">
  261. <div class="memproto">
  262. <table class="memname">
  263. <tr>
  264. <td class="memname">arm_status arm_elementwise_mul_s8 </td>
  265. <td>(</td>
  266. <td class="paramtype">const int8_t *&#160;</td>
  267. <td class="paramname"><em>input_1_vect</em>, </td>
  268. </tr>
  269. <tr>
  270. <td class="paramkey"></td>
  271. <td></td>
  272. <td class="paramtype">const int8_t *&#160;</td>
  273. <td class="paramname"><em>input_2_vect</em>, </td>
  274. </tr>
  275. <tr>
  276. <td class="paramkey"></td>
  277. <td></td>
  278. <td class="paramtype">const int32_t&#160;</td>
  279. <td class="paramname"><em>input_1_offset</em>, </td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey"></td>
  283. <td></td>
  284. <td class="paramtype">const int32_t&#160;</td>
  285. <td class="paramname"><em>input_2_offset</em>, </td>
  286. </tr>
  287. <tr>
  288. <td class="paramkey"></td>
  289. <td></td>
  290. <td class="paramtype">int8_t *&#160;</td>
  291. <td class="paramname"><em>output</em>, </td>
  292. </tr>
  293. <tr>
  294. <td class="paramkey"></td>
  295. <td></td>
  296. <td class="paramtype">const int32_t&#160;</td>
  297. <td class="paramname"><em>out_offset</em>, </td>
  298. </tr>
  299. <tr>
  300. <td class="paramkey"></td>
  301. <td></td>
  302. <td class="paramtype">const int32_t&#160;</td>
  303. <td class="paramname"><em>out_mult</em>, </td>
  304. </tr>
  305. <tr>
  306. <td class="paramkey"></td>
  307. <td></td>
  308. <td class="paramtype">const int32_t&#160;</td>
  309. <td class="paramname"><em>out_shift</em>, </td>
  310. </tr>
  311. <tr>
  312. <td class="paramkey"></td>
  313. <td></td>
  314. <td class="paramtype">const int32_t&#160;</td>
  315. <td class="paramname"><em>out_activation_min</em>, </td>
  316. </tr>
  317. <tr>
  318. <td class="paramkey"></td>
  319. <td></td>
  320. <td class="paramtype">const int32_t&#160;</td>
  321. <td class="paramname"><em>out_activation_max</em>, </td>
  322. </tr>
  323. <tr>
  324. <td class="paramkey"></td>
  325. <td></td>
  326. <td class="paramtype">const uint32_t&#160;</td>
  327. <td class="paramname"><em>block_size</em>&#160;</td>
  328. </tr>
  329. <tr>
  330. <td></td>
  331. <td>)</td>
  332. <td></td><td></td>
  333. </tr>
  334. </table>
  335. </div><div class="memdoc">
  336. <p>s8 element wise multiplication</p>
  337. <dl class="section note"><dt>Note</dt><dd>Refer header file for details. </dd></dl>
  338. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#a6a13b7a567485da5fc7f0d311318886d">arm_nn_requantize()</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#ad935f1ff1a50822e317bdb321ce991ad">MAX</a>, and <a class="el" href="arm__nnsupportfunctions_8h.html#adcd021ac91d43a62b2cdecf9a5b971a7">MIN</a>.</p>
  339. </div>
  340. </div>
  341. </div><!-- contents -->
  342. </div><!-- doc-content -->
  343. <!-- start footer part -->
  344. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  345. <ul>
  346. <li class="footer">Generated on Thu Apr 9 2020 15:49:34 for CMSIS-NN Version 1.3.0 by Arm Ltd. All rights reserved.
  347. <!--
  348. <a href="http://www.doxygen.org/index.html">
  349. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  350. -->
  351. </li>
  352. </ul>
  353. </div>
  354. </body>
  355. </html>