documentation/classarm__compute_1_1_pooling_layer_info.xhtml

   1 <!-- HTML header for doxygen 1.8.9.1-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7 <meta name="generator" content="Doxygen 1.8.11"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>ARM Compute Library: PoolingLayerInfo Class Reference</title>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <script type="text/javascript" src="jquery.js"></script>
  12 <script type="text/javascript" src="dynsections.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="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17 <script type="text/javascript">
  18   $(document).ready(initResizable);
  19   $(window).load(resizeHeight);
  20 </script>
  21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  22 <script type="text/javascript" src="search/searchdata.js"></script>
  23 <script type="text/javascript" src="search/search.js"></script>
  24 <script type="text/javascript">
  25   $(document).ready(function() { init_search(); });
  26 </script>
  27 <script type="text/x-mathjax-config">
  28   MathJax.Hub.Config({
  29     extensions: ["tex2jax.js"],
  30     jax: ["input/TeX","output/HTML-CSS"],
  31 });
  32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 56px;">
  41   <td style="padding-left: 0.5em;">
  42    <div id="projectname">ARM Compute Library
  43    &#160;<span id="projectnumber">17.04</span>
  44    </div>
  45   </td>
  46  </tr>
  47  </tbody>
  48 </table>
  49 </div>
  50 <!-- end header part -->
  51 <!-- Generated by Doxygen 1.8.11 -->
  52 <script type="text/javascript">
  53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  54 </script>
  55   <div id="navrow1" class="tabs">
  56     <ul class="tablist">
  57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  58       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  59       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  60       <li><a href="files.xhtml"><span>Files</span></a></li>
  61       <li>
  62         <div id="MSearchBox" class="MSearchBoxInactive">
  63         <span class="left">
  64           <img id="MSearchSelect" src="search/mag_sel.png"
  65                onmouseover="return searchBox.OnSearchSelectShow()"
  66                onmouseout="return searchBox.OnSearchSelectHide()"
  67                alt=""/>
  68           <input type="text" id="MSearchField" value="Search" accesskey="S"
  69                onfocus="searchBox.OnSearchFieldFocus(true)"
  70                onblur="searchBox.OnSearchFieldFocus(false)"
  71                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  72           </span><span class="right">
  73             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  74           </span>
  75         </div>
  76       </li>
  77     </ul>
  78   </div>
  79   <div id="navrow2" class="tabs2">
  80     <ul class="tablist">
  81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  85     </ul>
  86   </div>
  87 </div><!-- top -->
  88 <div id="side-nav" class="ui-resizable side-nav-resizable">
  89   <div id="nav-tree">
  90     <div id="nav-tree-contents">
  91       <div id="nav-sync" class="sync"></div>
  92     </div>
  93   </div>
  94   <div id="splitbar" style="-moz-user-select:none;"
  95        class="ui-resizable-handle">
  96   </div>
  97 </div>
  98 <script type="text/javascript">
  99 $(document).ready(function(){initNavTree('classarm__compute_1_1_pooling_layer_info.xhtml','');});
 100 </script>
 101 <div id="doc-content">
 102 <!-- window showing the filter options -->
 103 <div id="MSearchSelectWindow"
 104      onmouseover="return searchBox.OnSearchSelectShow()"
 105      onmouseout="return searchBox.OnSearchSelectHide()"
 106      onkeydown="return searchBox.OnSearchSelectKey(event)">
 107 </div>
 108
 109 <!-- iframe showing the search results (closed by default) -->
 110 <div id="MSearchResultsWindow">
 111 <iframe src="javascript:void(0)" frameborder="0"
 112         name="MSearchResults" id="MSearchResults">
 113 </iframe>
 114 </div>
 115
 116 <div class="header">
 117   <div class="summary">
 118 <a href="#pub-methods">Public Member Functions</a>  </div>
 119   <div class="headertitle">
 120 <div class="title">PoolingLayerInfo Class Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p>Pooling Layer Information class.
 125  <a href="classarm__compute_1_1_pooling_layer_info.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_types_8h_source.xhtml">Types.h</a>&gt;</code></p>
 128 <table class="memberdecls">
 129 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 130 Public Member Functions</h2></td></tr>
 131 <tr class="memitem:af9d0ef4ba2c2ce9dc650a064484c4647"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pooling_layer_info.xhtml#af9d0ef4ba2c2ce9dc650a064484c4647">PoolingLayerInfo</a> (<a class="el" href="namespacearm__compute.xhtml#a9172da722f0a434e5cc07c0a3c115d93">PoolingType</a> <a class="el" href="classarm__compute_1_1_pooling_layer_info.xhtml#a7e8311a3a774bceb8efae1d5c8c8aeff">pool_type</a>=<a class="el" href="namespacearm__compute.xhtml#adf2ced65e536375a1c96425d9fced858a26a4b44a837bf97b972628509912b4a5">PoolingType::MAX</a>, unsigned int <a class="el" href="classarm__compute_1_1_pooling_layer_info.xhtml#acbe58b96aee21ee986689ebd3d2f6a3c">pool_size</a>=2, <a class="el" href="classarm__compute_1_1_pad_stride_info.xhtml">PadStrideInfo</a> <a class="el" href="classarm__compute_1_1_pooling_layer_info.xhtml#a3c82dfc72060f59eccf0bd096b81c5d5">pad_stride_info</a>=<a class="el" href="classarm__compute_1_1_pad_stride_info.xhtml">PadStrideInfo</a>())</td></tr>
 132 <tr class="memdesc:af9d0ef4ba2c2ce9dc650a064484c4647"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor.  <a href="#af9d0ef4ba2c2ce9dc650a064484c4647">More...</a><br /></td></tr>
 133 <tr class="separator:af9d0ef4ba2c2ce9dc650a064484c4647"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <tr class="memitem:a7e8311a3a774bceb8efae1d5c8c8aeff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute.xhtml#a9172da722f0a434e5cc07c0a3c115d93">PoolingType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pooling_layer_info.xhtml#a7e8311a3a774bceb8efae1d5c8c8aeff">pool_type</a> () const </td></tr>
 135 <tr class="separator:a7e8311a3a774bceb8efae1d5c8c8aeff"><td class="memSeparator" colspan="2">&#160;</td></tr>
 136 <tr class="memitem:acbe58b96aee21ee986689ebd3d2f6a3c"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pooling_layer_info.xhtml#acbe58b96aee21ee986689ebd3d2f6a3c">pool_size</a> () const </td></tr>
 137 <tr class="separator:acbe58b96aee21ee986689ebd3d2f6a3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 <tr class="memitem:a3c82dfc72060f59eccf0bd096b81c5d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_pad_stride_info.xhtml">PadStrideInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pooling_layer_info.xhtml#a3c82dfc72060f59eccf0bd096b81c5d5">pad_stride_info</a> () const </td></tr>
 139 <tr class="separator:a3c82dfc72060f59eccf0bd096b81c5d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 </table>
 141 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 142 <div class="textblock"><p>Pooling Layer Information class. </p>
 143
 144 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00401">401</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
 145 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 146 <a class="anchor" id="af9d0ef4ba2c2ce9dc650a064484c4647"></a>
 147 <div class="memitem">
 148 <div class="memproto">
 149 <table class="mlabels">
 150   <tr>
 151   <td class="mlabels-left">
 152       <table class="memname">
 153         <tr>
 154           <td class="memname"><a class="el" href="classarm__compute_1_1_pooling_layer_info.xhtml">PoolingLayerInfo</a> </td>
 155           <td>(</td>
 156           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a9172da722f0a434e5cc07c0a3c115d93">PoolingType</a>&#160;</td>
 157           <td class="paramname"><em>pool_type</em> = <code><a class="el" href="namespacearm__compute.xhtml#adf2ced65e536375a1c96425d9fced858a26a4b44a837bf97b972628509912b4a5">PoolingType::MAX</a></code>, </td>
 158         </tr>
 159         <tr>
 160           <td class="paramkey"></td>
 161           <td></td>
 162           <td class="paramtype">unsigned int&#160;</td>
 163           <td class="paramname"><em>pool_size</em> = <code>2</code>, </td>
 164         </tr>
 165         <tr>
 166           <td class="paramkey"></td>
 167           <td></td>
 168           <td class="paramtype"><a class="el" href="classarm__compute_1_1_pad_stride_info.xhtml">PadStrideInfo</a>&#160;</td>
 169           <td class="paramname"><em>pad_stride_info</em> = <code><a class="el" href="classarm__compute_1_1_pad_stride_info.xhtml">PadStrideInfo</a>()</code>&#160;</td>
 170         </tr>
 171         <tr>
 172           <td></td>
 173           <td>)</td>
 174           <td></td><td></td>
 175         </tr>
 176       </table>
 177   </td>
 178   <td class="mlabels-right">
 179 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 180   </tr>
 181 </table>
 182 </div><div class="memdoc">
 183
 184 <p>Default Constructor. </p>
 185 <dl class="params"><dt>Parameters</dt><dd>
 186   <table class="params">
 187     <tr><td class="paramdir">[in]</td><td class="paramname">pool_type</td><td>Pooling type <a class="el" href="namespacearm__compute.xhtml#a9172da722f0a434e5cc07c0a3c115d93">PoolingType</a>. Defaults to <a class="el" href="namespacearm__compute.xhtml#adf2ced65e536375a1c96425d9fced858a26a4b44a837bf97b972628509912b4a5">PoolingType::MAX</a> </td></tr>
 188     <tr><td class="paramdir">[in]</td><td class="paramname">pool_size</td><td>(Optional) Pooling size, in elements, across x and y. Defaults to 2. </td></tr>
 189     <tr><td class="paramdir">[in]</td><td class="paramname">pad_stride_info</td><td>(Optional) Padding and stride information <a class="el" href="classarm__compute_1_1_pad_stride_info.xhtml">PadStrideInfo</a> </td></tr>
 190   </table>
 191   </dd>
 192 </dl>
 193
 194 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00410">410</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
 195 <div class="fragment"><div class="line"><a name="l00411"></a><span class="lineno">  411</span>&#160;        : _pool_type(<a class="code" href="classarm__compute_1_1_pooling_layer_info.xhtml#a7e8311a3a774bceb8efae1d5c8c8aeff">pool_type</a>), _pool_size(<a class="code" href="classarm__compute_1_1_pooling_layer_info.xhtml#acbe58b96aee21ee986689ebd3d2f6a3c">pool_size</a>), _pad_stride_info(<a class="code" href="classarm__compute_1_1_pooling_layer_info.xhtml#a3c82dfc72060f59eccf0bd096b81c5d5">pad_stride_info</a>)</div><div class="line"><a name="l00412"></a><span class="lineno">  412</span>&#160;    {</div><div class="line"><a name="l00413"></a><span class="lineno">  413</span>&#160;    }</div><div class="ttc" id="classarm__compute_1_1_pooling_layer_info_xhtml_acbe58b96aee21ee986689ebd3d2f6a3c"><div class="ttname"><a href="classarm__compute_1_1_pooling_layer_info.xhtml#acbe58b96aee21ee986689ebd3d2f6a3c">arm_compute::PoolingLayerInfo::pool_size</a></div><div class="ttdeci">unsigned int pool_size() const </div><div class="ttdef"><b>Definition:</b> <a href="_types_8h_source.xhtml#l00418">Types.h:418</a></div></div>
 196 <div class="ttc" id="classarm__compute_1_1_pooling_layer_info_xhtml_a3c82dfc72060f59eccf0bd096b81c5d5"><div class="ttname"><a href="classarm__compute_1_1_pooling_layer_info.xhtml#a3c82dfc72060f59eccf0bd096b81c5d5">arm_compute::PoolingLayerInfo::pad_stride_info</a></div><div class="ttdeci">PadStrideInfo pad_stride_info() const </div><div class="ttdef"><b>Definition:</b> <a href="_types_8h_source.xhtml#l00422">Types.h:422</a></div></div>
 197 <div class="ttc" id="classarm__compute_1_1_pooling_layer_info_xhtml_a7e8311a3a774bceb8efae1d5c8c8aeff"><div class="ttname"><a href="classarm__compute_1_1_pooling_layer_info.xhtml#a7e8311a3a774bceb8efae1d5c8c8aeff">arm_compute::PoolingLayerInfo::pool_type</a></div><div class="ttdeci">PoolingType pool_type() const </div><div class="ttdef"><b>Definition:</b> <a href="_types_8h_source.xhtml#l00414">Types.h:414</a></div></div>
 198 </div><!-- fragment -->
 199 </div>
 200 </div>
 201 <h2 class="groupheader">Member Function Documentation</h2>
 202 <a class="anchor" id="a3c82dfc72060f59eccf0bd096b81c5d5"></a>
 203 <div class="memitem">
 204 <div class="memproto">
 205 <table class="mlabels">
 206   <tr>
 207   <td class="mlabels-left">
 208       <table class="memname">
 209         <tr>
 210           <td class="memname"><a class="el" href="classarm__compute_1_1_pad_stride_info.xhtml">PadStrideInfo</a> pad_stride_info </td>
 211           <td>(</td>
 212           <td class="paramname"></td><td>)</td>
 213           <td> const</td>
 214         </tr>
 215       </table>
 216   </td>
 217   <td class="mlabels-right">
 218 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 219   </tr>
 220 </table>
 221 </div><div class="memdoc">
 222
 223 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00422">422</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
 224 <div class="fragment"><div class="line"><a name="l00423"></a><span class="lineno">  423</span>&#160;    {</div><div class="line"><a name="l00424"></a><span class="lineno">  424</span>&#160;        <span class="keywordflow">return</span> _pad_stride_info;</div><div class="line"><a name="l00425"></a><span class="lineno">  425</span>&#160;    }</div></div><!-- fragment -->
 225 </div>
 226 </div>
 227 <a class="anchor" id="acbe58b96aee21ee986689ebd3d2f6a3c"></a>
 228 <div class="memitem">
 229 <div class="memproto">
 230 <table class="mlabels">
 231   <tr>
 232   <td class="mlabels-left">
 233       <table class="memname">
 234         <tr>
 235           <td class="memname">unsigned int pool_size </td>
 236           <td>(</td>
 237           <td class="paramname"></td><td>)</td>
 238           <td> const</td>
 239         </tr>
 240       </table>
 241   </td>
 242   <td class="mlabels-right">
 243 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 244   </tr>
 245 </table>
 246 </div><div class="memdoc">
 247
 248 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00418">418</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
 249 <div class="fragment"><div class="line"><a name="l00419"></a><span class="lineno">  419</span>&#160;    {</div><div class="line"><a name="l00420"></a><span class="lineno">  420</span>&#160;        <span class="keywordflow">return</span> _pool_size;</div><div class="line"><a name="l00421"></a><span class="lineno">  421</span>&#160;    }</div></div><!-- fragment -->
 250 </div>
 251 </div>
 252 <a class="anchor" id="a7e8311a3a774bceb8efae1d5c8c8aeff"></a>
 253 <div class="memitem">
 254 <div class="memproto">
 255 <table class="mlabels">
 256   <tr>
 257   <td class="mlabels-left">
 258       <table class="memname">
 259         <tr>
 260           <td class="memname"><a class="el" href="namespacearm__compute.xhtml#a9172da722f0a434e5cc07c0a3c115d93">PoolingType</a> pool_type </td>
 261           <td>(</td>
 262           <td class="paramname"></td><td>)</td>
 263           <td> const</td>
 264         </tr>
 265       </table>
 266   </td>
 267   <td class="mlabels-right">
 268 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 269   </tr>
 270 </table>
 271 </div><div class="memdoc">
 272
 273 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00414">414</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
 274 <div class="fragment"><div class="line"><a name="l00415"></a><span class="lineno">  415</span>&#160;    {</div><div class="line"><a name="l00416"></a><span class="lineno">  416</span>&#160;        <span class="keywordflow">return</span> _pool_type;</div><div class="line"><a name="l00417"></a><span class="lineno">  417</span>&#160;    }</div></div><!-- fragment -->
 275 </div>
 276 </div>
 277 <hr/>The documentation for this class was generated from the following file:<ul>
 278 <li>arm_compute/core/<a class="el" href="_types_8h_source.xhtml">Types.h</a></li>
 279 </ul>
 280 </div><!-- contents -->
 281 </div><!-- doc-content -->
 282 <!-- start footer part -->
 283 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 284   <ul>
 285     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_pooling_layer_info.xhtml">PoolingLayerInfo</a></li>
 286     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
 287     <a href="http://www.doxygen.org/index.html">
 288     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 289   </ul>
 290 </div>
 291 </body>
 292 </html>