06ad0e19cc8242569859b301252fd2fddd82d63f
[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.6"/>
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="navtree.js"></script>
16 <script type="text/javascript">
17   $(document).ready(initResizable);
18   $(window).load(resizeHeight);
19 </script>
20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23   $(document).ready(function() { searchBox.OnSelectItem(0); });
24 </script>
25 <script type="text/x-mathjax-config">
26   MathJax.Hub.Config({
27     extensions: ["tex2jax.js"],
28     jax: ["input/TeX","output/HTML-CSS"],
29 });
30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
32 </head>
33 <body>
34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
35 <div id="titlearea">
36 <table cellspacing="0" cellpadding="0">
37  <tbody>
38  <tr style="height: 56px;">
39   <td style="padding-left: 0.5em;">
40    <div id="projectname">Compute Library
41    &#160;<span id="projectnumber">17.09</span>
42    </div>
43   </td>
44  </tr>
45  </tbody>
46 </table>
47 </div>
48 <!-- end header part -->
49 <!-- Generated by Doxygen 1.8.6 -->
50 <script type="text/javascript">
51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
52 </script>
53   <div id="navrow1" class="tabs">
54     <ul class="tablist">
55       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
56       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
57       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
58       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
59       <li><a href="files.xhtml"><span>Files</span></a></li>
60       <li>
61         <div id="MSearchBox" class="MSearchBoxInactive">
62         <span class="left">
63           <img id="MSearchSelect" src="search/mag_sel.png"
64                onmouseover="return searchBox.OnSearchSelectShow()"
65                onmouseout="return searchBox.OnSearchSelectHide()"
66                alt=""/>
67           <input type="text" id="MSearchField" value="Search" accesskey="S"
68                onfocus="searchBox.OnSearchFieldFocus(true)" 
69                onblur="searchBox.OnSearchFieldFocus(false)" 
70                onkeyup="searchBox.OnSearchFieldChange(event)"/>
71           </span><span class="right">
72             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
73           </span>
74         </div>
75       </li>
76     </ul>
77   </div>
78   <div id="navrow2" class="tabs2">
79     <ul class="tablist">
80       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
81       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
82       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
83       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
84     </ul>
85   </div>
86 </div><!-- top -->
87 <div id="side-nav" class="ui-resizable side-nav-resizable">
88   <div id="nav-tree">
89     <div id="nav-tree-contents">
90       <div id="nav-sync" class="sync"></div>
91     </div>
92   </div>
93   <div id="splitbar" style="-moz-user-select:none;" 
94        class="ui-resizable-handle">
95   </div>
96 </div>
97 <script type="text/javascript">
98 $(document).ready(function(){initNavTree('classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml','');});
99 </script>
100 <div id="doc-content">
101 <!-- window showing the filter options -->
102 <div id="MSearchSelectWindow"
103      onmouseover="return searchBox.OnSearchSelectShow()"
104      onmouseout="return searchBox.OnSearchSelectHide()"
105      onkeydown="return searchBox.OnSearchSelectKey(event)">
106 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
107
108 <!-- iframe showing the search results (closed by default) -->
109 <div id="MSearchResultsWindow">
110 <iframe src="javascript:void(0)" frameborder="0" 
111         name="MSearchResults" id="MSearchResults">
112 </iframe>
113 </div>
114
115 <div class="header">
116   <div class="summary">
117 <a href="#pub-methods">Public Member Functions</a>  </div>
118   <div class="headertitle">
119 <div class="title">ROIPoolingLayerInfo Class Reference</div>  </div>
120 </div><!--header-->
121 <div class="contents">
122
123 <p><a class="el" href="structarm__compute_1_1_r_o_i.xhtml" title="Region of interest. ">ROI</a> Pooling Layer Information class.  
124  <a href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml#details">More...</a></p>
125
126 <p><code>#include &lt;<a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>&gt;</code></p>
127 <table class="memberdecls">
128 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
129 Public Member Functions</h2></td></tr>
130 <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>
131 <tr class="memdesc:aeb18f7aaaa12486cd2cf6499c19059db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor.  <a href="#aeb18f7aaaa12486cd2cf6499c19059db">More...</a><br/></td></tr>
132 <tr class="separator:aeb18f7aaaa12486cd2cf6499c19059db"><td class="memSeparator" colspan="2">&#160;</td></tr>
133 <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>
134 <tr class="separator:ae889c3657ba9390ac5ecd268e8a19720"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <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>
136 <tr class="separator:a5ef65c82efd18c18e7f23585364e3fa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
137 <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>
138 <tr class="separator:a13a5239b80c3170a975b369f288cbd91"><td class="memSeparator" colspan="2">&#160;</td></tr>
139 </table>
140 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
141 <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>
142
143 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00478">478</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
144 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
145 <a class="anchor" id="aeb18f7aaaa12486cd2cf6499c19059db"></a>
146 <div class="memitem">
147 <div class="memproto">
148 <table class="mlabels">
149   <tr>
150   <td class="mlabels-left">
151       <table class="memname">
152         <tr>
153           <td class="memname"><a class="el" href="classarm__compute_1_1_r_o_i_pooling_layer_info.xhtml">ROIPoolingLayerInfo</a> </td>
154           <td>(</td>
155           <td class="paramtype">unsigned int&#160;</td>
156           <td class="paramname"><em>pooled_width</em>, </td>
157         </tr>
158         <tr>
159           <td class="paramkey"></td>
160           <td></td>
161           <td class="paramtype">unsigned int&#160;</td>
162           <td class="paramname"><em>pooled_height</em>, </td>
163         </tr>
164         <tr>
165           <td class="paramkey"></td>
166           <td></td>
167           <td class="paramtype">float&#160;</td>
168           <td class="paramname"><em>spatial_scale</em>&#160;</td>
169         </tr>
170         <tr>
171           <td></td>
172           <td>)</td>
173           <td></td><td></td>
174         </tr>
175       </table>
176   </td>
177   <td class="mlabels-right">
178 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
179   </tr>
180 </table>
181 </div><div class="memdoc">
182
183 <p>Default Constructor. </p>
184 <dl class="params"><dt>Parameters</dt><dd>
185   <table class="params">
186     <tr><td class="paramdir">[in]</td><td class="paramname">pooled_width</td><td>Pooled width of the layer. </td></tr>
187     <tr><td class="paramdir">[in]</td><td class="paramname">pooled_height</td><td>Pooled height of the layer. </td></tr>
188     <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>
189   </table>
190   </dd>
191 </dl>
192
193 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00487">487</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
194 <div class="fragment"><div class="line"><a name="l00488"></a><span class="lineno">  488</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>
195 <div class="line"><a name="l00489"></a><span class="lineno">  489</span>&#160;    {</div>
196 <div class="line"><a name="l00490"></a><span class="lineno">  490</span>&#160;    }</div>
197 <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#l00499">Types.h:499</a></div></div>
198 <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#l00491">Types.h:491</a></div></div>
199 <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#l00495">Types.h:495</a></div></div>
200 </div><!-- fragment -->
201 </div>
202 </div>
203 <h2 class="groupheader">Member Function Documentation</h2>
204 <a class="anchor" id="a5ef65c82efd18c18e7f23585364e3fa9"></a>
205 <div class="memitem">
206 <div class="memproto">
207 <table class="mlabels">
208   <tr>
209   <td class="mlabels-left">
210       <table class="memname">
211         <tr>
212           <td class="memname">unsigned int pooled_height </td>
213           <td>(</td>
214           <td class="paramname"></td><td>)</td>
215           <td> const</td>
216         </tr>
217       </table>
218   </td>
219   <td class="mlabels-right">
220 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
221   </tr>
222 </table>
223 </div><div class="memdoc">
224
225 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00495">495</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
226
227 <p>Referenced by <a class="el" href="tests_2_utils_8h_source.xhtml#l00395">arm_compute::test::generate_random_rois()</a>, <a class="el" href="_type_printer_8h_source.xhtml#l00144">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>
228 <div class="fragment"><div class="line"><a name="l00496"></a><span class="lineno">  496</span>&#160;    {</div>
229 <div class="line"><a name="l00497"></a><span class="lineno">  497</span>&#160;        <span class="keywordflow">return</span> _pooled_height;</div>
230 <div class="line"><a name="l00498"></a><span class="lineno">  498</span>&#160;    }</div>
231 </div><!-- fragment -->
232 </div>
233 </div>
234 <a class="anchor" id="ae889c3657ba9390ac5ecd268e8a19720"></a>
235 <div class="memitem">
236 <div class="memproto">
237 <table class="mlabels">
238   <tr>
239   <td class="mlabels-left">
240       <table class="memname">
241         <tr>
242           <td class="memname">unsigned int pooled_width </td>
243           <td>(</td>
244           <td class="paramname"></td><td>)</td>
245           <td> const</td>
246         </tr>
247       </table>
248   </td>
249   <td class="mlabels-right">
250 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
251   </tr>
252 </table>
253 </div><div class="memdoc">
254
255 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00491">491</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
256
257 <p>Referenced by <a class="el" href="tests_2_utils_8h_source.xhtml#l00395">arm_compute::test::generate_random_rois()</a>, <a class="el" href="_type_printer_8h_source.xhtml#l00144">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>
258 <div class="fragment"><div class="line"><a name="l00492"></a><span class="lineno">  492</span>&#160;    {</div>
259 <div class="line"><a name="l00493"></a><span class="lineno">  493</span>&#160;        <span class="keywordflow">return</span> _pooled_width;</div>
260 <div class="line"><a name="l00494"></a><span class="lineno">  494</span>&#160;    }</div>
261 </div><!-- fragment -->
262 </div>
263 </div>
264 <a class="anchor" id="a13a5239b80c3170a975b369f288cbd91"></a>
265 <div class="memitem">
266 <div class="memproto">
267 <table class="mlabels">
268   <tr>
269   <td class="mlabels-left">
270       <table class="memname">
271         <tr>
272           <td class="memname">float spatial_scale </td>
273           <td>(</td>
274           <td class="paramname"></td><td>)</td>
275           <td> const</td>
276         </tr>
277       </table>
278   </td>
279   <td class="mlabels-right">
280 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
281   </tr>
282 </table>
283 </div><div class="memdoc">
284
285 <p>Definition at line <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml#l00499">499</a> of file <a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a>.</p>
286
287 <p>Referenced by <a class="el" href="tests_2_utils_8h_source.xhtml#l00395">arm_compute::test::generate_random_rois()</a>, and <a class="el" href="_type_printer_8h_source.xhtml#l00144">arm_compute::operator&lt;&lt;()</a>.</p>
288 <div class="fragment"><div class="line"><a name="l00500"></a><span class="lineno">  500</span>&#160;    {</div>
289 <div class="line"><a name="l00501"></a><span class="lineno">  501</span>&#160;        <span class="keywordflow">return</span> _spatial_scale;</div>
290 <div class="line"><a name="l00502"></a><span class="lineno">  502</span>&#160;    }</div>
291 </div><!-- fragment -->
292 </div>
293 </div>
294 <hr/>The documentation for this class was generated from the following file:<ul>
295 <li>arm_compute/core/<a class="el" href="arm__compute_2core_2_types_8h_source.xhtml">Types.h</a></li>
296 </ul>
297 </div><!-- contents -->
298 </div><!-- doc-content -->
299 <!-- start footer part -->
300 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
301   <ul>
302     <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>
303     <li class="footer">Generated on Thu Sep 28 2017 14:37:57 for Compute Library by
304     <a href="http://www.doxygen.org/index.html">
305     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
306   </ul>
307 </div>
308 </body>
309 </html>