group__Pooling.html 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775
  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>Pooling Functions</title>
  7. <title>CMSIS-NN: Pooling 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__Pooling.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">Pooling 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:gaeda2a7c2689d698398fb85278b7d940b"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Pooling.html#gaeda2a7c2689d698398fb85278b7d940b">arm_avgpool_s8</a> (const int dim_src_height, const int dim_src_width, const int dim_dst_height, const int dim_dst_width, const int stride_height, const int stride_width, const int dim_kernel_height, const int dim_kernel_width, const int padding_height, const int padding_width, const int act_min, const int act_max, const int ch_src, int8_t *src, int16_t *bufferA, int8_t *dst)</td></tr>
  118. <tr class="memdesc:gaeda2a7c2689d698398fb85278b7d940b"><td class="mdescLeft">&#160;</td><td class="mdescRight">s8 average pooling function <a href="#gaeda2a7c2689d698398fb85278b7d940b">More...</a><br/></td></tr>
  119. <tr class="separator:gaeda2a7c2689d698398fb85278b7d940b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:gaca9a9dfa088bec0c4ac16f14518cf6a3"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Pooling.html#gaca9a9dfa088bec0c4ac16f14518cf6a3">arm_avgpool_s8_get_buffer_size</a> (const int dim_dst_width, const int ch_src)</td></tr>
  121. <tr class="memdesc:gaca9a9dfa088bec0c4ac16f14518cf6a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the required buffer size for S8 average pooling function. <a href="#gaca9a9dfa088bec0c4ac16f14518cf6a3">More...</a><br/></td></tr>
  122. <tr class="separator:gaca9a9dfa088bec0c4ac16f14518cf6a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:ga9ba8703e0f24059167f445c978026764"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Pooling.html#ga9ba8703e0f24059167f445c978026764">arm_max_pool_s8</a> (const uint16_t input_y, const uint16_t input_x, const uint16_t output_y, const uint16_t output_x, const uint16_t stride_y, const uint16_t stride_x, const uint16_t kernel_y, const uint16_t kernel_x, const uint16_t pad_y, const uint16_t pad_x, const int8_t act_min, const int8_t act_max, const uint16_t channel_in, int8_t *input, int16_t *tmp_buffer, int8_t *output)</td></tr>
  124. <tr class="memdesc:ga9ba8703e0f24059167f445c978026764"><td class="mdescLeft">&#160;</td><td class="mdescRight">s8 pure C max pooling function <a href="#ga9ba8703e0f24059167f445c978026764">More...</a><br/></td></tr>
  125. <tr class="separator:ga9ba8703e0f24059167f445c978026764"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:ga692bad3854c43c5b95c48de461ea9100"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Pooling.html#ga692bad3854c43c5b95c48de461ea9100">arm_max_pool_s8_opt</a> (const uint16_t input_y, const uint16_t input_x, const uint16_t output_y, const uint16_t output_x, const uint16_t stride_y, const uint16_t stride_x, const uint16_t kernel_y, const uint16_t kernel_x, const uint16_t pad_y, const uint16_t pad_x, const int8_t act_min, const int8_t act_max, const uint16_t depth, int8_t *src, int16_t *tmp_buffer, int8_t *dst)</td></tr>
  127. <tr class="memdesc:ga692bad3854c43c5b95c48de461ea9100"><td class="mdescLeft">&#160;</td><td class="mdescRight">s8 DSP optimized max pooling function <a href="#ga692bad3854c43c5b95c48de461ea9100">More...</a><br/></td></tr>
  128. <tr class="separator:ga692bad3854c43c5b95c48de461ea9100"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ga99afcdcc61eaf429ab3ee823702e44ce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Pooling.html#ga99afcdcc61eaf429ab3ee823702e44ce">arm_maxpool_q7_HWC</a> (q7_t *Im_in, const uint16_t dim_im_in, const uint16_t ch_im_in, const uint16_t dim_kernel, const uint16_t padding, const uint16_t stride, const uint16_t dim_im_out, q7_t *bufferA, q7_t *Im_out)</td></tr>
  130. <tr class="memdesc:ga99afcdcc61eaf429ab3ee823702e44ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 max pooling function. <a href="#ga99afcdcc61eaf429ab3ee823702e44ce">More...</a><br/></td></tr>
  131. <tr class="separator:ga99afcdcc61eaf429ab3ee823702e44ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:gae4a7b07f97ec4313524c9fb9fbcb1f6a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Pooling.html#gae4a7b07f97ec4313524c9fb9fbcb1f6a">arm_avepool_q7_HWC</a> (q7_t *Im_in, const uint16_t dim_im_in, const uint16_t ch_im_in, const uint16_t dim_kernel, const uint16_t padding, const uint16_t stride, const uint16_t dim_im_out, q7_t *bufferA, q7_t *Im_out)</td></tr>
  133. <tr class="memdesc:gae4a7b07f97ec4313524c9fb9fbcb1f6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 average pooling function. <a href="#gae4a7b07f97ec4313524c9fb9fbcb1f6a">More...</a><br/></td></tr>
  134. <tr class="separator:gae4a7b07f97ec4313524c9fb9fbcb1f6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. </table>
  136. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  137. <p>Perform pooling functions, including max pooling and average pooling </p>
  138. <h2 class="groupheader">Function Documentation</h2>
  139. <a class="anchor" id="gae4a7b07f97ec4313524c9fb9fbcb1f6a"></a>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname">void arm_avepool_q7_HWC </td>
  145. <td>(</td>
  146. <td class="paramtype">q7_t *&#160;</td>
  147. <td class="paramname"><em>Im_in</em>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype">const uint16_t&#160;</td>
  153. <td class="paramname"><em>dim_im_in</em>, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype">const uint16_t&#160;</td>
  159. <td class="paramname"><em>ch_im_in</em>, </td>
  160. </tr>
  161. <tr>
  162. <td class="paramkey"></td>
  163. <td></td>
  164. <td class="paramtype">const uint16_t&#160;</td>
  165. <td class="paramname"><em>dim_kernel</em>, </td>
  166. </tr>
  167. <tr>
  168. <td class="paramkey"></td>
  169. <td></td>
  170. <td class="paramtype">const uint16_t&#160;</td>
  171. <td class="paramname"><em>padding</em>, </td>
  172. </tr>
  173. <tr>
  174. <td class="paramkey"></td>
  175. <td></td>
  176. <td class="paramtype">const uint16_t&#160;</td>
  177. <td class="paramname"><em>stride</em>, </td>
  178. </tr>
  179. <tr>
  180. <td class="paramkey"></td>
  181. <td></td>
  182. <td class="paramtype">const uint16_t&#160;</td>
  183. <td class="paramname"><em>dim_im_out</em>, </td>
  184. </tr>
  185. <tr>
  186. <td class="paramkey"></td>
  187. <td></td>
  188. <td class="paramtype">q7_t *&#160;</td>
  189. <td class="paramname"><em>bufferA</em>, </td>
  190. </tr>
  191. <tr>
  192. <td class="paramkey"></td>
  193. <td></td>
  194. <td class="paramtype">q7_t *&#160;</td>
  195. <td class="paramname"><em>Im_out</em>&#160;</td>
  196. </tr>
  197. <tr>
  198. <td></td>
  199. <td>)</td>
  200. <td></td><td></td>
  201. </tr>
  202. </table>
  203. </div><div class="memdoc">
  204. <dl class="params"><dt>Parameters</dt><dd>
  205. <table class="params">
  206. <tr><td class="paramdir">[in,out]</td><td class="paramname">Im_in</td><td>pointer to input tensor </td></tr>
  207. <tr><td class="paramdir">[in]</td><td class="paramname">dim_im_in</td><td>input tensor dimention </td></tr>
  208. <tr><td class="paramdir">[in]</td><td class="paramname">ch_im_in</td><td>number of input tensor channels </td></tr>
  209. <tr><td class="paramdir">[in]</td><td class="paramname">dim_kernel</td><td>filter kernel size </td></tr>
  210. <tr><td class="paramdir">[in]</td><td class="paramname">padding</td><td>padding sizes </td></tr>
  211. <tr><td class="paramdir">[in]</td><td class="paramname">stride</td><td>convolution stride </td></tr>
  212. <tr><td class="paramdir">[in]</td><td class="paramname">dim_im_out</td><td>output tensor dimension </td></tr>
  213. <tr><td class="paramdir">[in,out]</td><td class="paramname">bufferA</td><td>pointer to buffer space for input </td></tr>
  214. <tr><td class="paramdir">[in,out]</td><td class="paramname">Im_out</td><td>pointer to output tensor</td></tr>
  215. </table>
  216. </dd>
  217. </dl>
  218. <p><b>Buffer size:</b></p>
  219. <p>bufferA size: 2*dim_im_out*ch_im_in</p>
  220. <p>The pooling function is implemented as split x-pooling then y-pooling.</p>
  221. <p>This pooling function is input-destructive. Input data is undefined after calling this function. </p>
  222. <p>References <a class="el" href="group__nndata__convert.html#gae349de4dba8d253c89d45794ccf05680">arm_q7_to_q15_no_shift()</a>.</p>
  223. </div>
  224. </div>
  225. <a class="anchor" id="gaeda2a7c2689d698398fb85278b7d940b"></a>
  226. <div class="memitem">
  227. <div class="memproto">
  228. <table class="memname">
  229. <tr>
  230. <td class="memname">arm_status arm_avgpool_s8 </td>
  231. <td>(</td>
  232. <td class="paramtype">const int&#160;</td>
  233. <td class="paramname"><em>dim_src_height</em>, </td>
  234. </tr>
  235. <tr>
  236. <td class="paramkey"></td>
  237. <td></td>
  238. <td class="paramtype">const int&#160;</td>
  239. <td class="paramname"><em>dim_src_width</em>, </td>
  240. </tr>
  241. <tr>
  242. <td class="paramkey"></td>
  243. <td></td>
  244. <td class="paramtype">const int&#160;</td>
  245. <td class="paramname"><em>dim_dst_height</em>, </td>
  246. </tr>
  247. <tr>
  248. <td class="paramkey"></td>
  249. <td></td>
  250. <td class="paramtype">const int&#160;</td>
  251. <td class="paramname"><em>dim_dst_width</em>, </td>
  252. </tr>
  253. <tr>
  254. <td class="paramkey"></td>
  255. <td></td>
  256. <td class="paramtype">const int&#160;</td>
  257. <td class="paramname"><em>stride_height</em>, </td>
  258. </tr>
  259. <tr>
  260. <td class="paramkey"></td>
  261. <td></td>
  262. <td class="paramtype">const int&#160;</td>
  263. <td class="paramname"><em>stride_width</em>, </td>
  264. </tr>
  265. <tr>
  266. <td class="paramkey"></td>
  267. <td></td>
  268. <td class="paramtype">const int&#160;</td>
  269. <td class="paramname"><em>dim_kernel_height</em>, </td>
  270. </tr>
  271. <tr>
  272. <td class="paramkey"></td>
  273. <td></td>
  274. <td class="paramtype">const int&#160;</td>
  275. <td class="paramname"><em>dim_kernel_width</em>, </td>
  276. </tr>
  277. <tr>
  278. <td class="paramkey"></td>
  279. <td></td>
  280. <td class="paramtype">const int&#160;</td>
  281. <td class="paramname"><em>padding_height</em>, </td>
  282. </tr>
  283. <tr>
  284. <td class="paramkey"></td>
  285. <td></td>
  286. <td class="paramtype">const int&#160;</td>
  287. <td class="paramname"><em>padding_width</em>, </td>
  288. </tr>
  289. <tr>
  290. <td class="paramkey"></td>
  291. <td></td>
  292. <td class="paramtype">const int&#160;</td>
  293. <td class="paramname"><em>act_min</em>, </td>
  294. </tr>
  295. <tr>
  296. <td class="paramkey"></td>
  297. <td></td>
  298. <td class="paramtype">const int&#160;</td>
  299. <td class="paramname"><em>act_max</em>, </td>
  300. </tr>
  301. <tr>
  302. <td class="paramkey"></td>
  303. <td></td>
  304. <td class="paramtype">const int&#160;</td>
  305. <td class="paramname"><em>ch_src</em>, </td>
  306. </tr>
  307. <tr>
  308. <td class="paramkey"></td>
  309. <td></td>
  310. <td class="paramtype">int8_t *&#160;</td>
  311. <td class="paramname"><em>src</em>, </td>
  312. </tr>
  313. <tr>
  314. <td class="paramkey"></td>
  315. <td></td>
  316. <td class="paramtype">int16_t *&#160;</td>
  317. <td class="paramname"><em>bufferA</em>, </td>
  318. </tr>
  319. <tr>
  320. <td class="paramkey"></td>
  321. <td></td>
  322. <td class="paramtype">int8_t *&#160;</td>
  323. <td class="paramname"><em>dst</em>&#160;</td>
  324. </tr>
  325. <tr>
  326. <td></td>
  327. <td>)</td>
  328. <td></td><td></td>
  329. </tr>
  330. </table>
  331. </div><div class="memdoc">
  332. <dl class="params"><dt>Parameters</dt><dd>
  333. <table class="params">
  334. <tr><td class="paramdir">[in]</td><td class="paramname">dim_src_height</td><td>input tensor dimension </td></tr>
  335. <tr><td class="paramdir">[in]</td><td class="paramname">dim_src_width</td><td>input tensor dimension </td></tr>
  336. <tr><td class="paramdir">[in]</td><td class="paramname">dim_dst_height</td><td>output tensor dimension </td></tr>
  337. <tr><td class="paramdir">[in]</td><td class="paramname">dim_dst_width</td><td>output tensor dimension </td></tr>
  338. <tr><td class="paramdir">[in]</td><td class="paramname">stride_height</td><td>stride along y </td></tr>
  339. <tr><td class="paramdir">[in]</td><td class="paramname">stride_width</td><td>stride along x </td></tr>
  340. <tr><td class="paramdir">[in]</td><td class="paramname">dim_kernel_height</td><td>filter kernel size along y </td></tr>
  341. <tr><td class="paramdir">[in]</td><td class="paramname">dim_kernel_width</td><td>filter kernel size along x </td></tr>
  342. <tr><td class="paramdir">[in]</td><td class="paramname">padding_height</td><td>padding size along y </td></tr>
  343. <tr><td class="paramdir">[in]</td><td class="paramname">padding_width</td><td>padding size along x </td></tr>
  344. <tr><td class="paramdir">[in]</td><td class="paramname">act_min</td><td>Min clamping </td></tr>
  345. <tr><td class="paramdir">[in]</td><td class="paramname">act_max</td><td>Max clamping </td></tr>
  346. <tr><td class="paramdir">[in]</td><td class="paramname">ch_src</td><td>number of input tensor channels </td></tr>
  347. <tr><td class="paramdir">[in,out]</td><td class="paramname">src</td><td>pointer to input tensor </td></tr>
  348. <tr><td class="paramdir">[in]</td><td class="paramname">bufferA</td><td>temporary buffer used for optimization and is necessary when ARM_MATH_DSP is defined. Required space: (ch_src * dim_dst_width) * sizeof(q15_t) bytes Use <a class="el" href="group__Pooling.html#gaca9a9dfa088bec0c4ac16f14518cf6a3" title="Get the required buffer size for S8 average pooling function. ">arm_avgpool_s8_get_buffer_size()</a> to get the size </td></tr>
  349. <tr><td class="paramdir">[in,out]</td><td class="paramname">dst</td><td>pointer to output tensor </td></tr>
  350. </table>
  351. </dd>
  352. </dl>
  353. <dl class="section return"><dt>Returns</dt><dd>The function returns one of the following <code>ARM_MATH_SIZE_MISMATCH</code> - Unsupported dimension of tensors <code>ARM_MATH_SUCCESS</code> - Successful operation <code>ARM_MATH_ARGUMENT_ERROR</code> - Implementation not available</dd></dl>
  354. <ul>
  355. <li>Supported Framework: TensorFlow Lite </li>
  356. </ul>
  357. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#ad935f1ff1a50822e317bdb321ce991ad">MAX</a>, and <a class="el" href="arm__nnsupportfunctions_8h.html#adcd021ac91d43a62b2cdecf9a5b971a7">MIN</a>.</p>
  358. </div>
  359. </div>
  360. <a class="anchor" id="gaca9a9dfa088bec0c4ac16f14518cf6a3"></a>
  361. <div class="memitem">
  362. <div class="memproto">
  363. <table class="memname">
  364. <tr>
  365. <td class="memname">int32_t arm_avgpool_s8_get_buffer_size </td>
  366. <td>(</td>
  367. <td class="paramtype">const int&#160;</td>
  368. <td class="paramname"><em>dim_dst_width</em>, </td>
  369. </tr>
  370. <tr>
  371. <td class="paramkey"></td>
  372. <td></td>
  373. <td class="paramtype">const int&#160;</td>
  374. <td class="paramname"><em>ch_src</em>&#160;</td>
  375. </tr>
  376. <tr>
  377. <td></td>
  378. <td>)</td>
  379. <td></td><td></td>
  380. </tr>
  381. </table>
  382. </div><div class="memdoc">
  383. <dl class="params"><dt>Parameters</dt><dd>
  384. <table class="params">
  385. <tr><td class="paramdir">[in]</td><td class="paramname">dim_dst_width</td><td>output tensor dimension </td></tr>
  386. <tr><td class="paramdir">[in]</td><td class="paramname">ch_src</td><td>number of input tensor channels </td></tr>
  387. </table>
  388. </dd>
  389. </dl>
  390. <dl class="section return"><dt>Returns</dt><dd>The function returns required buffer size </dd></dl>
  391. </div>
  392. </div>
  393. <a class="anchor" id="ga9ba8703e0f24059167f445c978026764"></a>
  394. <div class="memitem">
  395. <div class="memproto">
  396. <table class="memname">
  397. <tr>
  398. <td class="memname">arm_status arm_max_pool_s8 </td>
  399. <td>(</td>
  400. <td class="paramtype">const uint16_t&#160;</td>
  401. <td class="paramname"><em>input_y</em>, </td>
  402. </tr>
  403. <tr>
  404. <td class="paramkey"></td>
  405. <td></td>
  406. <td class="paramtype">const uint16_t&#160;</td>
  407. <td class="paramname"><em>input_x</em>, </td>
  408. </tr>
  409. <tr>
  410. <td class="paramkey"></td>
  411. <td></td>
  412. <td class="paramtype">const uint16_t&#160;</td>
  413. <td class="paramname"><em>output_y</em>, </td>
  414. </tr>
  415. <tr>
  416. <td class="paramkey"></td>
  417. <td></td>
  418. <td class="paramtype">const uint16_t&#160;</td>
  419. <td class="paramname"><em>output_x</em>, </td>
  420. </tr>
  421. <tr>
  422. <td class="paramkey"></td>
  423. <td></td>
  424. <td class="paramtype">const uint16_t&#160;</td>
  425. <td class="paramname"><em>stride_y</em>, </td>
  426. </tr>
  427. <tr>
  428. <td class="paramkey"></td>
  429. <td></td>
  430. <td class="paramtype">const uint16_t&#160;</td>
  431. <td class="paramname"><em>stride_x</em>, </td>
  432. </tr>
  433. <tr>
  434. <td class="paramkey"></td>
  435. <td></td>
  436. <td class="paramtype">const uint16_t&#160;</td>
  437. <td class="paramname"><em>kernel_y</em>, </td>
  438. </tr>
  439. <tr>
  440. <td class="paramkey"></td>
  441. <td></td>
  442. <td class="paramtype">const uint16_t&#160;</td>
  443. <td class="paramname"><em>kernel_x</em>, </td>
  444. </tr>
  445. <tr>
  446. <td class="paramkey"></td>
  447. <td></td>
  448. <td class="paramtype">const uint16_t&#160;</td>
  449. <td class="paramname"><em>pad_y</em>, </td>
  450. </tr>
  451. <tr>
  452. <td class="paramkey"></td>
  453. <td></td>
  454. <td class="paramtype">const uint16_t&#160;</td>
  455. <td class="paramname"><em>pad_x</em>, </td>
  456. </tr>
  457. <tr>
  458. <td class="paramkey"></td>
  459. <td></td>
  460. <td class="paramtype">const int8_t&#160;</td>
  461. <td class="paramname"><em>act_min</em>, </td>
  462. </tr>
  463. <tr>
  464. <td class="paramkey"></td>
  465. <td></td>
  466. <td class="paramtype">const int8_t&#160;</td>
  467. <td class="paramname"><em>act_max</em>, </td>
  468. </tr>
  469. <tr>
  470. <td class="paramkey"></td>
  471. <td></td>
  472. <td class="paramtype">const uint16_t&#160;</td>
  473. <td class="paramname"><em>channel_in</em>, </td>
  474. </tr>
  475. <tr>
  476. <td class="paramkey"></td>
  477. <td></td>
  478. <td class="paramtype">int8_t *&#160;</td>
  479. <td class="paramname"><em>input</em>, </td>
  480. </tr>
  481. <tr>
  482. <td class="paramkey"></td>
  483. <td></td>
  484. <td class="paramtype">int16_t *&#160;</td>
  485. <td class="paramname"><em>tmp_buffer</em>, </td>
  486. </tr>
  487. <tr>
  488. <td class="paramkey"></td>
  489. <td></td>
  490. <td class="paramtype">int8_t *&#160;</td>
  491. <td class="paramname"><em>output</em>&#160;</td>
  492. </tr>
  493. <tr>
  494. <td></td>
  495. <td>)</td>
  496. <td></td><td></td>
  497. </tr>
  498. </table>
  499. </div><div class="memdoc">
  500. <dl class="params"><dt>Parameters</dt><dd>
  501. <table class="params">
  502. <tr><td class="paramdir">[in]</td><td class="paramname">input_y</td><td>input tensor dimension along y </td></tr>
  503. <tr><td class="paramdir">[in]</td><td class="paramname">input_x</td><td>input tensor dimension along x </td></tr>
  504. <tr><td class="paramdir">[in]</td><td class="paramname">output_y</td><td>output tensor dimension along y </td></tr>
  505. <tr><td class="paramdir">[in]</td><td class="paramname">output_x</td><td>output tensor dimension along x </td></tr>
  506. <tr><td class="paramdir">[in]</td><td class="paramname">stride_y</td><td>stride along y </td></tr>
  507. <tr><td class="paramdir">[in]</td><td class="paramname">stride_x</td><td>stride along x </td></tr>
  508. <tr><td class="paramdir">[in]</td><td class="paramname">kernel_y</td><td>filter kernel size along y </td></tr>
  509. <tr><td class="paramdir">[in]</td><td class="paramname">kernel_x</td><td>filter kernel size along x </td></tr>
  510. <tr><td class="paramdir">[in]</td><td class="paramname">pad_y</td><td>padding size along y </td></tr>
  511. <tr><td class="paramdir">[in]</td><td class="paramname">pad_x</td><td>padding size along x </td></tr>
  512. <tr><td class="paramdir">[in]</td><td class="paramname">act_min</td><td>Activation min. Lower limit to clamp output to. Range: int8 </td></tr>
  513. <tr><td class="paramdir">[in]</td><td class="paramname">act_max</td><td>Activation max. Upper limit to clamp output to. Range: int8 </td></tr>
  514. <tr><td class="paramdir">[in]</td><td class="paramname">channel_in</td><td>number of input channels </td></tr>
  515. <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>pointer to input tensor </td></tr>
  516. <tr><td class="paramdir">[in]</td><td class="paramname">tmp_buffer</td><td>Not used. </td></tr>
  517. <tr><td class="paramdir">[in,out]</td><td class="paramname">output</td><td>pointer to output tensor </td></tr>
  518. </table>
  519. </dd>
  520. </dl>
  521. <dl class="section return"><dt>Returns</dt><dd>The function returns one of the following <code>ARM_MATH_SIZE_MISMATCH</code> - Unsupported dimension of tensors <code>ARM_MATH_SUCCESS</code> - Successful operation <code>ARM_MATH_ARGUMENT_ERROR</code> - Implementation not available</dd></dl>
  522. <ul>
  523. <li>This basic implementation is recommended when number of channels is less than 4 and/or dimensions are small. </li>
  524. </ul>
  525. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#ad935f1ff1a50822e317bdb321ce991ad">MAX</a>, and <a class="el" href="arm__nnsupportfunctions_8h.html#adcd021ac91d43a62b2cdecf9a5b971a7">MIN</a>.</p>
  526. <p>Referenced by <a class="el" href="group__Pooling.html#ga692bad3854c43c5b95c48de461ea9100">arm_max_pool_s8_opt()</a>.</p>
  527. </div>
  528. </div>
  529. <a class="anchor" id="ga692bad3854c43c5b95c48de461ea9100"></a>
  530. <div class="memitem">
  531. <div class="memproto">
  532. <table class="memname">
  533. <tr>
  534. <td class="memname">arm_status arm_max_pool_s8_opt </td>
  535. <td>(</td>
  536. <td class="paramtype">const uint16_t&#160;</td>
  537. <td class="paramname"><em>input_y</em>, </td>
  538. </tr>
  539. <tr>
  540. <td class="paramkey"></td>
  541. <td></td>
  542. <td class="paramtype">const uint16_t&#160;</td>
  543. <td class="paramname"><em>input_x</em>, </td>
  544. </tr>
  545. <tr>
  546. <td class="paramkey"></td>
  547. <td></td>
  548. <td class="paramtype">const uint16_t&#160;</td>
  549. <td class="paramname"><em>output_y</em>, </td>
  550. </tr>
  551. <tr>
  552. <td class="paramkey"></td>
  553. <td></td>
  554. <td class="paramtype">const uint16_t&#160;</td>
  555. <td class="paramname"><em>output_x</em>, </td>
  556. </tr>
  557. <tr>
  558. <td class="paramkey"></td>
  559. <td></td>
  560. <td class="paramtype">const uint16_t&#160;</td>
  561. <td class="paramname"><em>stride_y</em>, </td>
  562. </tr>
  563. <tr>
  564. <td class="paramkey"></td>
  565. <td></td>
  566. <td class="paramtype">const uint16_t&#160;</td>
  567. <td class="paramname"><em>stride_x</em>, </td>
  568. </tr>
  569. <tr>
  570. <td class="paramkey"></td>
  571. <td></td>
  572. <td class="paramtype">const uint16_t&#160;</td>
  573. <td class="paramname"><em>kernel_y</em>, </td>
  574. </tr>
  575. <tr>
  576. <td class="paramkey"></td>
  577. <td></td>
  578. <td class="paramtype">const uint16_t&#160;</td>
  579. <td class="paramname"><em>kernel_x</em>, </td>
  580. </tr>
  581. <tr>
  582. <td class="paramkey"></td>
  583. <td></td>
  584. <td class="paramtype">const uint16_t&#160;</td>
  585. <td class="paramname"><em>pad_y</em>, </td>
  586. </tr>
  587. <tr>
  588. <td class="paramkey"></td>
  589. <td></td>
  590. <td class="paramtype">const uint16_t&#160;</td>
  591. <td class="paramname"><em>pad_x</em>, </td>
  592. </tr>
  593. <tr>
  594. <td class="paramkey"></td>
  595. <td></td>
  596. <td class="paramtype">const int8_t&#160;</td>
  597. <td class="paramname"><em>act_min</em>, </td>
  598. </tr>
  599. <tr>
  600. <td class="paramkey"></td>
  601. <td></td>
  602. <td class="paramtype">const int8_t&#160;</td>
  603. <td class="paramname"><em>act_max</em>, </td>
  604. </tr>
  605. <tr>
  606. <td class="paramkey"></td>
  607. <td></td>
  608. <td class="paramtype">const uint16_t&#160;</td>
  609. <td class="paramname"><em>depth</em>, </td>
  610. </tr>
  611. <tr>
  612. <td class="paramkey"></td>
  613. <td></td>
  614. <td class="paramtype">int8_t *&#160;</td>
  615. <td class="paramname"><em>input</em>, </td>
  616. </tr>
  617. <tr>
  618. <td class="paramkey"></td>
  619. <td></td>
  620. <td class="paramtype">int16_t *&#160;</td>
  621. <td class="paramname"><em>tmp_buffer</em>, </td>
  622. </tr>
  623. <tr>
  624. <td class="paramkey"></td>
  625. <td></td>
  626. <td class="paramtype">int8_t *&#160;</td>
  627. <td class="paramname"><em>output</em>&#160;</td>
  628. </tr>
  629. <tr>
  630. <td></td>
  631. <td>)</td>
  632. <td></td><td></td>
  633. </tr>
  634. </table>
  635. </div><div class="memdoc">
  636. <dl class="params"><dt>Parameters</dt><dd>
  637. <table class="params">
  638. <tr><td class="paramdir">[in]</td><td class="paramname">input_y</td><td>input tensor dimension along y </td></tr>
  639. <tr><td class="paramdir">[in]</td><td class="paramname">input_x</td><td>input tensor dimension along x </td></tr>
  640. <tr><td class="paramdir">[in]</td><td class="paramname">output_y</td><td>output tensor dimension along y </td></tr>
  641. <tr><td class="paramdir">[in]</td><td class="paramname">output_x</td><td>output tensor dimension along x </td></tr>
  642. <tr><td class="paramdir">[in]</td><td class="paramname">stride_y</td><td>stride along y </td></tr>
  643. <tr><td class="paramdir">[in]</td><td class="paramname">stride_x</td><td>stride along x </td></tr>
  644. <tr><td class="paramdir">[in]</td><td class="paramname">kernel_y</td><td>filter kernel size along y </td></tr>
  645. <tr><td class="paramdir">[in]</td><td class="paramname">kernel_x</td><td>filter kernel size along x </td></tr>
  646. <tr><td class="paramdir">[in]</td><td class="paramname">pad_y</td><td>padding size along y </td></tr>
  647. <tr><td class="paramdir">[in]</td><td class="paramname">pad_x</td><td>padding size along x </td></tr>
  648. <tr><td class="paramdir">[in]</td><td class="paramname">act_min</td><td>Activation min. Lower limit to clamp output to. Range: int8 </td></tr>
  649. <tr><td class="paramdir">[in]</td><td class="paramname">act_max</td><td>Activation max. Upper limit to clamp output to. Range: int8 </td></tr>
  650. <tr><td class="paramdir">[in]</td><td class="paramname">depth</td><td>number of input channels </td></tr>
  651. <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>pointer to input tensor </td></tr>
  652. <tr><td class="paramdir">[in]</td><td class="paramname">tmp_buffer</td><td>Not used. </td></tr>
  653. <tr><td class="paramdir">[in,out]</td><td class="paramname">output</td><td>pointer to output tensor </td></tr>
  654. </table>
  655. </dd>
  656. </dl>
  657. <dl class="section return"><dt>Returns</dt><dd>The function returns one of the following <code>ARM_MATH_SIZE_MISMATCH</code> - Unsupported dimension of tensors <code>ARM_MATH_SUCCESS</code> - Successful operation <code>ARM_MATH_ARGUMENT_ERROR</code> - Implementation not available </dd></dl>
  658. <dl class="section note"><dt>Note</dt><dd>The input data is corrupted by this function.</dd></dl>
  659. <p>This optimized implementation is recommended when depth is &gt;= 4 and dimensions are large. </p>
  660. <p>References <a class="el" href="group__Pooling.html#ga9ba8703e0f24059167f445c978026764">arm_max_pool_s8()</a>.</p>
  661. </div>
  662. </div>
  663. <a class="anchor" id="ga99afcdcc61eaf429ab3ee823702e44ce"></a>
  664. <div class="memitem">
  665. <div class="memproto">
  666. <table class="memname">
  667. <tr>
  668. <td class="memname">void arm_maxpool_q7_HWC </td>
  669. <td>(</td>
  670. <td class="paramtype">q7_t *&#160;</td>
  671. <td class="paramname"><em>Im_in</em>, </td>
  672. </tr>
  673. <tr>
  674. <td class="paramkey"></td>
  675. <td></td>
  676. <td class="paramtype">const uint16_t&#160;</td>
  677. <td class="paramname"><em>dim_im_in</em>, </td>
  678. </tr>
  679. <tr>
  680. <td class="paramkey"></td>
  681. <td></td>
  682. <td class="paramtype">const uint16_t&#160;</td>
  683. <td class="paramname"><em>ch_im_in</em>, </td>
  684. </tr>
  685. <tr>
  686. <td class="paramkey"></td>
  687. <td></td>
  688. <td class="paramtype">const uint16_t&#160;</td>
  689. <td class="paramname"><em>dim_kernel</em>, </td>
  690. </tr>
  691. <tr>
  692. <td class="paramkey"></td>
  693. <td></td>
  694. <td class="paramtype">const uint16_t&#160;</td>
  695. <td class="paramname"><em>padding</em>, </td>
  696. </tr>
  697. <tr>
  698. <td class="paramkey"></td>
  699. <td></td>
  700. <td class="paramtype">const uint16_t&#160;</td>
  701. <td class="paramname"><em>stride</em>, </td>
  702. </tr>
  703. <tr>
  704. <td class="paramkey"></td>
  705. <td></td>
  706. <td class="paramtype">const uint16_t&#160;</td>
  707. <td class="paramname"><em>dim_im_out</em>, </td>
  708. </tr>
  709. <tr>
  710. <td class="paramkey"></td>
  711. <td></td>
  712. <td class="paramtype">q7_t *&#160;</td>
  713. <td class="paramname"><em>bufferA</em>, </td>
  714. </tr>
  715. <tr>
  716. <td class="paramkey"></td>
  717. <td></td>
  718. <td class="paramtype">q7_t *&#160;</td>
  719. <td class="paramname"><em>Im_out</em>&#160;</td>
  720. </tr>
  721. <tr>
  722. <td></td>
  723. <td>)</td>
  724. <td></td><td></td>
  725. </tr>
  726. </table>
  727. </div><div class="memdoc">
  728. <dl class="params"><dt>Parameters</dt><dd>
  729. <table class="params">
  730. <tr><td class="paramdir">[in,out]</td><td class="paramname">Im_in</td><td>pointer to input tensor </td></tr>
  731. <tr><td class="paramdir">[in]</td><td class="paramname">dim_im_in</td><td>input tensor dimention </td></tr>
  732. <tr><td class="paramdir">[in]</td><td class="paramname">ch_im_in</td><td>number of input tensor channels </td></tr>
  733. <tr><td class="paramdir">[in]</td><td class="paramname">dim_kernel</td><td>filter kernel size </td></tr>
  734. <tr><td class="paramdir">[in]</td><td class="paramname">padding</td><td>padding sizes </td></tr>
  735. <tr><td class="paramdir">[in]</td><td class="paramname">stride</td><td>convolution stride </td></tr>
  736. <tr><td class="paramdir">[in]</td><td class="paramname">dim_im_out</td><td>output tensor dimension </td></tr>
  737. <tr><td class="paramdir">[in,out]</td><td class="paramname">bufferA</td><td>Not used </td></tr>
  738. <tr><td class="paramdir">[in,out]</td><td class="paramname">Im_out</td><td>pointer to output tensor</td></tr>
  739. </table>
  740. </dd>
  741. </dl>
  742. <p>The pooling function is implemented as split x-pooling then y-pooling.</p>
  743. <p>This pooling function is input-destructive. Input data is undefined after calling this function. </p>
  744. <p>Referenced by <a class="el" href="arm__nnexamples__cifar10_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>
  745. </div>
  746. </div>
  747. </div><!-- contents -->
  748. </div><!-- doc-content -->
  749. <!-- start footer part -->
  750. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  751. <ul>
  752. <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.
  753. <!--
  754. <a href="http://www.doxygen.org/index.html">
  755. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  756. -->
  757. </li>
  758. </ul>
  759. </div>
  760. </body>
  761. </html>