arm_compute v17.04
[platform/upstream/armcl.git] / documentation / pooling__layer_8cl.xhtml
1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7 <meta name="generator" content="Doxygen 1.8.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>ARM Compute Library: src/core/CL/cl_kernels/pooling_layer.cl File Reference</title>
10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="dynsections.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17 <script type="text/javascript">
18   $(document).ready(initResizable);
19   $(window).load(resizeHeight);
20 </script>
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25   $(document).ready(function() { init_search(); });
26 </script>
27 <script type="text/x-mathjax-config">
28   MathJax.Hub.Config({
29     extensions: ["tex2jax.js"],
30     jax: ["input/TeX","output/HTML-CSS"],
31 });
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 56px;">
41   <td style="padding-left: 0.5em;">
42    <div id="projectname">ARM Compute Library
43    &#160;<span id="projectnumber">17.04</span>
44    </div>
45   </td>
46  </tr>
47  </tbody>
48 </table>
49 </div>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
54 </script>
55   <div id="navrow1" class="tabs">
56     <ul class="tablist">
57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
58       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
59       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
60       <li class="current"><a href="files.xhtml"><span>Files</span></a></li>
61       <li>
62         <div id="MSearchBox" class="MSearchBoxInactive">
63         <span class="left">
64           <img id="MSearchSelect" src="search/mag_sel.png"
65                onmouseover="return searchBox.OnSearchSelectShow()"
66                onmouseout="return searchBox.OnSearchSelectHide()"
67                alt=""/>
68           <input type="text" id="MSearchField" value="Search" accesskey="S"
69                onfocus="searchBox.OnSearchFieldFocus(true)" 
70                onblur="searchBox.OnSearchFieldFocus(false)" 
71                onkeyup="searchBox.OnSearchFieldChange(event)"/>
72           </span><span class="right">
73             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
74           </span>
75         </div>
76       </li>
77     </ul>
78   </div>
79   <div id="navrow2" class="tabs2">
80     <ul class="tablist">
81       <li><a href="files.xhtml"><span>File&#160;List</span></a></li>
82       <li><a href="globals.xhtml"><span>Globals</span></a></li>
83     </ul>
84   </div>
85 </div><!-- top -->
86 <div id="side-nav" class="ui-resizable side-nav-resizable">
87   <div id="nav-tree">
88     <div id="nav-tree-contents">
89       <div id="nav-sync" class="sync"></div>
90     </div>
91   </div>
92   <div id="splitbar" style="-moz-user-select:none;" 
93        class="ui-resizable-handle">
94   </div>
95 </div>
96 <script type="text/javascript">
97 $(document).ready(function(){initNavTree('pooling__layer_8cl.xhtml','');});
98 </script>
99 <div id="doc-content">
100 <!-- window showing the filter options -->
101 <div id="MSearchSelectWindow"
102      onmouseover="return searchBox.OnSearchSelectShow()"
103      onmouseout="return searchBox.OnSearchSelectHide()"
104      onkeydown="return searchBox.OnSearchSelectKey(event)">
105 </div>
106
107 <!-- iframe showing the search results (closed by default) -->
108 <div id="MSearchResultsWindow">
109 <iframe src="javascript:void(0)" frameborder="0" 
110         name="MSearchResults" id="MSearchResults">
111 </iframe>
112 </div>
113
114 <div class="header">
115   <div class="summary">
116 <a href="#define-members">Macros</a> &#124;
117 <a href="#func-members">Functions</a>  </div>
118   <div class="headertitle">
119 <div class="title">pooling_layer.cl File Reference</div>  </div>
120 </div><!--header-->
121 <div class="contents">
122 <div class="textblock"><code>#include &quot;<a class="el" href="helpers_8h_source.xhtml">helpers.h</a>&quot;</code><br />
123 </div>
124 <p><a href="pooling__layer_8cl_source.xhtml">Go to the source code of this file.</a></p>
125 <table class="memberdecls">
126 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
127 Macros</h2></td></tr>
128 <tr class="memitem:a482ef7d59a5f474ca126e737c7f0978a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pooling__layer_8cl.xhtml#a482ef7d59a5f474ca126e737c7f0978a">POOL_OP</a>(x,  y)&#160;&#160;&#160;((x) + (y))</td></tr>
129 <tr class="separator:a482ef7d59a5f474ca126e737c7f0978a"><td class="memSeparator" colspan="2">&#160;</td></tr>
130 </table><table class="memberdecls">
131 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
132 Functions</h2></td></tr>
133 <tr class="memitem:a60440813daa769d486c5786d52b91340"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pooling__layer_8cl.xhtml#a60440813daa769d486c5786d52b91340">calculate_avg_scale</a> (const int pool_size, const int upper_bound_w, const int upper_bound_h, const int pad_x, const int pad_y, const int stride_x, const int stride_y)</td></tr>
134 <tr class="separator:a60440813daa769d486c5786d52b91340"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <tr class="memitem:ac5df4051328f567787660fd319694842"><td class="memItemLeft" align="right" valign="top">__kernel void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pooling__layer_8cl.xhtml#ac5df4051328f567787660fd319694842">pooling_layer_2</a> (__global uchar *input_ptr, uint input_stride_x, uint input_step_x, uint input_stride_y, uint input_step_y, uint input_offset_first_element_in_bytes, __global uchar *output_ptr, uint output_stride_x, uint output_step_x, uint output_stride_y, uint output_step_y, uint output_offset_first_element_in_bytes, int2 max_dims, int2 strides, int2 paddings)</td></tr>
136 <tr class="memdesc:ac5df4051328f567787660fd319694842"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs a pooling function of pool size equal to 2.  <a href="#ac5df4051328f567787660fd319694842">More...</a><br /></td></tr>
137 <tr class="separator:ac5df4051328f567787660fd319694842"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:a0c8f47e252a2f3e9d9f2ba3bf197846b"><td class="memItemLeft" align="right" valign="top">__kernel void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pooling__layer_8cl.xhtml#a0c8f47e252a2f3e9d9f2ba3bf197846b">pooling_layer_3</a> (__global uchar *input_ptr, uint input_stride_x, uint input_step_x, uint input_stride_y, uint input_step_y, uint input_offset_first_element_in_bytes, __global uchar *output_ptr, uint output_stride_x, uint output_step_x, uint output_stride_y, uint output_step_y, uint output_offset_first_element_in_bytes, int2 max_dims, int2 strides, int2 paddings)</td></tr>
139 <tr class="memdesc:a0c8f47e252a2f3e9d9f2ba3bf197846b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs a pooling function of pool size equal to 3.  <a href="#a0c8f47e252a2f3e9d9f2ba3bf197846b">More...</a><br /></td></tr>
140 <tr class="separator:a0c8f47e252a2f3e9d9f2ba3bf197846b"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 </table>
142 <h2 class="groupheader">Macro Definition Documentation</h2>
143 <a class="anchor" id="a482ef7d59a5f474ca126e737c7f0978a"></a>
144 <div class="memitem">
145 <div class="memproto">
146       <table class="memname">
147         <tr>
148           <td class="memname">#define POOL_OP</td>
149           <td>(</td>
150           <td class="paramtype">&#160;</td>
151           <td class="paramname">x, </td>
152         </tr>
153         <tr>
154           <td class="paramkey"></td>
155           <td></td>
156           <td class="paramtype">&#160;</td>
157           <td class="paramname">y&#160;</td>
158         </tr>
159         <tr>
160           <td></td>
161           <td>)</td>
162           <td></td><td>&#160;&#160;&#160;((x) + (y))</td>
163         </tr>
164       </table>
165 </div><div class="memdoc">
166
167 <p>Definition at line <a class="el" href="pooling__layer_8cl_source.xhtml#l00027">27</a> of file <a class="el" href="pooling__layer_8cl_source.xhtml">pooling_layer.cl</a>.</p>
168
169 <p>Referenced by <a class="el" href="pooling__layer_8cl_source.xhtml#l00064">pooling_layer_2()</a>, and <a class="el" href="pooling__layer_8cl_source.xhtml#l00118">pooling_layer_3()</a>.</p>
170
171 </div>
172 </div>
173 <h2 class="groupheader">Function Documentation</h2>
174 <a class="anchor" id="a60440813daa769d486c5786d52b91340"></a>
175 <div class="memitem">
176 <div class="memproto">
177       <table class="memname">
178         <tr>
179           <td class="memname">float calculate_avg_scale </td>
180           <td>(</td>
181           <td class="paramtype">const int&#160;</td>
182           <td class="paramname"><em>pool_size</em>, </td>
183         </tr>
184         <tr>
185           <td class="paramkey"></td>
186           <td></td>
187           <td class="paramtype">const int&#160;</td>
188           <td class="paramname"><em>upper_bound_w</em>, </td>
189         </tr>
190         <tr>
191           <td class="paramkey"></td>
192           <td></td>
193           <td class="paramtype">const int&#160;</td>
194           <td class="paramname"><em>upper_bound_h</em>, </td>
195         </tr>
196         <tr>
197           <td class="paramkey"></td>
198           <td></td>
199           <td class="paramtype">const int&#160;</td>
200           <td class="paramname"><em>pad_x</em>, </td>
201         </tr>
202         <tr>
203           <td class="paramkey"></td>
204           <td></td>
205           <td class="paramtype">const int&#160;</td>
206           <td class="paramname"><em>pad_y</em>, </td>
207         </tr>
208         <tr>
209           <td class="paramkey"></td>
210           <td></td>
211           <td class="paramtype">const int&#160;</td>
212           <td class="paramname"><em>stride_x</em>, </td>
213         </tr>
214         <tr>
215           <td class="paramkey"></td>
216           <td></td>
217           <td class="paramtype">const int&#160;</td>
218           <td class="paramname"><em>stride_y</em>&#160;</td>
219         </tr>
220         <tr>
221           <td></td>
222           <td>)</td>
223           <td></td><td></td>
224         </tr>
225       </table>
226 </div><div class="memdoc">
227
228 <p>Definition at line <a class="el" href="pooling__layer_8cl_source.xhtml#l00032">32</a> of file <a class="el" href="pooling__layer_8cl_source.xhtml">pooling_layer.cl</a>.</p>
229
230 <p>Referenced by <a class="el" href="pooling__layer_8cl_source.xhtml#l00064">pooling_layer_2()</a>, and <a class="el" href="pooling__layer_8cl_source.xhtml#l00118">pooling_layer_3()</a>.</p>
231 <div class="fragment"><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;{</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    <span class="keywordtype">int</span> start_x = get_global_id(0) * stride_x - pad_x;</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    <span class="keywordtype">int</span> start_y = get_global_id(1) * stride_y - pad_y;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <span class="keywordtype">int</span> end_x   = min(start_x + pool_size, upper_bound_w);</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    <span class="keywordtype">int</span> end_y   = min(start_y + pool_size, upper_bound_h);</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <span class="keywordflow">return</span> 1.f / ((end_y - start_y) * (end_x - start_x));</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;}</div></div><!-- fragment -->
232 </div>
233 </div>
234 <a class="anchor" id="ac5df4051328f567787660fd319694842"></a>
235 <div class="memitem">
236 <div class="memproto">
237       <table class="memname">
238         <tr>
239           <td class="memname">__kernel void pooling_layer_2 </td>
240           <td>(</td>
241           <td class="paramtype">__global uchar *&#160;</td>
242           <td class="paramname"><em>input_ptr</em>, </td>
243         </tr>
244         <tr>
245           <td class="paramkey"></td>
246           <td></td>
247           <td class="paramtype">uint&#160;</td>
248           <td class="paramname"><em>input_stride_x</em>, </td>
249         </tr>
250         <tr>
251           <td class="paramkey"></td>
252           <td></td>
253           <td class="paramtype">uint&#160;</td>
254           <td class="paramname"><em>input_step_x</em>, </td>
255         </tr>
256         <tr>
257           <td class="paramkey"></td>
258           <td></td>
259           <td class="paramtype">uint&#160;</td>
260           <td class="paramname"><em>input_stride_y</em>, </td>
261         </tr>
262         <tr>
263           <td class="paramkey"></td>
264           <td></td>
265           <td class="paramtype">uint&#160;</td>
266           <td class="paramname"><em>input_step_y</em>, </td>
267         </tr>
268         <tr>
269           <td class="paramkey"></td>
270           <td></td>
271           <td class="paramtype">uint&#160;</td>
272           <td class="paramname"><em>input_offset_first_element_in_bytes</em>, </td>
273         </tr>
274         <tr>
275           <td class="paramkey"></td>
276           <td></td>
277           <td class="paramtype">__global uchar *&#160;</td>
278           <td class="paramname"><em>output_ptr</em>, </td>
279         </tr>
280         <tr>
281           <td class="paramkey"></td>
282           <td></td>
283           <td class="paramtype">uint&#160;</td>
284           <td class="paramname"><em>output_stride_x</em>, </td>
285         </tr>
286         <tr>
287           <td class="paramkey"></td>
288           <td></td>
289           <td class="paramtype">uint&#160;</td>
290           <td class="paramname"><em>output_step_x</em>, </td>
291         </tr>
292         <tr>
293           <td class="paramkey"></td>
294           <td></td>
295           <td class="paramtype">uint&#160;</td>
296           <td class="paramname"><em>output_stride_y</em>, </td>
297         </tr>
298         <tr>
299           <td class="paramkey"></td>
300           <td></td>
301           <td class="paramtype">uint&#160;</td>
302           <td class="paramname"><em>output_step_y</em>, </td>
303         </tr>
304         <tr>
305           <td class="paramkey"></td>
306           <td></td>
307           <td class="paramtype">uint&#160;</td>
308           <td class="paramname"><em>output_offset_first_element_in_bytes</em>, </td>
309         </tr>
310         <tr>
311           <td class="paramkey"></td>
312           <td></td>
313           <td class="paramtype">int2&#160;</td>
314           <td class="paramname"><em>max_dims</em>, </td>
315         </tr>
316         <tr>
317           <td class="paramkey"></td>
318           <td></td>
319           <td class="paramtype">int2&#160;</td>
320           <td class="paramname"><em>strides</em>, </td>
321         </tr>
322         <tr>
323           <td class="paramkey"></td>
324           <td></td>
325           <td class="paramtype">int2&#160;</td>
326           <td class="paramname"><em>paddings</em>&#160;</td>
327         </tr>
328         <tr>
329           <td></td>
330           <td>)</td>
331           <td></td><td></td>
332         </tr>
333       </table>
334 </div><div class="memdoc">
335
336 <p>Performs a pooling function of pool size equal to 2. </p>
337 <dl class="section note"><dt>Note</dt><dd>Pooling stride must be passed using -DPOOL_STRIDE e.g -DPOOL_STRIDE=2. Supported strides are 1,2,3 </dd>
338 <dd>
339 Datatype must be passed using -DDATA_TYPE e.g. -DDATA_TYPE=float. Supported data types are F16, F32; </dd>
340 <dd>
341 In case of average pooling -DPOOL_AVG must be provided otherwise max pooling will be performed.</dd></dl>
342 <dl class="params"><dt>Parameters</dt><dd>
343   <table class="params">
344     <tr><td class="paramdir">[in]</td><td class="paramname">input_ptr</td><td>Pointer to the source image. Supported data types: F16, F32 </td></tr>
345     <tr><td class="paramdir">[in]</td><td class="paramname">input_stride_x</td><td>Stride of the source image in X dimension (in bytes) </td></tr>
346     <tr><td class="paramdir">[in]</td><td class="paramname">input_step_x</td><td>input_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
347     <tr><td class="paramdir">[in]</td><td class="paramname">input_stride_y</td><td>Stride of the source image in Y dimension (in bytes) </td></tr>
348     <tr><td class="paramdir">[in]</td><td class="paramname">input_step_y</td><td>input_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
349     <tr><td class="paramdir">[in]</td><td class="paramname">input_offset_first_element_in_bytes</td><td>The offset of the first element in the source image </td></tr>
350     <tr><td class="paramdir">[out]</td><td class="paramname">output_ptr</td><td>Pointer to the destination image. Supported data types: F16, F32 </td></tr>
351     <tr><td class="paramdir">[in]</td><td class="paramname">output_stride_x</td><td>Stride of the destination image in X dimension (in bytes) </td></tr>
352     <tr><td class="paramdir">[in]</td><td class="paramname">output_step_x</td><td>output_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
353     <tr><td class="paramdir">[in]</td><td class="paramname">output_stride_y</td><td>Stride of the destination image in Y dimension (in bytes) </td></tr>
354     <tr><td class="paramdir">[in]</td><td class="paramname">output_step_y</td><td>output_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
355     <tr><td class="paramdir">[in]</td><td class="paramname">output_offset_first_element_in_bytes</td><td>The offset of the first element in the destination image </td></tr>
356     <tr><td class="paramdir">[in]</td><td class="paramname">max_dims</td><td>The maximum index that can be accessed in x and y dimension (width + pad) </td></tr>
357     <tr><td class="paramdir">[in]</td><td class="paramname">strides</td><td>The pooling operation strides in each dimension </td></tr>
358     <tr><td class="paramdir">[in]</td><td class="paramname">paddings</td><td>The pooling operation paddings in each dimension </td></tr>
359   </table>
360   </dd>
361 </dl>
362
363 <p>Definition at line <a class="el" href="pooling__layer_8cl_source.xhtml#l00064">64</a> of file <a class="el" href="pooling__layer_8cl_source.xhtml">pooling_layer.cl</a>.</p>
364
365 <p>References <a class="el" href="pooling__layer_8cl_source.xhtml#l00032">calculate_avg_scale()</a>, <a class="el" href="helpers_8h_source.xhtml#l00073">CONVERT_TO_IMAGE_STRUCT</a>, <a class="el" href="convolution3x3_8cl_source.xhtml#l00027">DATA_TYPE</a>, <a class="el" href="helpers_8h_source.xhtml#l00201">offset()</a>, <a class="el" href="pooling__layer_8cl_source.xhtml#l00027">POOL_OP</a>, <a class="el" href="helpers_8h_source.xhtml#l00097">Image::ptr</a>, and <a class="el" href="helpers_8h_source.xhtml#l00032">VEC_DATA_TYPE</a>.</p>
366 <div class="fragment"><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;{</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <span class="comment">// Get pixels pointer</span></div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    <a class="code" href="struct_image.xhtml">Image</a> input  = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(input);</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    <a class="code" href="struct_image.xhtml">Image</a> output = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(output);</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    <span class="comment">// Load data</span></div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    <a class="code" href="helpers_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(<a class="code" href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a>, 2)</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    data0 = vload2(0, (__global <a class="code" href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a> *)<a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>(&amp;input, 0, 0));</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <a class="code" href="helpers_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(<a class="code" href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a>, 2)</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    data1 = vload2(0, (__global DATA_TYPE *)<a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>(&amp;input, 0, 1));</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    <span class="comment">// Perform calculations</span></div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    data0         = <a class="code" href="pooling__layer_8cl.xhtml#a482ef7d59a5f474ca126e737c7f0978a">POOL_OP</a>(data0, data1);</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    DATA_TYPE res = <a class="code" href="pooling__layer_8cl.xhtml#a482ef7d59a5f474ca126e737c7f0978a">POOL_OP</a>(data0.s0, data0.s1);</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    <span class="comment">// Divide by 4 in case of average pooling</span></div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="preprocessor">#ifdef POOL_AVG</span></div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;    res *= <a class="code" href="pooling__layer_8cl.xhtml#a60440813daa769d486c5786d52b91340">calculate_avg_scale</a>(2, max_dims.x, max_dims.y, paddings.x, paddings.y, strides.x, strides.y);</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    <span class="comment">// Store result</span></div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    *(__global DATA_TYPE *)output.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a> = res;</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;}</div><div class="ttc" id="pooling__layer_8cl_xhtml_a482ef7d59a5f474ca126e737c7f0978a"><div class="ttname"><a href="pooling__layer_8cl.xhtml#a482ef7d59a5f474ca126e737c7f0978a">POOL_OP</a></div><div class="ttdeci">#define POOL_OP(x, y)</div><div class="ttdef"><b>Definition:</b> <a href="pooling__layer_8cl_source.xhtml#l00027">pooling_layer.cl:27</a></div></div>
367 <div class="ttc" id="convolution3x3_8cl_xhtml_afb8c72ce35c4a1f4a2588d6573e54aa1"><div class="ttname"><a href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a></div><div class="ttdeci">#define DATA_TYPE</div><div class="ttdef"><b>Definition:</b> <a href="convolution3x3_8cl_source.xhtml#l00027">convolution3x3.cl:27</a></div></div>
368 <div class="ttc" id="pooling__layer_8cl_xhtml_a60440813daa769d486c5786d52b91340"><div class="ttname"><a href="pooling__layer_8cl.xhtml#a60440813daa769d486c5786d52b91340">calculate_avg_scale</a></div><div class="ttdeci">float calculate_avg_scale(const int pool_size, const int upper_bound_w, const int upper_bound_h, const int pad_x, const int pad_y, const int stride_x, const int stride_y)</div><div class="ttdef"><b>Definition:</b> <a href="pooling__layer_8cl_source.xhtml#l00032">pooling_layer.cl:32</a></div></div>
369 <div class="ttc" id="helpers_8h_xhtml_a009469e4d9b8fce3b6d5e97d2077827d"><div class="ttname"><a href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a></div><div class="ttdeci">__global uchar * offset(const Image *img, int x, int y)</div><div class="ttdoc">Get the pointer position of a Image. </div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00201">helpers.h:201</a></div></div>
370 <div class="ttc" id="helpers_8h_xhtml_aebe814363556c244be043b13e7969197"><div class="ttname"><a href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a></div><div class="ttdeci">#define CONVERT_TO_IMAGE_STRUCT(name)</div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00073">helpers.h:73</a></div></div>
371 <div class="ttc" id="helpers_8h_xhtml_a36f754c05b6fddf6df0d8d0a74f8159f"><div class="ttname"><a href="helpers_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a></div><div class="ttdeci">#define VEC_DATA_TYPE(type, size)</div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00032">helpers.h:32</a></div></div>
372 <div class="ttc" id="struct_image_xhtml"><div class="ttname"><a href="struct_image.xhtml">Image</a></div><div class="ttdoc">Structure to hold Image information. </div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00095">helpers.h:95</a></div></div>
373 <div class="ttc" id="struct_image_xhtml_acf52c23cbd7424606c10a606524e3e32"><div class="ttname"><a href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">Image::ptr</a></div><div class="ttdeci">__global uchar * ptr</div><div class="ttdoc">Pointer to the starting postion of the buffer. </div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00097">helpers.h:97</a></div></div>
374 </div><!-- fragment -->
375 </div>
376 </div>
377 <a class="anchor" id="a0c8f47e252a2f3e9d9f2ba3bf197846b"></a>
378 <div class="memitem">
379 <div class="memproto">
380       <table class="memname">
381         <tr>
382           <td class="memname">__kernel void pooling_layer_3 </td>
383           <td>(</td>
384           <td class="paramtype">__global uchar *&#160;</td>
385           <td class="paramname"><em>input_ptr</em>, </td>
386         </tr>
387         <tr>
388           <td class="paramkey"></td>
389           <td></td>
390           <td class="paramtype">uint&#160;</td>
391           <td class="paramname"><em>input_stride_x</em>, </td>
392         </tr>
393         <tr>
394           <td class="paramkey"></td>
395           <td></td>
396           <td class="paramtype">uint&#160;</td>
397           <td class="paramname"><em>input_step_x</em>, </td>
398         </tr>
399         <tr>
400           <td class="paramkey"></td>
401           <td></td>
402           <td class="paramtype">uint&#160;</td>
403           <td class="paramname"><em>input_stride_y</em>, </td>
404         </tr>
405         <tr>
406           <td class="paramkey"></td>
407           <td></td>
408           <td class="paramtype">uint&#160;</td>
409           <td class="paramname"><em>input_step_y</em>, </td>
410         </tr>
411         <tr>
412           <td class="paramkey"></td>
413           <td></td>
414           <td class="paramtype">uint&#160;</td>
415           <td class="paramname"><em>input_offset_first_element_in_bytes</em>, </td>
416         </tr>
417         <tr>
418           <td class="paramkey"></td>
419           <td></td>
420           <td class="paramtype">__global uchar *&#160;</td>
421           <td class="paramname"><em>output_ptr</em>, </td>
422         </tr>
423         <tr>
424           <td class="paramkey"></td>
425           <td></td>
426           <td class="paramtype">uint&#160;</td>
427           <td class="paramname"><em>output_stride_x</em>, </td>
428         </tr>
429         <tr>
430           <td class="paramkey"></td>
431           <td></td>
432           <td class="paramtype">uint&#160;</td>
433           <td class="paramname"><em>output_step_x</em>, </td>
434         </tr>
435         <tr>
436           <td class="paramkey"></td>
437           <td></td>
438           <td class="paramtype">uint&#160;</td>
439           <td class="paramname"><em>output_stride_y</em>, </td>
440         </tr>
441         <tr>
442           <td class="paramkey"></td>
443           <td></td>
444           <td class="paramtype">uint&#160;</td>
445           <td class="paramname"><em>output_step_y</em>, </td>
446         </tr>
447         <tr>
448           <td class="paramkey"></td>
449           <td></td>
450           <td class="paramtype">uint&#160;</td>
451           <td class="paramname"><em>output_offset_first_element_in_bytes</em>, </td>
452         </tr>
453         <tr>
454           <td class="paramkey"></td>
455           <td></td>
456           <td class="paramtype">int2&#160;</td>
457           <td class="paramname"><em>max_dims</em>, </td>
458         </tr>
459         <tr>
460           <td class="paramkey"></td>
461           <td></td>
462           <td class="paramtype">int2&#160;</td>
463           <td class="paramname"><em>strides</em>, </td>
464         </tr>
465         <tr>
466           <td class="paramkey"></td>
467           <td></td>
468           <td class="paramtype">int2&#160;</td>
469           <td class="paramname"><em>paddings</em>&#160;</td>
470         </tr>
471         <tr>
472           <td></td>
473           <td>)</td>
474           <td></td><td></td>
475         </tr>
476       </table>
477 </div><div class="memdoc">
478
479 <p>Performs a pooling function of pool size equal to 3. </p>
480 <dl class="section note"><dt>Note</dt><dd>Pooling stride must be passed using -DPOOL_STRIDE e.g -DPOOL_STRIDE=2. Supported strides are 1,2,3 </dd>
481 <dd>
482 Datatype must be passed using -DDATA_TYPE e.g. -DDATA_TYPE=float. Supported data types are F16, F32; </dd>
483 <dd>
484 In case of average pooling -DPOOL_AVG must be provided otherwise max pooling will be performed.</dd></dl>
485 <dl class="params"><dt>Parameters</dt><dd>
486   <table class="params">
487     <tr><td class="paramdir">[in]</td><td class="paramname">input_ptr</td><td>Pointer to the source image. Supported data types: F16, F32 </td></tr>
488     <tr><td class="paramdir">[in]</td><td class="paramname">input_stride_x</td><td>Stride of the source image in X dimension (in bytes) </td></tr>
489     <tr><td class="paramdir">[in]</td><td class="paramname">input_step_x</td><td>input_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
490     <tr><td class="paramdir">[in]</td><td class="paramname">input_stride_y</td><td>Stride of the source image in Y dimension (in bytes) </td></tr>
491     <tr><td class="paramdir">[in]</td><td class="paramname">input_step_y</td><td>input_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
492     <tr><td class="paramdir">[in]</td><td class="paramname">input_offset_first_element_in_bytes</td><td>The offset of the first element in the source image </td></tr>
493     <tr><td class="paramdir">[out]</td><td class="paramname">output_ptr</td><td>Pointer to the destination image. Supported data types: F16, F32 </td></tr>
494     <tr><td class="paramdir">[in]</td><td class="paramname">output_stride_x</td><td>Stride of the destination image in X dimension (in bytes) </td></tr>
495     <tr><td class="paramdir">[in]</td><td class="paramname">output_step_x</td><td>output_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
496     <tr><td class="paramdir">[in]</td><td class="paramname">output_stride_y</td><td>Stride of the destination image in Y dimension (in bytes) </td></tr>
497     <tr><td class="paramdir">[in]</td><td class="paramname">output_step_y</td><td>output_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
498     <tr><td class="paramdir">[in]</td><td class="paramname">output_offset_first_element_in_bytes</td><td>The offset of the first element in the destination image </td></tr>
499     <tr><td class="paramdir">[in]</td><td class="paramname">max_dims</td><td>The maximum index that can be accessed in x and y dimension (width + pad) </td></tr>
500     <tr><td class="paramdir">[in]</td><td class="paramname">strides</td><td>The pooling operation strides in each dimension </td></tr>
501     <tr><td class="paramdir">[in]</td><td class="paramname">paddings</td><td>The pooling operation paddings in each dimension </td></tr>
502   </table>
503   </dd>
504 </dl>
505
506 <p>Definition at line <a class="el" href="pooling__layer_8cl_source.xhtml#l00118">118</a> of file <a class="el" href="pooling__layer_8cl_source.xhtml">pooling_layer.cl</a>.</p>
507
508 <p>References <a class="el" href="pooling__layer_8cl_source.xhtml#l00032">calculate_avg_scale()</a>, <a class="el" href="helpers_8h_source.xhtml#l00073">CONVERT_TO_IMAGE_STRUCT</a>, <a class="el" href="convolution3x3_8cl_source.xhtml#l00027">DATA_TYPE</a>, <a class="el" href="helpers_8h_source.xhtml#l00201">offset()</a>, <a class="el" href="pooling__layer_8cl_source.xhtml#l00027">POOL_OP</a>, <a class="el" href="helpers_8h_source.xhtml#l00097">Image::ptr</a>, and <a class="el" href="helpers_8h_source.xhtml#l00032">VEC_DATA_TYPE</a>.</p>
509 <div class="fragment"><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;{</div><div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;    <span class="comment">// Get pixels pointer</span></div><div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;    <a class="code" href="struct_image.xhtml">Image</a> input  = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(input);</div><div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;    <a class="code" href="struct_image.xhtml">Image</a> output = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(output);</div><div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;</div><div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;    <span class="comment">// Load data</span></div><div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;    <a class="code" href="helpers_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(<a class="code" href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a>, 3)</div><div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;    data0 = vload3(0, (__global <a class="code" href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a> *)<a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>(&amp;input, 0, 0));</div><div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;    <a class="code" href="helpers_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(<a class="code" href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a>, 3)</div><div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;    data1 = vload3(0, (__global DATA_TYPE *)<a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>(&amp;input, 0, 1));</div><div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;    <a class="code" href="helpers_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(DATA_TYPE, 3)</div><div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;    data2 = vload3(0, (__global DATA_TYPE *)<a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>(&amp;input, 0, 2));</div><div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;</div><div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;    <span class="comment">// Perform calculations</span></div><div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;    data0         = <a class="code" href="pooling__layer_8cl.xhtml#a482ef7d59a5f474ca126e737c7f0978a">POOL_OP</a>(data0, data1);</div><div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;    data0         = <a class="code" href="pooling__layer_8cl.xhtml#a482ef7d59a5f474ca126e737c7f0978a">POOL_OP</a>(data0, data2);</div><div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;    DATA_TYPE res = <a class="code" href="pooling__layer_8cl.xhtml#a482ef7d59a5f474ca126e737c7f0978a">POOL_OP</a>(<a class="code" href="pooling__layer_8cl.xhtml#a482ef7d59a5f474ca126e737c7f0978a">POOL_OP</a>(data0.s0, data0.s1), data0.s2);</div><div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;</div><div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;    <span class="comment">// Divide by 4 in case of average pooling</span></div><div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="preprocessor">#ifdef POOL_AVG</span></div><div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;    res *= <a class="code" href="pooling__layer_8cl.xhtml#a60440813daa769d486c5786d52b91340">calculate_avg_scale</a>(3, max_dims.x, max_dims.y, paddings.x, paddings.y, strides.x, strides.y);</div><div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;</div><div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;    <span class="comment">// Store result</span></div><div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;    *(__global DATA_TYPE *)output.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a> = res;</div><div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;}</div><div class="ttc" id="pooling__layer_8cl_xhtml_a482ef7d59a5f474ca126e737c7f0978a"><div class="ttname"><a href="pooling__layer_8cl.xhtml#a482ef7d59a5f474ca126e737c7f0978a">POOL_OP</a></div><div class="ttdeci">#define POOL_OP(x, y)</div><div class="ttdef"><b>Definition:</b> <a href="pooling__layer_8cl_source.xhtml#l00027">pooling_layer.cl:27</a></div></div>
510 <div class="ttc" id="convolution3x3_8cl_xhtml_afb8c72ce35c4a1f4a2588d6573e54aa1"><div class="ttname"><a href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a></div><div class="ttdeci">#define DATA_TYPE</div><div class="ttdef"><b>Definition:</b> <a href="convolution3x3_8cl_source.xhtml#l00027">convolution3x3.cl:27</a></div></div>
511 <div class="ttc" id="pooling__layer_8cl_xhtml_a60440813daa769d486c5786d52b91340"><div class="ttname"><a href="pooling__layer_8cl.xhtml#a60440813daa769d486c5786d52b91340">calculate_avg_scale</a></div><div class="ttdeci">float calculate_avg_scale(const int pool_size, const int upper_bound_w, const int upper_bound_h, const int pad_x, const int pad_y, const int stride_x, const int stride_y)</div><div class="ttdef"><b>Definition:</b> <a href="pooling__layer_8cl_source.xhtml#l00032">pooling_layer.cl:32</a></div></div>
512 <div class="ttc" id="helpers_8h_xhtml_a009469e4d9b8fce3b6d5e97d2077827d"><div class="ttname"><a href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a></div><div class="ttdeci">__global uchar * offset(const Image *img, int x, int y)</div><div class="ttdoc">Get the pointer position of a Image. </div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00201">helpers.h:201</a></div></div>
513 <div class="ttc" id="helpers_8h_xhtml_aebe814363556c244be043b13e7969197"><div class="ttname"><a href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a></div><div class="ttdeci">#define CONVERT_TO_IMAGE_STRUCT(name)</div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00073">helpers.h:73</a></div></div>
514 <div class="ttc" id="helpers_8h_xhtml_a36f754c05b6fddf6df0d8d0a74f8159f"><div class="ttname"><a href="helpers_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a></div><div class="ttdeci">#define VEC_DATA_TYPE(type, size)</div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00032">helpers.h:32</a></div></div>
515 <div class="ttc" id="struct_image_xhtml"><div class="ttname"><a href="struct_image.xhtml">Image</a></div><div class="ttdoc">Structure to hold Image information. </div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00095">helpers.h:95</a></div></div>
516 <div class="ttc" id="struct_image_xhtml_acf52c23cbd7424606c10a606524e3e32"><div class="ttname"><a href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">Image::ptr</a></div><div class="ttdeci">__global uchar * ptr</div><div class="ttdoc">Pointer to the starting postion of the buffer. </div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00097">helpers.h:97</a></div></div>
517 </div><!-- fragment -->
518 </div>
519 </div>
520 </div><!-- contents -->
521 </div><!-- doc-content -->
522 <!-- start footer part -->
523 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
524   <ul>
525     <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.xhtml">core</a></li><li class="navelem"><a class="el" href="dir_8c278f79c760e5c5fbd911f9870614c1.xhtml">CL</a></li><li class="navelem"><a class="el" href="dir_25885286e9dad4fa105b7b25a8031bbf.xhtml">cl_kernels</a></li><li class="navelem"><a class="el" href="pooling__layer_8cl.xhtml">pooling_layer.cl</a></li>
526     <li class="footer">Generated on Wed Apr 12 2017 14:26:05 for ARM Compute Library by
527     <a href="http://www.doxygen.org/index.html">
528     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
529   </ul>
530 </div>
531 </body>
532 </html>