arm_compute v18.03
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_n_e_pooling_layer_kernel.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: NEPoolingLayerKernel 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.03</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_1_n_e_pooling_layer_kernel.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> &#124;
120 <a href="#pub-static-methods">Static Public Member Functions</a>  </div>
121   <div class="headertitle">
122 <div class="title">NEPoolingLayerKernel Class Reference</div>  </div>
123 </div><!--header-->
124 <div class="contents">
125
126 <p>Interface for the pooling layer kernel.  
127  <a href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#details">More...</a></p>
128
129 <p><code>#include &lt;<a class="el" href="_n_e_pooling_layer_kernel_8h_source.xhtml">NEPoolingLayerKernel.h</a>&gt;</code></p>
130 <div class="dynheader">
131 Collaboration diagram for NEPoolingLayerKernel:</div>
132 <div class="dyncontent">
133 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_pooling_layer_kernel__coll__graph.svg" width="171" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
134 </div>
135 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
136 <table class="memberdecls">
137 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
138 Public Member Functions</h2></td></tr>
139 <tr class="memitem:ab5656bb5b6334bdbe6e606c715872828"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#ab5656bb5b6334bdbe6e606c715872828">name</a> () const override</td></tr>
140 <tr class="memdesc:ab5656bb5b6334bdbe6e606c715872828"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the kernel.  <a href="#ab5656bb5b6334bdbe6e606c715872828">More...</a><br /></td></tr>
141 <tr class="separator:ab5656bb5b6334bdbe6e606c715872828"><td class="memSeparator" colspan="2">&#160;</td></tr>
142 <tr class="memitem:a580a7925065fd33f5e7e12425769edd1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#a580a7925065fd33f5e7e12425769edd1">NEPoolingLayerKernel</a> ()</td></tr>
143 <tr class="memdesc:a580a7925065fd33f5e7e12425769edd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a580a7925065fd33f5e7e12425769edd1">More...</a><br /></td></tr>
144 <tr class="separator:a580a7925065fd33f5e7e12425769edd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
145 <tr class="memitem:a8002aba3f59c078c9899ad236ba67174"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#a8002aba3f59c078c9899ad236ba67174">NEPoolingLayerKernel</a> (const <a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a> &amp;)=delete</td></tr>
146 <tr class="memdesc:a8002aba3f59c078c9899ad236ba67174"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a8002aba3f59c078c9899ad236ba67174">More...</a><br /></td></tr>
147 <tr class="separator:a8002aba3f59c078c9899ad236ba67174"><td class="memSeparator" colspan="2">&#160;</td></tr>
148 <tr class="memitem:a1729479f9686c64edfd1a4af834d634b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#a1729479f9686c64edfd1a4af834d634b">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a> &amp;)=delete</td></tr>
149 <tr class="memdesc:a1729479f9686c64edfd1a4af834d634b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a1729479f9686c64edfd1a4af834d634b">More...</a><br /></td></tr>
150 <tr class="separator:a1729479f9686c64edfd1a4af834d634b"><td class="memSeparator" colspan="2">&#160;</td></tr>
151 <tr class="memitem:ab35670d771933fa900a8cccae52cc0dd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#ab35670d771933fa900a8cccae52cc0dd">NEPoolingLayerKernel</a> (<a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a> &amp;&amp;)=default</td></tr>
152 <tr class="memdesc:ab35670d771933fa900a8cccae52cc0dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#ab35670d771933fa900a8cccae52cc0dd">More...</a><br /></td></tr>
153 <tr class="separator:ab35670d771933fa900a8cccae52cc0dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
154 <tr class="memitem:a0e9871f265535f65226b65ae64ab2cfb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#a0e9871f265535f65226b65ae64ab2cfb">operator=</a> (<a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a> &amp;&amp;)=default</td></tr>
155 <tr class="memdesc:a0e9871f265535f65226b65ae64ab2cfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a0e9871f265535f65226b65ae64ab2cfb">More...</a><br /></td></tr>
156 <tr class="separator:a0e9871f265535f65226b65ae64ab2cfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
157 <tr class="memitem:a3ce56b044278a877edbef5cff1768124"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#a3ce56b044278a877edbef5cff1768124">~NEPoolingLayerKernel</a> ()=default</td></tr>
158 <tr class="memdesc:a3ce56b044278a877edbef5cff1768124"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a3ce56b044278a877edbef5cff1768124">More...</a><br /></td></tr>
159 <tr class="separator:a3ce56b044278a877edbef5cff1768124"><td class="memSeparator" colspan="2">&#160;</td></tr>
160 <tr class="memitem:acfc7162ac184ca219f917d039c58233c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#acfc7162ac184ca219f917d039c58233c">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output, const <a class="el" href="classarm__compute_1_1_pooling_layer_info.xhtml">PoolingLayerInfo</a> &amp;pool_info)</td></tr>
161 <tr class="memdesc:acfc7162ac184ca219f917d039c58233c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the input and output tensors.  <a href="#acfc7162ac184ca219f917d039c58233c">More...</a><br /></td></tr>
162 <tr class="separator:acfc7162ac184ca219f917d039c58233c"><td class="memSeparator" colspan="2">&#160;</td></tr>
163 <tr class="memitem:a112b35dd205c62ea6ed1447ef226da82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">run</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>, const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;info) override</td></tr>
164 <tr class="memdesc:a112b35dd205c62ea6ed1447ef226da82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the kernel on the passed window.  <a href="#a112b35dd205c62ea6ed1447ef226da82">More...</a><br /></td></tr>
165 <tr class="separator:a112b35dd205c62ea6ed1447ef226da82"><td class="memSeparator" colspan="2">&#160;</td></tr>
166 <tr class="memitem:a423f9a45a52983b4de5e2b347f4369c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#a423f9a45a52983b4de5e2b347f4369c7">border_size</a> () const override</td></tr>
167 <tr class="memdesc:a423f9a45a52983b4de5e2b347f4369c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the border for that kernel.  <a href="#a423f9a45a52983b4de5e2b347f4369c7">More...</a><br /></td></tr>
168 <tr class="separator:a423f9a45a52983b4de5e2b347f4369c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
169 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_p_p_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a></td></tr>
170 <tr class="memitem:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a033d17a97e07cea7fe83eefcf23540f6">~ICPPKernel</a> ()=default</td></tr>
171 <tr class="memdesc:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a033d17a97e07cea7fe83eefcf23540f6">More...</a><br /></td></tr>
172 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
173 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml">IKernel</a></td></tr>
174 <tr class="memitem:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a7250cb8cbaa4104a93a2d77155085507">IKernel</a> ()</td></tr>
175 <tr class="memdesc:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a7250cb8cbaa4104a93a2d77155085507">More...</a><br /></td></tr>
176 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
177 <tr class="memitem:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a341b60d15a5e12a5b8f3825194dd3b12">~IKernel</a> ()=default</td></tr>
178 <tr class="memdesc:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a341b60d15a5e12a5b8f3825194dd3b12">More...</a><br /></td></tr>
179 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
180 <tr class="memitem:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a">is_parallelisable</a> () const </td></tr>
181 <tr class="memdesc:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether or not the kernel is parallelisable.  <a href="#abfab8f0d4928e1081d9f65b77933e24a">More...</a><br /></td></tr>
182 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
183 <tr class="memitem:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a> () const </td></tr>
184 <tr class="memdesc:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum window the kernel can be executed on.  <a href="#a3f5646133956f06348b310ccc3d36353">More...</a><br /></td></tr>
185 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
186 </table><table class="memberdecls">
187 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
188 Static Public Member Functions</h2></td></tr>
189 <tr class="memitem:aef4f19189a247ce133811ae59ab556e1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarm__compute_1_1_status.xhtml">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#aef4f19189a247ce133811ae59ab556e1">validate</a> (const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *input, const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *output, const <a class="el" href="classarm__compute_1_1_pooling_layer_info.xhtml">PoolingLayerInfo</a> &amp;pool_info)</td></tr>
190 <tr class="memdesc:aef4f19189a247ce133811ae59ab556e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static function to check if given info will lead to a valid configuration of <a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a>.  <a href="#aef4f19189a247ce133811ae59ab556e1">More...</a><br /></td></tr>
191 <tr class="separator:aef4f19189a247ce133811ae59ab556e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
192 </table>
193 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
194 <div class="textblock"><p>Interface for the pooling layer kernel. </p>
195
196 <p>Definition at line <a class="el" href="_n_e_pooling_layer_kernel_8h_source.xhtml#l00034">34</a> of file <a class="el" href="_n_e_pooling_layer_kernel_8h_source.xhtml">NEPoolingLayerKernel.h</a>.</p>
197 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
198 <a class="anchor" id="a580a7925065fd33f5e7e12425769edd1"></a>
199 <div class="memitem">
200 <div class="memproto">
201       <table class="memname">
202         <tr>
203           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a> </td>
204           <td>(</td>
205           <td class="paramname"></td><td>)</td>
206           <td></td>
207         </tr>
208       </table>
209 </div><div class="memdoc">
210
211 <p>Default constructor. </p>
212
213 <p>Referenced by <a class="el" href="_n_e_pooling_layer_kernel_8h_source.xhtml#l00037">NEPoolingLayerKernel::name()</a>.</p>
214
215 </div>
216 </div>
217 <a class="anchor" id="a8002aba3f59c078c9899ad236ba67174"></a>
218 <div class="memitem">
219 <div class="memproto">
220 <table class="mlabels">
221   <tr>
222   <td class="mlabels-left">
223       <table class="memname">
224         <tr>
225           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a> </td>
226           <td>(</td>
227           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a> &amp;&#160;</td>
228           <td class="paramname"></td><td>)</td>
229           <td></td>
230         </tr>
231       </table>
232   </td>
233   <td class="mlabels-right">
234 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
235   </tr>
236 </table>
237 </div><div class="memdoc">
238
239 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
240
241 </div>
242 </div>
243 <a class="anchor" id="ab35670d771933fa900a8cccae52cc0dd"></a>
244 <div class="memitem">
245 <div class="memproto">
246 <table class="mlabels">
247   <tr>
248   <td class="mlabels-left">
249       <table class="memname">
250         <tr>
251           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a> </td>
252           <td>(</td>
253           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a> &amp;&amp;&#160;</td>
254           <td class="paramname"></td><td>)</td>
255           <td></td>
256         </tr>
257       </table>
258   </td>
259   <td class="mlabels-right">
260 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
261   </tr>
262 </table>
263 </div><div class="memdoc">
264
265 <p>Allow instances of this class to be moved. </p>
266
267 </div>
268 </div>
269 <a class="anchor" id="a3ce56b044278a877edbef5cff1768124"></a>
270 <div class="memitem">
271 <div class="memproto">
272 <table class="mlabels">
273   <tr>
274   <td class="mlabels-left">
275       <table class="memname">
276         <tr>
277           <td class="memname">~<a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a> </td>
278           <td>(</td>
279           <td class="paramname"></td><td>)</td>
280           <td></td>
281         </tr>
282       </table>
283   </td>
284   <td class="mlabels-right">
285 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
286   </tr>
287 </table>
288 </div><div class="memdoc">
289
290 <p>Default destructor. </p>
291
292 <p>Referenced by <a class="el" href="_n_e_pooling_layer_kernel_8h_source.xhtml#l00037">NEPoolingLayerKernel::name()</a>.</p>
293
294 </div>
295 </div>
296 <h2 class="groupheader">Member Function Documentation</h2>
297 <a class="anchor" id="a423f9a45a52983b4de5e2b347f4369c7"></a>
298 <div class="memitem">
299 <div class="memproto">
300 <table class="mlabels">
301   <tr>
302   <td class="mlabels-left">
303       <table class="memname">
304         <tr>
305           <td class="memname"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> border_size </td>
306           <td>(</td>
307           <td class="paramname"></td><td>)</td>
308           <td> const</td>
309         </tr>
310       </table>
311   </td>
312   <td class="mlabels-right">
313 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
314   </tr>
315 </table>
316 </div><div class="memdoc">
317
318 <p>The size of the border for that kernel. </p>
319 <dl class="section return"><dt>Returns</dt><dd>The width in number of elements of the border. </dd></dl>
320
321 <p>Reimplemented from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">IKernel</a>.</p>
322
323 <p>Referenced by <a class="el" href="_n_e_pooling_layer_kernel_8h_source.xhtml#l00037">NEPoolingLayerKernel::name()</a>.</p>
324
325 </div>
326 </div>
327 <a class="anchor" id="acfc7162ac184ca219f917d039c58233c"></a>
328 <div class="memitem">
329 <div class="memproto">
330       <table class="memname">
331         <tr>
332           <td class="memname">void configure </td>
333           <td>(</td>
334           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
335           <td class="paramname"><em>input</em>, </td>
336         </tr>
337         <tr>
338           <td class="paramkey"></td>
339           <td></td>
340           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
341           <td class="paramname"><em>output</em>, </td>
342         </tr>
343         <tr>
344           <td class="paramkey"></td>
345           <td></td>
346           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_pooling_layer_info.xhtml">PoolingLayerInfo</a> &amp;&#160;</td>
347           <td class="paramname"><em>pool_info</em>&#160;</td>
348         </tr>
349         <tr>
350           <td></td>
351           <td>)</td>
352           <td></td><td></td>
353         </tr>
354       </table>
355 </div><div class="memdoc">
356
357 <p>Set the input and output tensors. </p>
358 <dl class="section note"><dt>Note</dt><dd>QS8, QS16 and F16 are supported for pool sizes 2 and 3 only</dd></dl>
359 <dl class="params"><dt>Parameters</dt><dd>
360   <table class="params">
361     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor. Data types supported: QS8/QASYMM8/QS16/F16/F32. </td></tr>
362     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination tensor. Data types supported: Same as <code>input</code>. </td></tr>
363     <tr><td class="paramdir">[in]</td><td class="paramname">pool_info</td><td>Contains pooling operation information described in <a class="el" href="classarm__compute_1_1_pooling_layer_info.xhtml">PoolingLayerInfo</a>. </td></tr>
364   </table>
365   </dd>
366 </dl>
367
368 <p>Referenced by <a class="el" href="_n_e_pooling_layer_kernel_8h_source.xhtml#l00037">NEPoolingLayerKernel::name()</a>.</p>
369
370 </div>
371 </div>
372 <a class="anchor" id="ab5656bb5b6334bdbe6e606c715872828"></a>
373 <div class="memitem">
374 <div class="memproto">
375 <table class="mlabels">
376   <tr>
377   <td class="mlabels-left">
378       <table class="memname">
379         <tr>
380           <td class="memname">const char* name </td>
381           <td>(</td>
382           <td class="paramname"></td><td>)</td>
383           <td> const</td>
384         </tr>
385       </table>
386   </td>
387   <td class="mlabels-right">
388 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
389   </tr>
390 </table>
391 </div><div class="memdoc">
392
393 <p>Name of the kernel. </p>
394 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> name </dd></dl>
395
396 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a1a30ad8f276a2310571c36239554831a">ICPPKernel</a>.</p>
397
398 <p>Definition at line <a class="el" href="_n_e_pooling_layer_kernel_8h_source.xhtml#l00037">37</a> of file <a class="el" href="_n_e_pooling_layer_kernel_8h_source.xhtml">NEPoolingLayerKernel.h</a>.</p>
399
400 <p>References <a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#a423f9a45a52983b4de5e2b347f4369c7">NEPoolingLayerKernel::border_size()</a>, <a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#acfc7162ac184ca219f917d039c58233c">NEPoolingLayerKernel::configure()</a>, <a class="el" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">arm_compute::test::validation::info()</a>, <a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#a580a7925065fd33f5e7e12425769edd1">NEPoolingLayerKernel::NEPoolingLayerKernel()</a>, <a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#a1729479f9686c64edfd1a4af834d634b">NEPoolingLayerKernel::operator=()</a>, <a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">NEPoolingLayerKernel::run()</a>, <a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#aef4f19189a247ce133811ae59ab556e1">NEPoolingLayerKernel::validate()</a>, <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">IKernel::window()</a>, and <a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml#a3ce56b044278a877edbef5cff1768124">NEPoolingLayerKernel::~NEPoolingLayerKernel()</a>.</p>
401 <div class="fragment"><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    {</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;        <span class="keywordflow">return</span> <span class="stringliteral">&quot;NEPoolingLayerKernel&quot;</span>;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    }</div></div><!-- fragment -->
402 </div>
403 </div>
404 <a class="anchor" id="a1729479f9686c64edfd1a4af834d634b"></a>
405 <div class="memitem">
406 <div class="memproto">
407 <table class="mlabels">
408   <tr>
409   <td class="mlabels-left">
410       <table class="memname">
411         <tr>
412           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a>&amp; operator= </td>
413           <td>(</td>
414           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a> &amp;&#160;</td>
415           <td class="paramname"></td><td>)</td>
416           <td></td>
417         </tr>
418       </table>
419   </td>
420   <td class="mlabels-right">
421 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
422   </tr>
423 </table>
424 </div><div class="memdoc">
425
426 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
427
428 <p>Referenced by <a class="el" href="_n_e_pooling_layer_kernel_8h_source.xhtml#l00037">NEPoolingLayerKernel::name()</a>.</p>
429
430 </div>
431 </div>
432 <a class="anchor" id="a0e9871f265535f65226b65ae64ab2cfb"></a>
433 <div class="memitem">
434 <div class="memproto">
435 <table class="mlabels">
436   <tr>
437   <td class="mlabels-left">
438       <table class="memname">
439         <tr>
440           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a>&amp; operator= </td>
441           <td>(</td>
442           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a> &amp;&amp;&#160;</td>
443           <td class="paramname"></td><td>)</td>
444           <td></td>
445         </tr>
446       </table>
447   </td>
448   <td class="mlabels-right">
449 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
450   </tr>
451 </table>
452 </div><div class="memdoc">
453
454 <p>Allow instances of this class to be moved. </p>
455
456 </div>
457 </div>
458 <a class="anchor" id="a112b35dd205c62ea6ed1447ef226da82"></a>
459 <div class="memitem">
460 <div class="memproto">
461 <table class="mlabels">
462   <tr>
463   <td class="mlabels-left">
464       <table class="memname">
465         <tr>
466           <td class="memname">void run </td>
467           <td>(</td>
468           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
469           <td class="paramname"><em>window</em>, </td>
470         </tr>
471         <tr>
472           <td class="paramkey"></td>
473           <td></td>
474           <td class="paramtype">const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;&#160;</td>
475           <td class="paramname"><em>info</em>&#160;</td>
476         </tr>
477         <tr>
478           <td></td>
479           <td>)</td>
480           <td></td><td></td>
481         </tr>
482       </table>
483   </td>
484   <td class="mlabels-right">
485 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
486   </tr>
487 </table>
488 </div><div class="memdoc">
489
490 <p>Execute the kernel on the passed window. </p>
491 <dl class="section warning"><dt>Warning</dt><dd>If <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a" title="Indicates whether or not the kernel is parallelisable. ">is_parallelisable()</a> returns false then the passed window must be equal to <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a></dd></dl>
492 <dl class="section note"><dt>Note</dt><dd>The window has to be a region within the window returned by the <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a> method</dd>
493 <dd>
494 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
495 <dl class="params"><dt>Parameters</dt><dd>
496   <table class="params">
497     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>Region on which to execute the kernel. (Must be a region of the window returned by <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a>) </td></tr>
498     <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>Info about executing thread and CPU. </td></tr>
499   </table>
500   </dd>
501 </dl>
502
503 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#af814ff5e96f40f1cccf809b2b4ee19ef">ICPPKernel</a>.</p>
504
505 <p>Referenced by <a class="el" href="_n_e_pooling_layer_kernel_8h_source.xhtml#l00037">NEPoolingLayerKernel::name()</a>.</p>
506
507 </div>
508 </div>
509 <a class="anchor" id="aef4f19189a247ce133811ae59ab556e1"></a>
510 <div class="memitem">
511 <div class="memproto">
512 <table class="mlabels">
513   <tr>
514   <td class="mlabels-left">
515       <table class="memname">
516         <tr>
517           <td class="memname">static <a class="el" href="classarm__compute_1_1_status.xhtml">Status</a> validate </td>
518           <td>(</td>
519           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
520           <td class="paramname"><em>input</em>, </td>
521         </tr>
522         <tr>
523           <td class="paramkey"></td>
524           <td></td>
525           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
526           <td class="paramname"><em>output</em>, </td>
527         </tr>
528         <tr>
529           <td class="paramkey"></td>
530           <td></td>
531           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_pooling_layer_info.xhtml">PoolingLayerInfo</a> &amp;&#160;</td>
532           <td class="paramname"><em>pool_info</em>&#160;</td>
533         </tr>
534         <tr>
535           <td></td>
536           <td>)</td>
537           <td></td><td></td>
538         </tr>
539       </table>
540   </td>
541   <td class="mlabels-right">
542 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
543   </tr>
544 </table>
545 </div><div class="memdoc">
546
547 <p>Static function to check if given info will lead to a valid configuration of <a class="el" href="classarm__compute_1_1_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a>. </p>
548 <dl class="section note"><dt>Note</dt><dd>QS8, QS16 and F16 are supported for pool sizes 2 and 3 only</dd></dl>
549 <dl class="params"><dt>Parameters</dt><dd>
550   <table class="params">
551     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor. Data types supported: QS8/QASYMM8/QS16/F16/F32. </td></tr>
552     <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>Destination tensor. Data types supported: Same as <code>input</code>. </td></tr>
553     <tr><td class="paramdir">[in]</td><td class="paramname">pool_info</td><td>Contains pooling operation information described in <a class="el" href="classarm__compute_1_1_pooling_layer_info.xhtml">PoolingLayerInfo</a>.</td></tr>
554   </table>
555   </dd>
556 </dl>
557 <dl class="section return"><dt>Returns</dt><dd>a status </dd></dl>
558
559 <p>Referenced by <a class="el" href="_n_e_pooling_layer_kernel_8h_source.xhtml#l00037">NEPoolingLayerKernel::name()</a>.</p>
560
561 </div>
562 </div>
563 <hr/>The documentation for this class was generated from the following file:<ul>
564 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_pooling_layer_kernel_8h_source.xhtml">NEPoolingLayerKernel.h</a></li>
565 </ul>
566 </div><!-- contents -->
567 </div><!-- doc-content -->
568 <!-- start footer part -->
569 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
570   <ul>
571     <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_n_e_pooling_layer_kernel.xhtml">NEPoolingLayerKernel</a></li>
572     <li class="footer">Generated on Fri Mar 2 2018 12:37:59 for Compute Library by
573     <a href="http://www.doxygen.org/index.html">
574     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
575   </ul>
576 </div>
577 </body>
578 </html>