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">
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);
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(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
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" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">ARM Compute Library
43  <span id="projectnumber">17.03.1</span>
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');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main Page</span></a></li>
58 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
59 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
60 <li class="current"><a href="files.xhtml"><span>Files</span></a></li>
62 <div id="MSearchBox" class="MSearchBoxInactive">
64 <img id="MSearchSelect" src="search/mag_sel.png"
65 onmouseover="return searchBox.OnSearchSelectShow()"
66 onmouseout="return searchBox.OnSearchSelectHide()"
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>
79 <div id="navrow2" class="tabs2">
81 <li><a href="files.xhtml"><span>File List</span></a></li>
82 <li><a href="globals.xhtml"><span>Globals</span></a></li>
86 <div id="side-nav" class="ui-resizable side-nav-resizable">
88 <div id="nav-tree-contents">
89 <div id="nav-sync" class="sync"></div>
92 <div id="splitbar" style="-moz-user-select:none;"
93 class="ui-resizable-handle">
96 <script type="text/javascript">
97 $(document).ready(function(){initNavTree('pooling__layer_8cl.xhtml','');});
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)">
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">
115 <div class="summary">
116 <a href="#define-members">Macros</a> |
117 <a href="#func-members">Functions</a> </div>
118 <div class="headertitle">
119 <div class="title">pooling_layer.cl File Reference</div> </div>
121 <div class="contents">
122 <div class="textblock"><code>#include "<a class="el" href="helpers_8h_source.xhtml">helpers.h</a>"</code><br />
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 </td><td class="memItemRight" valign="bottom"><a class="el" href="pooling__layer_8cl.xhtml#a482ef7d59a5f474ca126e737c7f0978a">POOL_OP</a>(x, y)   ((x) + (y))</td></tr>
129 <tr class="separator:a482ef7d59a5f474ca126e737c7f0978a"><td class="memSeparator" colspan="2"> </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 </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"> </td></tr>
135 <tr class="memitem:ac5df4051328f567787660fd319694842"><td class="memItemLeft" align="right" valign="top">__kernel void </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"> </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"> </td></tr>
138 <tr class="memitem:a0c8f47e252a2f3e9d9f2ba3bf197846b"><td class="memItemLeft" align="right" valign="top">__kernel void </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"> </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"> </td></tr>
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">
148 <td class="memname">#define POOL_OP</td>
150 <td class="paramtype"> </td>
151 <td class="paramname">x, </td>
154 <td class="paramkey"></td>
156 <td class="paramtype"> </td>
157 <td class="paramname">y </td>
162 <td></td><td>   ((x) + (y))</td>
165 </div><div class="memdoc">
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>
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>
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">
179 <td class="memname">float calculate_avg_scale </td>
181 <td class="paramtype">const int </td>
182 <td class="paramname"><em>pool_size</em>, </td>
185 <td class="paramkey"></td>
187 <td class="paramtype">const int </td>
188 <td class="paramname"><em>upper_bound_w</em>, </td>
191 <td class="paramkey"></td>
193 <td class="paramtype">const int </td>
194 <td class="paramname"><em>upper_bound_h</em>, </td>
197 <td class="paramkey"></td>
199 <td class="paramtype">const int </td>
200 <td class="paramname"><em>pad_x</em>, </td>
203 <td class="paramkey"></td>
205 <td class="paramtype">const int </td>
206 <td class="paramname"><em>pad_y</em>, </td>
209 <td class="paramkey"></td>
211 <td class="paramtype">const int </td>
212 <td class="paramname"><em>stride_x</em>, </td>
215 <td class="paramkey"></td>
217 <td class="paramtype">const int </td>
218 <td class="paramname"><em>stride_y</em> </td>
226 </div><div class="memdoc">
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>
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> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <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>  <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>  <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>  <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>  <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> }</div></div><!-- fragment -->
234 <a class="anchor" id="ac5df4051328f567787660fd319694842"></a>
235 <div class="memitem">
236 <div class="memproto">
237 <table class="memname">
239 <td class="memname">__kernel void pooling_layer_2 </td>
241 <td class="paramtype">__global uchar * </td>
242 <td class="paramname"><em>input_ptr</em>, </td>
245 <td class="paramkey"></td>
247 <td class="paramtype">uint </td>
248 <td class="paramname"><em>input_stride_x</em>, </td>
251 <td class="paramkey"></td>
253 <td class="paramtype">uint </td>
254 <td class="paramname"><em>input_step_x</em>, </td>
257 <td class="paramkey"></td>
259 <td class="paramtype">uint </td>
260 <td class="paramname"><em>input_stride_y</em>, </td>
263 <td class="paramkey"></td>
265 <td class="paramtype">uint </td>
266 <td class="paramname"><em>input_step_y</em>, </td>
269 <td class="paramkey"></td>
271 <td class="paramtype">uint </td>
272 <td class="paramname"><em>input_offset_first_element_in_bytes</em>, </td>
275 <td class="paramkey"></td>
277 <td class="paramtype">__global uchar * </td>
278 <td class="paramname"><em>output_ptr</em>, </td>
281 <td class="paramkey"></td>
283 <td class="paramtype">uint </td>
284 <td class="paramname"><em>output_stride_x</em>, </td>
287 <td class="paramkey"></td>
289 <td class="paramtype">uint </td>
290 <td class="paramname"><em>output_step_x</em>, </td>
293 <td class="paramkey"></td>
295 <td class="paramtype">uint </td>
296 <td class="paramname"><em>output_stride_y</em>, </td>
299 <td class="paramkey"></td>
301 <td class="paramtype">uint </td>
302 <td class="paramname"><em>output_step_y</em>, </td>
305 <td class="paramkey"></td>
307 <td class="paramtype">uint </td>
308 <td class="paramname"><em>output_offset_first_element_in_bytes</em>, </td>
311 <td class="paramkey"></td>
313 <td class="paramtype">int2 </td>
314 <td class="paramname"><em>max_dims</em>, </td>
317 <td class="paramkey"></td>
319 <td class="paramtype">int2 </td>
320 <td class="paramname"><em>strides</em>, </td>
323 <td class="paramkey"></td>
325 <td class="paramtype">int2 </td>
326 <td class="paramname"><em>paddings</em> </td>
334 </div><div class="memdoc">
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>
339 Datatype must be passed using -DDATA_TYPE e.g. -DDATA_TYPE=float. Supported data types are F16, F32; </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>
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>
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> {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// Get pixels pointer</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <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>  <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> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// Load data</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <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>  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>(&input, 0, 0));</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <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>  data1 = vload2(0, (__global DATA_TYPE *)<a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>(&input, 0, 1));</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// Perform calculations</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  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>  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> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <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> <span class="preprocessor">#ifdef POOL_AVG</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  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> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">// Store result</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  *(__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> }</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 -->
377 <a class="anchor" id="a0c8f47e252a2f3e9d9f2ba3bf197846b"></a>
378 <div class="memitem">
379 <div class="memproto">
380 <table class="memname">
382 <td class="memname">__kernel void pooling_layer_3 </td>
384 <td class="paramtype">__global uchar * </td>
385 <td class="paramname"><em>input_ptr</em>, </td>
388 <td class="paramkey"></td>
390 <td class="paramtype">uint </td>
391 <td class="paramname"><em>input_stride_x</em>, </td>
394 <td class="paramkey"></td>
396 <td class="paramtype">uint </td>
397 <td class="paramname"><em>input_step_x</em>, </td>
400 <td class="paramkey"></td>
402 <td class="paramtype">uint </td>
403 <td class="paramname"><em>input_stride_y</em>, </td>
406 <td class="paramkey"></td>
408 <td class="paramtype">uint </td>
409 <td class="paramname"><em>input_step_y</em>, </td>
412 <td class="paramkey"></td>
414 <td class="paramtype">uint </td>
415 <td class="paramname"><em>input_offset_first_element_in_bytes</em>, </td>
418 <td class="paramkey"></td>
420 <td class="paramtype">__global uchar * </td>
421 <td class="paramname"><em>output_ptr</em>, </td>
424 <td class="paramkey"></td>
426 <td class="paramtype">uint </td>
427 <td class="paramname"><em>output_stride_x</em>, </td>
430 <td class="paramkey"></td>
432 <td class="paramtype">uint </td>
433 <td class="paramname"><em>output_step_x</em>, </td>
436 <td class="paramkey"></td>
438 <td class="paramtype">uint </td>
439 <td class="paramname"><em>output_stride_y</em>, </td>
442 <td class="paramkey"></td>
444 <td class="paramtype">uint </td>
445 <td class="paramname"><em>output_step_y</em>, </td>
448 <td class="paramkey"></td>
450 <td class="paramtype">uint </td>
451 <td class="paramname"><em>output_offset_first_element_in_bytes</em>, </td>
454 <td class="paramkey"></td>
456 <td class="paramtype">int2 </td>
457 <td class="paramname"><em>max_dims</em>, </td>
460 <td class="paramkey"></td>
462 <td class="paramtype">int2 </td>
463 <td class="paramname"><em>strides</em>, </td>
466 <td class="paramkey"></td>
468 <td class="paramtype">int2 </td>
469 <td class="paramname"><em>paddings</em> </td>
477 </div><div class="memdoc">
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>
482 Datatype must be passed using -DDATA_TYPE e.g. -DDATA_TYPE=float. Supported data types are F16, F32; </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>
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>
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> {</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="comment">// Get pixels pointer</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <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>  <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> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="comment">// Load data</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <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>  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>(&input, 0, 0));</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <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>  data1 = vload3(0, (__global DATA_TYPE *)<a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>(&input, 0, 1));</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <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>  data2 = vload3(0, (__global DATA_TYPE *)<a class="code" href="helpers_8h.xhtml#a009469e4d9b8fce3b6d5e97d2077827d">offset</a>(&input, 0, 2));</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="comment">// Perform calculations</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  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>  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>  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> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <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> <span class="preprocessor">#ifdef POOL_AVG</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  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> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="comment">// Store result</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  *(__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> }</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 -->
520 </div><!-- contents -->
521 </div><!-- doc-content -->
522 <!-- start footer part -->
523 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
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 Fri Mar 24 2017 17:23:50 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>