documentation/classarm__compute_1_1graph_1_1frontend_1_1_pooling_layer.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>Compute Library: PoolingLayer 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">Compute Library
  43    &#160;<span id="projectnumber">18.05</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="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  61       <li><a href="files.xhtml"><span>Files</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 id="navrow2" class="tabs2">
  81     <ul class="tablist">
  82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  86     </ul>
  87   </div>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 $(document).ready(function(){initNavTree('classarm__compute_1_1graph_1_1frontend_1_1_pooling_layer.xhtml','');});
 101 </script>
 102 <div id="doc-content">
 103 <!-- window showing the filter options -->
 104 <div id="MSearchSelectWindow"
 105      onmouseover="return searchBox.OnSearchSelectShow()"
 106      onmouseout="return searchBox.OnSearchSelectHide()"
 107      onkeydown="return searchBox.OnSearchSelectKey(event)">
 108 </div>
 109
 110 <!-- iframe showing the search results (closed by default) -->
 111 <div id="MSearchResultsWindow">
 112 <iframe src="javascript:void(0)" frameborder="0"
 113         name="MSearchResults" id="MSearchResults">
 114 </iframe>
 115 </div>
 116
 117 <div class="header">
 118   <div class="summary">
 119 <a href="#pub-methods">Public Member Functions</a>  </div>
 120   <div class="headertitle">
 121 <div class="title">PoolingLayer Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Pooling Layer.
 126  <a href="classarm__compute_1_1graph_1_1frontend_1_1_pooling_layer.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_layers_8h_source.xhtml">Layers.h</a>&gt;</code></p>
 129 <div class="dynheader">
 130 Collaboration diagram for PoolingLayer:</div>
 131 <div class="dyncontent">
 132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1graph_1_1frontend_1_1_pooling_layer__coll__graph.svg" width="114" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 133 </div>
 134 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 137 Public Member Functions</h2></td></tr>
 138 <tr class="memitem:a9ad7e9ede84392dee892357377aa1806"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1graph_1_1frontend_1_1_pooling_layer.xhtml#a9ad7e9ede84392dee892357377aa1806">PoolingLayer</a> (PoolingLayerInfo pool_info)</td></tr>
 139 <tr class="memdesc:a9ad7e9ede84392dee892357377aa1806"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a pooling layer.  <a href="#a9ad7e9ede84392dee892357377aa1806">More...</a><br /></td></tr>
 140 <tr class="separator:a9ad7e9ede84392dee892357377aa1806"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:a225fb162b43cbef27d5a1dbd7a51c60d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute_1_1graph.xhtml#a56952a8591a9d8481450ae707ae355e7">NodeID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1graph_1_1frontend_1_1_pooling_layer.xhtml#a225fb162b43cbef27d5a1dbd7a51c60d">create_layer</a> (<a class="el" href="classarm__compute_1_1graph_1_1frontend_1_1_i_stream.xhtml">IStream</a> &amp;s) override</td></tr>
 142 <tr class="memdesc:a225fb162b43cbef27d5a1dbd7a51c60d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create layer and add to the given stream.  <a href="#a225fb162b43cbef27d5a1dbd7a51c60d">More...</a><br /></td></tr>
 143 <tr class="separator:a225fb162b43cbef27d5a1dbd7a51c60d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="inherit_header pub_methods_classarm__compute_1_1graph_1_1frontend_1_1_i_layer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1graph_1_1frontend_1_1_i_layer')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1graph_1_1frontend_1_1_i_layer.xhtml">ILayer</a></td></tr>
 145 <tr class="memitem:a0907bb3524e5dfbe23a0f694b2a55c6a inherit pub_methods_classarm__compute_1_1graph_1_1frontend_1_1_i_layer"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1graph_1_1frontend_1_1_i_layer.xhtml#a0907bb3524e5dfbe23a0f694b2a55c6a">~ILayer</a> ()=default</td></tr>
 146 <tr class="memdesc:a0907bb3524e5dfbe23a0f694b2a55c6a inherit pub_methods_classarm__compute_1_1graph_1_1frontend_1_1_i_layer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a0907bb3524e5dfbe23a0f694b2a55c6a">More...</a><br /></td></tr>
 147 <tr class="separator:a0907bb3524e5dfbe23a0f694b2a55c6a inherit pub_methods_classarm__compute_1_1graph_1_1frontend_1_1_i_layer"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <tr class="memitem:af664a2598e05f8de28fb9f94e3902886 inherit pub_methods_classarm__compute_1_1graph_1_1frontend_1_1_i_layer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1graph_1_1frontend_1_1_i_layer.xhtml">ILayer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1graph_1_1frontend_1_1_i_layer.xhtml#af664a2598e05f8de28fb9f94e3902886">set_name</a> (std::string <a class="el" href="classarm__compute_1_1graph_1_1frontend_1_1_i_layer.xhtml#a324e8c54c4c5161913681a1a52fef959">name</a>)</td></tr>
 149 <tr class="memdesc:af664a2598e05f8de28fb9f94e3902886 inherit pub_methods_classarm__compute_1_1graph_1_1frontend_1_1_i_layer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the name of the layer.  <a href="#af664a2598e05f8de28fb9f94e3902886">More...</a><br /></td></tr>
 150 <tr class="separator:af664a2598e05f8de28fb9f94e3902886 inherit pub_methods_classarm__compute_1_1graph_1_1frontend_1_1_i_layer"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 <tr class="memitem:a324e8c54c4c5161913681a1a52fef959 inherit pub_methods_classarm__compute_1_1graph_1_1frontend_1_1_i_layer"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1graph_1_1frontend_1_1_i_layer.xhtml#a324e8c54c4c5161913681a1a52fef959">name</a> () const </td></tr>
 152 <tr class="memdesc:a324e8c54c4c5161913681a1a52fef959 inherit pub_methods_classarm__compute_1_1graph_1_1frontend_1_1_i_layer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Layer name accessor.  <a href="#a324e8c54c4c5161913681a1a52fef959">More...</a><br /></td></tr>
 153 <tr class="separator:a324e8c54c4c5161913681a1a52fef959 inherit pub_methods_classarm__compute_1_1graph_1_1frontend_1_1_i_layer"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 </table>
 155 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 156 <div class="textblock"><p>Pooling Layer. </p>
 157
 158 <p>Definition at line <a class="el" href="_layers_8h_source.xhtml#l00336">336</a> of file <a class="el" href="_layers_8h_source.xhtml">Layers.h</a>.</p>
 159 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 160 <a class="anchor" id="a9ad7e9ede84392dee892357377aa1806"></a>
 161 <div class="memitem">
 162 <div class="memproto">
 163 <table class="mlabels">
 164   <tr>
 165   <td class="mlabels-left">
 166       <table class="memname">
 167         <tr>
 168           <td class="memname"><a class="el" href="classarm__compute_1_1graph_1_1frontend_1_1_pooling_layer.xhtml">PoolingLayer</a> </td>
 169           <td>(</td>
 170           <td class="paramtype">PoolingLayerInfo&#160;</td>
 171           <td class="paramname"><em>pool_info</em></td><td>)</td>
 172           <td></td>
 173         </tr>
 174       </table>
 175   </td>
 176   <td class="mlabels-right">
 177 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 178   </tr>
 179 </table>
 180 </div><div class="memdoc">
 181
 182 <p>Construct a pooling layer. </p>
 183 <dl class="params"><dt>Parameters</dt><dd>
 184   <table class="params">
 185     <tr><td class="paramdir">[in]</td><td class="paramname">pool_info</td><td>Pooling information. </td></tr>
 186   </table>
 187   </dd>
 188 </dl>
 189
 190 <p>Definition at line <a class="el" href="_layers_8h_source.xhtml#l00343">343</a> of file <a class="el" href="_layers_8h_source.xhtml">Layers.h</a>.</p>
 191 <div class="fragment"><div class="line"><a name="l00344"></a><span class="lineno">  344</span>&#160;        : _pool_info(pool_info)</div><div class="line"><a name="l00345"></a><span class="lineno">  345</span>&#160;    {</div><div class="line"><a name="l00346"></a><span class="lineno">  346</span>&#160;    }</div></div><!-- fragment -->
 192 </div>
 193 </div>
 194 <h2 class="groupheader">Member Function Documentation</h2>
 195 <a class="anchor" id="a225fb162b43cbef27d5a1dbd7a51c60d"></a>
 196 <div class="memitem">
 197 <div class="memproto">
 198 <table class="mlabels">
 199   <tr>
 200   <td class="mlabels-left">
 201       <table class="memname">
 202         <tr>
 203           <td class="memname"><a class="el" href="namespacearm__compute_1_1graph.xhtml#a56952a8591a9d8481450ae707ae355e7">NodeID</a> create_layer </td>
 204           <td>(</td>
 205           <td class="paramtype"><a class="el" href="classarm__compute_1_1graph_1_1frontend_1_1_i_stream.xhtml">IStream</a> &amp;&#160;</td>
 206           <td class="paramname"><em>s</em></td><td>)</td>
 207           <td></td>
 208         </tr>
 209       </table>
 210   </td>
 211   <td class="mlabels-right">
 212 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 213   </tr>
 214 </table>
 215 </div><div class="memdoc">
 216
 217 <p>Create layer and add to the given stream. </p>
 218 <dl class="params"><dt>Parameters</dt><dd>
 219   <table class="params">
 220     <tr><td class="paramdir">[in]</td><td class="paramname">s</td><td><a class="el" href="classarm__compute_1_1graph_1_1frontend_1_1_stream.xhtml" title="Stream frontend class to construct simple graphs in a stream fashion. ">Stream</a> to add layer to.</td></tr>
 221   </table>
 222   </dd>
 223 </dl>
 224 <dl class="section return"><dt>Returns</dt><dd>ID of the created node. </dd></dl>
 225
 226 <p>Implements <a class="el" href="classarm__compute_1_1graph_1_1frontend_1_1_i_layer.xhtml#afd0f42ef97e62ef3b6849bcbb8a7533a">ILayer</a>.</p>
 227
 228 <p>Definition at line <a class="el" href="_layers_8h_source.xhtml#l00348">348</a> of file <a class="el" href="_layers_8h_source.xhtml">Layers.h</a>.</p>
 229
 230 <p>References <a class="el" href="classarm__compute_1_1graph_1_1_graph_builder.xhtml#af8eae85804c35bc91d26fe28efc3936a">GraphBuilder::add_pooling_node()</a>, <a class="el" href="classarm__compute_1_1graph_1_1frontend_1_1_i_stream.xhtml#a2f9edb3a23ff98069aaa52590d53bf5f">IStream::graph()</a>, <a class="el" href="_i_stream_8h_source.xhtml#l00073">IStream::hints()</a>, <a class="el" href="_i_layer_8h_source.xhtml#l00064">ILayer::name()</a>, <a class="el" href="_i_stream_8h_source.xhtml#l00065">IStream::tail_node()</a>, and <a class="el" href="arm__compute_2graph_2frontend_2_types_8h_source.xhtml#l00064">StreamHints::target_hint</a>.</p>
 231 <div class="fragment"><div class="line"><a name="l00349"></a><span class="lineno">  349</span>&#160;    {</div><div class="line"><a name="l00350"></a><span class="lineno">  350</span>&#160;        NodeParams  common_params = { <a class="code" href="classarm__compute_1_1graph_1_1frontend_1_1_i_layer.xhtml#a324e8c54c4c5161913681a1a52fef959">name</a>(), s.hints().target_hint };</div><div class="line"><a name="l00351"></a><span class="lineno">  351</span>&#160;        NodeIdxPair input         = { s.tail_node(), 0 };</div><div class="line"><a name="l00352"></a><span class="lineno">  352</span>&#160;        <span class="keywordflow">return</span> <a class="code" href="classarm__compute_1_1graph_1_1_graph_builder.xhtml#af8eae85804c35bc91d26fe28efc3936a">GraphBuilder::add_pooling_node</a>(s.graph(), common_params, input, _pool_info);</div><div class="line"><a name="l00353"></a><span class="lineno">  353</span>&#160;    }</div><div class="ttc" id="classarm__compute_1_1graph_1_1frontend_1_1_i_layer_xhtml_a324e8c54c4c5161913681a1a52fef959"><div class="ttname"><a href="classarm__compute_1_1graph_1_1frontend_1_1_i_layer.xhtml#a324e8c54c4c5161913681a1a52fef959">arm_compute::graph::frontend::ILayer::name</a></div><div class="ttdeci">const std::string &amp; name() const </div><div class="ttdoc">Layer name accessor. </div><div class="ttdef"><b>Definition:</b> <a href="_i_layer_8h_source.xhtml#l00064">ILayer.h:64</a></div></div>
 232 <div class="ttc" id="classarm__compute_1_1graph_1_1_graph_builder_xhtml_af8eae85804c35bc91d26fe28efc3936a"><div class="ttname"><a href="classarm__compute_1_1graph_1_1_graph_builder.xhtml#af8eae85804c35bc91d26fe28efc3936a">arm_compute::graph::GraphBuilder::add_pooling_node</a></div><div class="ttdeci">static NodeID add_pooling_node(Graph &amp;g, NodeParams params, NodeIdxPair input, PoolingLayerInfo pool_info)</div><div class="ttdoc">Adds a pooling layer node to the graph. </div></div>
 233 </div><!-- fragment -->
 234 </div>
 235 </div>
 236 <hr/>The documentation for this class was generated from the following file:<ul>
 237 <li>arm_compute/graph/frontend/<a class="el" href="_layers_8h_source.xhtml">Layers.h</a></li>
 238 </ul>
 239 </div><!-- contents -->
 240 </div><!-- doc-content -->
 241 <!-- start footer part -->
 242 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 243   <ul>
 244     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1graph.xhtml">graph</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1graph_1_1frontend.xhtml">frontend</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1graph_1_1frontend_1_1_pooling_layer.xhtml">PoolingLayer</a></li>
 245     <li class="footer">Generated on Wed May 23 2018 11:36:43 for Compute Library by
 246     <a href="http://www.doxygen.org/index.html">
 247     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 248   </ul>
 249 </div>
 250 </body>
 251 </html>