322 lines
		
	
	
		
			15 KiB
		
	
	
	
		
			HTML
		
	
	
	
			
		
		
	
	
			322 lines
		
	
	
		
			15 KiB
		
	
	
	
		
			HTML
		
	
	
	
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 | |
| <html xmlns="http://www.w3.org/1999/xhtml">
 | |
| <head>
 | |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 | |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 | |
| <title>Neural Network Pooling Functions</title>
 | |
| <title>CMSIS-NN: Neural Network Pooling Functions</title>
 | |
| <link href="tabs.css" rel="stylesheet" type="text/css"/>
 | |
| <link href="cmsis.css" rel="stylesheet" type="text/css" />
 | |
| <script type="text/javascript" src="jquery.js"></script>
 | |
| <script type="text/javascript" src="dynsections.js"></script>
 | |
| <script type="text/javascript" src="printComponentTabs.js"></script>
 | |
| <link href="navtree.css" rel="stylesheet" type="text/css"/>
 | |
| <script type="text/javascript" src="resize.js"></script>
 | |
| <script type="text/javascript" src="navtree.js"></script>
 | |
| <script type="text/javascript">
 | |
|   $(document).ready(initResizable);
 | |
|   $(window).load(resizeHeight);
 | |
| </script>
 | |
| <link href="search/search.css" rel="stylesheet" type="text/css"/>
 | |
| <script type="text/javascript" src="search/search.js"></script>
 | |
| <script type="text/javascript">
 | |
|   $(document).ready(function() { searchBox.OnSelectItem(0); });
 | |
| </script>
 | |
| </head>
 | |
| <body>
 | |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
 | |
| <div id="titlearea">
 | |
| <table cellspacing="0" cellpadding="0">
 | |
|  <tbody>
 | |
|  <tr style="height: 46px;">
 | |
|   <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
 | |
|   <td style="padding-left: 0.5em;">
 | |
|    <div id="projectname">CMSIS-NN
 | |
|     <span id="projectnumber">Version 1.1.0</span>
 | |
|    </div>
 | |
|    <div id="projectbrief">CMSIS NN Software Library</div>
 | |
|   </td>
 | |
|  </tr>
 | |
|  </tbody>
 | |
| </table>
 | |
| </div>
 | |
| <!-- end header part -->
 | |
| <div id="CMSISnav" class="tabs1">
 | |
|     <ul class="tablist">
 | |
|       <script type="text/javascript">
 | |
| 		<!--
 | |
| 		writeComponentTabs.call(this);
 | |
| 		//-->
 | |
|       </script>
 | |
| 	  </ul>
 | |
| </div>
 | |
| <!-- Generated by Doxygen 1.8.6 -->
 | |
| <script type="text/javascript">
 | |
| var searchBox = new SearchBox("searchBox", "search",false,'Search');
 | |
| </script>
 | |
|   <div id="navrow1" class="tabs">
 | |
|     <ul class="tablist">
 | |
|       <li><a href="index.html"><span>Main Page</span></a></li>
 | |
|       <li><a href="pages.html"><span>Usage and Description</span></a></li>
 | |
|       <li><a href="modules.html"><span>Reference</span></a></li>
 | |
|       <li>
 | |
|         <div id="MSearchBox" class="MSearchBoxInactive">
 | |
|         <span class="left">
 | |
|           <img id="MSearchSelect" src="search/mag_sel.png"
 | |
|                onmouseover="return searchBox.OnSearchSelectShow()"
 | |
|                onmouseout="return searchBox.OnSearchSelectHide()"
 | |
|                alt=""/>
 | |
|           <input type="text" id="MSearchField" value="Search" accesskey="S"
 | |
|                onfocus="searchBox.OnSearchFieldFocus(true)" 
 | |
|                onblur="searchBox.OnSearchFieldFocus(false)" 
 | |
|                onkeyup="searchBox.OnSearchFieldChange(event)"/>
 | |
|           </span><span class="right">
 | |
|             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
 | |
|           </span>
 | |
|         </div>
 | |
|       </li>
 | |
|     </ul>
 | |
|   </div>
 | |
| </div><!-- top -->
 | |
| <div id="side-nav" class="ui-resizable side-nav-resizable">
 | |
|   <div id="nav-tree">
 | |
|     <div id="nav-tree-contents">
 | |
|       <div id="nav-sync" class="sync"></div>
 | |
|     </div>
 | |
|   </div>
 | |
|   <div id="splitbar" style="-moz-user-select:none;" 
 | |
|        class="ui-resizable-handle">
 | |
|   </div>
 | |
| </div>
 | |
| <script type="text/javascript">
 | |
| $(document).ready(function(){initNavTree('group__Pooling.html','');});
 | |
| </script>
 | |
| <div id="doc-content">
 | |
| <!-- window showing the filter options -->
 | |
| <div id="MSearchSelectWindow"
 | |
|      onmouseover="return searchBox.OnSearchSelectShow()"
 | |
|      onmouseout="return searchBox.OnSearchSelectHide()"
 | |
|      onkeydown="return searchBox.OnSearchSelectKey(event)">
 | |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
 | |
| 
 | |
| <!-- iframe showing the search results (closed by default) -->
 | |
| <div id="MSearchResultsWindow">
 | |
| <iframe src="javascript:void(0)" frameborder="0" 
 | |
|         name="MSearchResults" id="MSearchResults">
 | |
| </iframe>
 | |
| </div>
 | |
| 
 | |
| <div class="header">
 | |
|   <div class="summary">
 | |
| <a href="#func-members">Functions</a>  </div>
 | |
|   <div class="headertitle">
 | |
| <div class="title">Neural Network Pooling Functions<div class="ingroups"><a class="el" href="group__groupNN.html">Neural Network Functions</a></div></div>  </div>
 | |
| </div><!--header-->
 | |
| <div class="contents">
 | |
| <table class="memberdecls">
 | |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 | |
| Functions</h2></td></tr>
 | |
| <tr class="memitem:ga99afcdcc61eaf429ab3ee823702e44ce"><td class="memItemLeft" align="right" valign="top">void </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>
 | |
| <tr class="memdesc:ga99afcdcc61eaf429ab3ee823702e44ce"><td class="mdescLeft"> </td><td class="mdescRight">Q7 max pooling function.  <a href="#ga99afcdcc61eaf429ab3ee823702e44ce">More...</a><br/></td></tr>
 | |
| <tr class="separator:ga99afcdcc61eaf429ab3ee823702e44ce"><td class="memSeparator" colspan="2"> </td></tr>
 | |
| <tr class="memitem:gae4a7b07f97ec4313524c9fb9fbcb1f6a"><td class="memItemLeft" align="right" valign="top">void </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>
 | |
| <tr class="memdesc:gae4a7b07f97ec4313524c9fb9fbcb1f6a"><td class="mdescLeft"> </td><td class="mdescRight">Q7 average pooling function.  <a href="#gae4a7b07f97ec4313524c9fb9fbcb1f6a">More...</a><br/></td></tr>
 | |
| <tr class="separator:gae4a7b07f97ec4313524c9fb9fbcb1f6a"><td class="memSeparator" colspan="2"> </td></tr>
 | |
| </table>
 | |
| <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 | |
| <p>Perform pooling functions, including max pooling and average pooling </p>
 | |
| <h2 class="groupheader">Function Documentation</h2>
 | |
| <a class="anchor" id="gae4a7b07f97ec4313524c9fb9fbcb1f6a"></a>
 | |
| <div class="memitem">
 | |
| <div class="memproto">
 | |
|       <table class="memname">
 | |
|         <tr>
 | |
|           <td class="memname">void arm_avepool_q7_HWC </td>
 | |
|           <td>(</td>
 | |
|           <td class="paramtype">q7_t * </td>
 | |
|           <td class="paramname"><em>Im_in</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">const uint16_t </td>
 | |
|           <td class="paramname"><em>dim_im_in</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">const uint16_t </td>
 | |
|           <td class="paramname"><em>ch_im_in</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">const uint16_t </td>
 | |
|           <td class="paramname"><em>dim_kernel</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">const uint16_t </td>
 | |
|           <td class="paramname"><em>padding</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">const uint16_t </td>
 | |
|           <td class="paramname"><em>stride</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">const uint16_t </td>
 | |
|           <td class="paramname"><em>dim_im_out</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">q7_t * </td>
 | |
|           <td class="paramname"><em>bufferA</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">q7_t * </td>
 | |
|           <td class="paramname"><em>Im_out</em> </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td></td>
 | |
|           <td>)</td>
 | |
|           <td></td><td></td>
 | |
|         </tr>
 | |
|       </table>
 | |
| </div><div class="memdoc">
 | |
| <dl class="params"><dt>Parameters</dt><dd>
 | |
|   <table class="params">
 | |
|     <tr><td class="paramdir">[in,out]</td><td class="paramname">Im_in</td><td>pointer to input tensor </td></tr>
 | |
|     <tr><td class="paramdir">[in]</td><td class="paramname">dim_im_in</td><td>input tensor dimention </td></tr>
 | |
|     <tr><td class="paramdir">[in]</td><td class="paramname">ch_im_in</td><td>number of input tensor channels </td></tr>
 | |
|     <tr><td class="paramdir">[in]</td><td class="paramname">dim_kernel</td><td>filter kernel size </td></tr>
 | |
|     <tr><td class="paramdir">[in]</td><td class="paramname">padding</td><td>padding sizes </td></tr>
 | |
|     <tr><td class="paramdir">[in]</td><td class="paramname">stride</td><td>convolution stride </td></tr>
 | |
|     <tr><td class="paramdir">[in]</td><td class="paramname">dim_im_out</td><td>output tensor dimension </td></tr>
 | |
|     <tr><td class="paramdir">[in,out]</td><td class="paramname">bufferA</td><td>pointer to buffer space for input </td></tr>
 | |
|     <tr><td class="paramdir">[in,out]</td><td class="paramname">Im_out</td><td>pointer to output tensor </td></tr>
 | |
|   </table>
 | |
|   </dd>
 | |
| </dl>
 | |
| <dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
 | |
| <p><b>Buffer size:</b></p>
 | |
| <p>bufferA size: 2*dim_im_out*ch_im_in</p>
 | |
| <p>The pooling function is implemented as split x-pooling then y-pooling.</p>
 | |
| <p>This pooling function is input-destructive. Input data is undefined after calling this function. </p>
 | |
| 
 | |
| <p>References <a class="el" href="group__nndata__convert.html#gae349de4dba8d253c89d45794ccf05680">arm_q7_to_q15_no_shift()</a>.</p>
 | |
| 
 | |
| </div>
 | |
| </div>
 | |
| <a class="anchor" id="ga99afcdcc61eaf429ab3ee823702e44ce"></a>
 | |
| <div class="memitem">
 | |
| <div class="memproto">
 | |
|       <table class="memname">
 | |
|         <tr>
 | |
|           <td class="memname">void arm_maxpool_q7_HWC </td>
 | |
|           <td>(</td>
 | |
|           <td class="paramtype">q7_t * </td>
 | |
|           <td class="paramname"><em>Im_in</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">const uint16_t </td>
 | |
|           <td class="paramname"><em>dim_im_in</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">const uint16_t </td>
 | |
|           <td class="paramname"><em>ch_im_in</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">const uint16_t </td>
 | |
|           <td class="paramname"><em>dim_kernel</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">const uint16_t </td>
 | |
|           <td class="paramname"><em>padding</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">const uint16_t </td>
 | |
|           <td class="paramname"><em>stride</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">const uint16_t </td>
 | |
|           <td class="paramname"><em>dim_im_out</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">q7_t * </td>
 | |
|           <td class="paramname"><em>bufferA</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td class="paramkey"></td>
 | |
|           <td></td>
 | |
|           <td class="paramtype">q7_t * </td>
 | |
|           <td class="paramname"><em>Im_out</em> </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td></td>
 | |
|           <td>)</td>
 | |
|           <td></td><td></td>
 | |
|         </tr>
 | |
|       </table>
 | |
| </div><div class="memdoc">
 | |
| <dl class="params"><dt>Parameters</dt><dd>
 | |
|   <table class="params">
 | |
|     <tr><td class="paramdir">[in,out]</td><td class="paramname">Im_in</td><td>pointer to input tensor </td></tr>
 | |
|     <tr><td class="paramdir">[in]</td><td class="paramname">dim_im_in</td><td>input tensor dimention </td></tr>
 | |
|     <tr><td class="paramdir">[in]</td><td class="paramname">ch_im_in</td><td>number of input tensor channels </td></tr>
 | |
|     <tr><td class="paramdir">[in]</td><td class="paramname">dim_kernel</td><td>filter kernel size </td></tr>
 | |
|     <tr><td class="paramdir">[in]</td><td class="paramname">padding</td><td>padding sizes </td></tr>
 | |
|     <tr><td class="paramdir">[in]</td><td class="paramname">stride</td><td>convolution stride </td></tr>
 | |
|     <tr><td class="paramdir">[in]</td><td class="paramname">dim_im_out</td><td>output tensor dimension </td></tr>
 | |
|     <tr><td class="paramdir">[in,out]</td><td class="paramname">bufferA</td><td>pointer to buffer space for input </td></tr>
 | |
|     <tr><td class="paramdir">[in,out]</td><td class="paramname">Im_out</td><td>pointer to output tensor </td></tr>
 | |
|   </table>
 | |
|   </dd>
 | |
| </dl>
 | |
| <dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
 | |
| <p><b>Buffer size:</b></p>
 | |
| <p>bufferA size: 0</p>
 | |
| <p>The pooling function is implemented as split x-pooling then y-pooling.</p>
 | |
| <p>This pooling function is input-destructive. Input data is undefined after calling this function. </p>
 | |
| 
 | |
| <p>Referenced by <a class="el" href="arm__nnexamples__cifar10_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>
 | |
| 
 | |
| </div>
 | |
| </div>
 | |
| </div><!-- contents -->
 | |
| </div><!-- doc-content -->
 | |
| <!-- start footer part -->
 | |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 | |
|   <ul>
 | |
|     <li class="footer">Generated on Wed Aug 1 2018 17:12:32 for CMSIS-NN by Arm Ltd. All rights reserved.
 | |
| 	<!--
 | |
|     <a href="http://www.doxygen.org/index.html">
 | |
|     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
 | |
| 	-->
 | |
| 	</li>
 | |
|   </ul>
 | |
| </div>
 | |
| </body>
 | |
| </html>
 |