arm_compute v17.12
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_r_o_i_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>Compute Library: ROIPoolingLayerInfo 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">17.12</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_r_o_i_pooling_layer_info.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">ROIPoolingLayerInfo Class Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p><a class="el" href="structarm__compute_1_1_r_o_i.xhtml" title="Region of interest. ">ROI</a> Pooling Layer Information class.  
126  <a href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>&gt;</code></p>
129 <table class="memberdecls">
130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
131 Public Member Functions</h2></td></tr>
132 <tr class="memitem:aeb18f7aaaa12486cd2cf6499c19059db"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#aeb18f7aaaa12486cd2cf6499c19059db">ROIPoolingLayerInfo</a> (unsigned int <a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#ae889c3657ba9390ac5ecd268e8a19720">pooled_width</a>, unsigned int <a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a5ef65c82efd18c18e7f23585364e3fa9">pooled_height</a>, float <a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a13a5239b80c3170a975b369f288cbd91">spatial_scale</a>)</td></tr>
133 <tr class="memdesc:aeb18f7aaaa12486cd2cf6499c19059db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor.  <a href="#aeb18f7aaaa12486cd2cf6499c19059db">More...</a><br /></td></tr>
134 <tr class="separator:aeb18f7aaaa12486cd2cf6499c19059db"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <tr class="memitem:ae889c3657ba9390ac5ecd268e8a19720"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#ae889c3657ba9390ac5ecd268e8a19720">pooled_width</a> () const </td></tr>
136 <tr class="separator:ae889c3657ba9390ac5ecd268e8a19720"><td class="memSeparator" colspan="2">&#160;</td></tr>
137 <tr class="memitem:a5ef65c82efd18c18e7f23585364e3fa9"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a5ef65c82efd18c18e7f23585364e3fa9">pooled_height</a> () const </td></tr>
138 <tr class="separator:a5ef65c82efd18c18e7f23585364e3fa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
139 <tr class="memitem:a13a5239b80c3170a975b369f288cbd91"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a13a5239b80c3170a975b369f288cbd91">spatial_scale</a> () const </td></tr>
140 <tr class="separator:a13a5239b80c3170a975b369f288cbd91"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 </table>
142 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
143 <div class="textblock"><p><a class="el" href="structarm__compute_1_1_r_o_i.xhtml" title="Region of interest. ">ROI</a> Pooling Layer Information class. </p>
144
145 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00617">617</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
146 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
147 <a class="anchor" id="aeb18f7aaaa12486cd2cf6499c19059db"></a>
148 <div class="memitem">
149 <div class="memproto">
150 <table class="mlabels">
151   <tr>
152   <td class="mlabels-left">
153       <table class="memname">
154         <tr>
155           <td class="memname"><a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml">ROIPoolingLayerInfo</a> </td>
156           <td>(</td>
157           <td class="paramtype">unsigned int&#160;</td>
158           <td class="paramname"><em>pooled_width</em>, </td>
159         </tr>
160         <tr>
161           <td class="paramkey"></td>
162           <td></td>
163           <td class="paramtype">unsigned int&#160;</td>
164           <td class="paramname"><em>pooled_height</em>, </td>
165         </tr>
166         <tr>
167           <td class="paramkey"></td>
168           <td></td>
169           <td class="paramtype">float&#160;</td>
170           <td class="paramname"><em>spatial_scale</em>&#160;</td>
171         </tr>
172         <tr>
173           <td></td>
174           <td>)</td>
175           <td></td><td></td>
176         </tr>
177       </table>
178   </td>
179   <td class="mlabels-right">
180 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
181   </tr>
182 </table>
183 </div><div class="memdoc">
184
185 <p>Default Constructor. </p>
186 <dl class="params"><dt>Parameters</dt><dd>
187   <table class="params">
188     <tr><td class="paramdir">[in]</td><td class="paramname">pooled_width</td><td>Pooled width of the layer. </td></tr>
189     <tr><td class="paramdir">[in]</td><td class="paramname">pooled_height</td><td>Pooled height of the layer. </td></tr>
190     <tr><td class="paramdir">[in]</td><td class="paramname">spatial_scale</td><td>Spatial scale to be applied to the <a class="el" href="structarm__compute_1_1_r_o_i.xhtml" title="Region of interest. ">ROI</a> coordinates and dimensions. </td></tr>
191   </table>
192   </dd>
193 </dl>
194
195 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00626">626</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
196 <div class="fragment"><div class="line"><a name="l00627"></a><span class="lineno">  627</span>&#160;        : _pooled_width(<a class="code" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#ae889c3657ba9390ac5ecd268e8a19720">pooled_width</a>), _pooled_height(<a class="code" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a5ef65c82efd18c18e7f23585364e3fa9">pooled_height</a>), _spatial_scale(<a class="code" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a13a5239b80c3170a975b369f288cbd91">spatial_scale</a>)</div><div class="line"><a name="l00628"></a><span class="lineno">  628</span>&#160;    {</div><div class="line"><a name="l00629"></a><span class="lineno">  629</span>&#160;    }</div><div class="ttc" id="classarm__compute_1_1_r_o_i_pooling_layer_info_xhtml_a13a5239b80c3170a975b369f288cbd91"><div class="ttname"><a href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a13a5239b80c3170a975b369f288cbd91">arm_compute::ROIPoolingLayerInfo::spatial_scale</a></div><div class="ttdeci">float spatial_scale() const </div><div class="ttdef"><b>Definition:</b> <a href="arm__compute_2core_2_types_8h_source.xhtml#l00638">Types.h:638</a></div></div>
197 <div class="ttc" id="classarm__compute_1_1_r_o_i_pooling_layer_info_xhtml_ae889c3657ba9390ac5ecd268e8a19720"><div class="ttname"><a href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#ae889c3657ba9390ac5ecd268e8a19720">arm_compute::ROIPoolingLayerInfo::pooled_width</a></div><div class="ttdeci">unsigned int pooled_width() const </div><div class="ttdef"><b>Definition:</b> <a href="arm__compute_2core_2_types_8h_source.xhtml#l00630">Types.h:630</a></div></div>
198 <div class="ttc" id="classarm__compute_1_1_r_o_i_pooling_layer_info_xhtml_a5ef65c82efd18c18e7f23585364e3fa9"><div class="ttname"><a href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#a5ef65c82efd18c18e7f23585364e3fa9">arm_compute::ROIPoolingLayerInfo::pooled_height</a></div><div class="ttdeci">unsigned int pooled_height() const </div><div class="ttdef"><b>Definition:</b> <a href="arm__compute_2core_2_types_8h_source.xhtml#l00634">Types.h:634</a></div></div>
199 </div><!-- fragment -->
200 </div>
201 </div>
202 <h2 class="groupheader">Member Function Documentation</h2>
203 <a class="anchor" id="a5ef65c82efd18c18e7f23585364e3fa9"></a>
204 <div class="memitem">
205 <div class="memproto">
206 <table class="mlabels">
207   <tr>
208   <td class="mlabels-left">
209       <table class="memname">
210         <tr>
211           <td class="memname">unsigned int pooled_height </td>
212           <td>(</td>
213           <td class="paramname"></td><td>)</td>
214           <td> const</td>
215         </tr>
216       </table>
217   </td>
218   <td class="mlabels-right">
219 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
220   </tr>
221 </table>
222 </div><div class="memdoc">
223
224 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00634">634</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
225
226 <p>Referenced by <a class="el" href="tests_2_utils_8h_source.xhtml#l00475">arm_compute::test::generate_random_rois()</a>, <a class="el" href="_type_printer_8h_source.xhtml#l00148">arm_compute::operator&lt;&lt;()</a>, and <a class="el" href="_r_o_i_pooling_layer_fixture_8h_source.xhtml#l00045">ROIPoolingLayerFixture&lt; TensorType, Function, Accessor, Array_T, ArrayAccessor &gt;::setup()</a>.</p>
227 <div class="fragment"><div class="line"><a name="l00635"></a><span class="lineno">  635</span>&#160;    {</div><div class="line"><a name="l00636"></a><span class="lineno">  636</span>&#160;        <span class="keywordflow">return</span> _pooled_height;</div><div class="line"><a name="l00637"></a><span class="lineno">  637</span>&#160;    }</div></div><!-- fragment -->
228 </div>
229 </div>
230 <a class="anchor" id="ae889c3657ba9390ac5ecd268e8a19720"></a>
231 <div class="memitem">
232 <div class="memproto">
233 <table class="mlabels">
234   <tr>
235   <td class="mlabels-left">
236       <table class="memname">
237         <tr>
238           <td class="memname">unsigned int pooled_width </td>
239           <td>(</td>
240           <td class="paramname"></td><td>)</td>
241           <td> const</td>
242         </tr>
243       </table>
244   </td>
245   <td class="mlabels-right">
246 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
247   </tr>
248 </table>
249 </div><div class="memdoc">
250
251 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00630">630</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
252
253 <p>Referenced by <a class="el" href="tests_2_utils_8h_source.xhtml#l00475">arm_compute::test::generate_random_rois()</a>, <a class="el" href="_type_printer_8h_source.xhtml#l00148">arm_compute::operator&lt;&lt;()</a>, and <a class="el" href="_r_o_i_pooling_layer_fixture_8h_source.xhtml#l00045">ROIPoolingLayerFixture&lt; TensorType, Function, Accessor, Array_T, ArrayAccessor &gt;::setup()</a>.</p>
254 <div class="fragment"><div class="line"><a name="l00631"></a><span class="lineno">  631</span>&#160;    {</div><div class="line"><a name="l00632"></a><span class="lineno">  632</span>&#160;        <span class="keywordflow">return</span> _pooled_width;</div><div class="line"><a name="l00633"></a><span class="lineno">  633</span>&#160;    }</div></div><!-- fragment -->
255 </div>
256 </div>
257 <a class="anchor" id="a13a5239b80c3170a975b369f288cbd91"></a>
258 <div class="memitem">
259 <div class="memproto">
260 <table class="mlabels">
261   <tr>
262   <td class="mlabels-left">
263       <table class="memname">
264         <tr>
265           <td class="memname">float spatial_scale </td>
266           <td>(</td>
267           <td class="paramname"></td><td>)</td>
268           <td> const</td>
269         </tr>
270       </table>
271   </td>
272   <td class="mlabels-right">
273 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
274   </tr>
275 </table>
276 </div><div class="memdoc">
277
278 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00638">638</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
279
280 <p>Referenced by <a class="el" href="tests_2_utils_8h_source.xhtml#l00475">arm_compute::test::generate_random_rois()</a>, and <a class="el" href="_type_printer_8h_source.xhtml#l00148">arm_compute::operator&lt;&lt;()</a>.</p>
281 <div class="fragment"><div class="line"><a name="l00639"></a><span class="lineno">  639</span>&#160;    {</div><div class="line"><a name="l00640"></a><span class="lineno">  640</span>&#160;        <span class="keywordflow">return</span> _spatial_scale;</div><div class="line"><a name="l00641"></a><span class="lineno">  641</span>&#160;    }</div></div><!-- fragment -->
282 </div>
283 </div>
284 <hr/>The documentation for this class was generated from the following file:<ul>
285 <li>arm_compute/core/<a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a></li>
286 </ul>
287 </div><!-- contents -->
288 </div><!-- doc-content -->
289 <!-- start footer part -->
290 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
291   <ul>
292     <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_r_o_i_pooling_layer_info.xhtml">ROIPoolingLayerInfo</a></li>
293     <li class="footer">Generated on Thu Dec 14 2017 23:48:37 for Compute Library by
294     <a href="http://www.doxygen.org/index.html">
295     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
296   </ul>
297 </div>
298 </body>
299 </html>