arm_compute v17.04
[platform/upstream/armcl.git] / documentation / accumulate_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/accumulate.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('accumulate_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="#func-members">Functions</a>  </div>
117   <div class="headertitle">
118 <div class="title">accumulate.cl File Reference</div>  </div>
119 </div><!--header-->
120 <div class="contents">
121 <div class="textblock"><code>#include &quot;<a class="el" href="helpers_8h_source.xhtml">helpers.h</a>&quot;</code><br />
122 </div>
123 <p><a href="accumulate_8cl_source.xhtml">Go to the source code of this file.</a></p>
124 <table class="memberdecls">
125 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
126 Functions</h2></td></tr>
127 <tr class="memitem:a00e540076dd545ad59ac7482f8cdf514"><td class="memItemLeft" align="right" valign="top">__kernel void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="accumulate_8cl.xhtml#a00e540076dd545ad59ac7482f8cdf514">accumulate</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 *accu_ptr, uint accu_stride_x, uint accu_step_x, uint accu_stride_y, uint accu_step_y, uint accu_offset_first_element_in_bytes)</td></tr>
128 <tr class="memdesc:a00e540076dd545ad59ac7482f8cdf514"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function accumulates an input image into output image.  <a href="#a00e540076dd545ad59ac7482f8cdf514">More...</a><br /></td></tr>
129 <tr class="separator:a00e540076dd545ad59ac7482f8cdf514"><td class="memSeparator" colspan="2">&#160;</td></tr>
130 <tr class="memitem:ab64020e40663a4356d6037079d7292fb"><td class="memItemLeft" align="right" valign="top">__kernel void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="accumulate_8cl.xhtml#ab64020e40663a4356d6037079d7292fb">accumulate_weighted</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 *accu_ptr, uint accu_stride_x, uint accu_step_x, uint accu_stride_y, uint accu_step_y, uint accu_offset_first_element_in_bytes, const float alpha)</td></tr>
131 <tr class="memdesc:ab64020e40663a4356d6037079d7292fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function accumulates a weighted value from an input image to an output image.  <a href="#ab64020e40663a4356d6037079d7292fb">More...</a><br /></td></tr>
132 <tr class="separator:ab64020e40663a4356d6037079d7292fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
133 <tr class="memitem:aa6efbf07a1932e211879a0df54e9f50f"><td class="memItemLeft" align="right" valign="top">__kernel void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="accumulate_8cl.xhtml#aa6efbf07a1932e211879a0df54e9f50f">accumulate_squared</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 *accu_ptr, uint accu_stride_x, uint accu_step_x, uint accu_stride_y, uint accu_step_y, uint accu_offset_first_element_in_bytes, const uint shift)</td></tr>
134 <tr class="memdesc:aa6efbf07a1932e211879a0df54e9f50f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function accumulates a squared value from an input image to an output image.  <a href="#aa6efbf07a1932e211879a0df54e9f50f">More...</a><br /></td></tr>
135 <tr class="separator:aa6efbf07a1932e211879a0df54e9f50f"><td class="memSeparator" colspan="2">&#160;</td></tr>
136 </table>
137 <h2 class="groupheader">Function Documentation</h2>
138 <a class="anchor" id="a00e540076dd545ad59ac7482f8cdf514"></a>
139 <div class="memitem">
140 <div class="memproto">
141       <table class="memname">
142         <tr>
143           <td class="memname">__kernel void accumulate </td>
144           <td>(</td>
145           <td class="paramtype">__global uchar *&#160;</td>
146           <td class="paramname"><em>input_ptr</em>, </td>
147         </tr>
148         <tr>
149           <td class="paramkey"></td>
150           <td></td>
151           <td class="paramtype">uint&#160;</td>
152           <td class="paramname"><em>input_stride_x</em>, </td>
153         </tr>
154         <tr>
155           <td class="paramkey"></td>
156           <td></td>
157           <td class="paramtype">uint&#160;</td>
158           <td class="paramname"><em>input_step_x</em>, </td>
159         </tr>
160         <tr>
161           <td class="paramkey"></td>
162           <td></td>
163           <td class="paramtype">uint&#160;</td>
164           <td class="paramname"><em>input_stride_y</em>, </td>
165         </tr>
166         <tr>
167           <td class="paramkey"></td>
168           <td></td>
169           <td class="paramtype">uint&#160;</td>
170           <td class="paramname"><em>input_step_y</em>, </td>
171         </tr>
172         <tr>
173           <td class="paramkey"></td>
174           <td></td>
175           <td class="paramtype">uint&#160;</td>
176           <td class="paramname"><em>input_offset_first_element_in_bytes</em>, </td>
177         </tr>
178         <tr>
179           <td class="paramkey"></td>
180           <td></td>
181           <td class="paramtype">__global uchar *&#160;</td>
182           <td class="paramname"><em>accu_ptr</em>, </td>
183         </tr>
184         <tr>
185           <td class="paramkey"></td>
186           <td></td>
187           <td class="paramtype">uint&#160;</td>
188           <td class="paramname"><em>accu_stride_x</em>, </td>
189         </tr>
190         <tr>
191           <td class="paramkey"></td>
192           <td></td>
193           <td class="paramtype">uint&#160;</td>
194           <td class="paramname"><em>accu_step_x</em>, </td>
195         </tr>
196         <tr>
197           <td class="paramkey"></td>
198           <td></td>
199           <td class="paramtype">uint&#160;</td>
200           <td class="paramname"><em>accu_stride_y</em>, </td>
201         </tr>
202         <tr>
203           <td class="paramkey"></td>
204           <td></td>
205           <td class="paramtype">uint&#160;</td>
206           <td class="paramname"><em>accu_step_y</em>, </td>
207         </tr>
208         <tr>
209           <td class="paramkey"></td>
210           <td></td>
211           <td class="paramtype">uint&#160;</td>
212           <td class="paramname"><em>accu_offset_first_element_in_bytes</em>&#160;</td>
213         </tr>
214         <tr>
215           <td></td>
216           <td>)</td>
217           <td></td><td></td>
218         </tr>
219       </table>
220 </div><div class="memdoc">
221
222 <p>This function accumulates an input image into output image. </p>
223 <dl class="params"><dt>Parameters</dt><dd>
224   <table class="params">
225     <tr><td class="paramdir">[in]</td><td class="paramname">input_ptr</td><td>Pointer to the source image. Supported data types: U8 </td></tr>
226     <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>
227     <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>
228     <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>
229     <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>
230     <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>
231     <tr><td class="paramdir">[out]</td><td class="paramname">accu_ptr</td><td>Pointer to the destination image. Supported data types: S16 </td></tr>
232     <tr><td class="paramdir">[in]</td><td class="paramname">accu_stride_x</td><td>Stride of the destination image in X dimension (in bytes) </td></tr>
233     <tr><td class="paramdir">[in]</td><td class="paramname">accu_step_x</td><td>accu_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
234     <tr><td class="paramdir">[in]</td><td class="paramname">accu_stride_y</td><td>Stride of the destination image in Y dimension (in bytes) </td></tr>
235     <tr><td class="paramdir">[in]</td><td class="paramname">accu_step_y</td><td>accu_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
236     <tr><td class="paramdir">[in]</td><td class="paramname">accu_offset_first_element_in_bytes</td><td>The offset of the first element in the destination image </td></tr>
237   </table>
238   </dd>
239 </dl>
240
241 <p>Definition at line <a class="el" href="accumulate_8cl_source.xhtml#l00041">41</a> of file <a class="el" href="accumulate_8cl_source.xhtml">accumulate.cl</a>.</p>
242
243 <p>References <a class="el" href="helpers_8h_source.xhtml#l00073">CONVERT_TO_IMAGE_STRUCT</a>, and <a class="el" href="helpers_8h_source.xhtml#l00097">Image::ptr</a>.</p>
244
245 <p>Referenced by <a class="el" href="arm__compute_2core_2_utils_8h_source.xhtml#l00419">arm_compute::calculate_matrix_scale()</a>, <a class="el" href="arm__compute_2core_2_utils_8h_source.xhtml#l00435">arm_compute::data_type_for_convolution()</a>, <a class="el" href="arm__compute_2core_2_utils_8h_source.xhtml#l00491">arm_compute::data_type_for_convolution_matrix()</a>, <a class="el" href="_tensor_shape_8h_source.xhtml#l00068">TensorShape::total_size()</a>, and <a class="el" href="_tensor_shape_8h_source.xhtml#l00082">TensorShape::total_size_upper()</a>.</p>
246 <div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;{</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="comment">// Get pixels pointer</span></div><div class="line"><a name="l00046"></a><span class="lineno">   46</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="l00047"></a><span class="lineno">   47</span>&#160;    <a class="code" href="struct_image.xhtml">Image</a> accu  = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(accu);</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="comment">// Load data</span></div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    uchar16 in_data   = vload16(0, input.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>);</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    short16 accu_data = vload16(0, (__global <span class="keywordtype">short</span> *)accu.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>);</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    <span class="comment">// Perform accumulation</span></div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    short16 res = add_sat(convert_short16(in_data), accu_data);</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    <span class="comment">// Store result</span></div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    vstore16(res, 0, (__global <span class="keywordtype">short</span> *)accu.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>);</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;}</div><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>
247 <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>
248 <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>
249 </div><!-- fragment -->
250 </div>
251 </div>
252 <a class="anchor" id="aa6efbf07a1932e211879a0df54e9f50f"></a>
253 <div class="memitem">
254 <div class="memproto">
255       <table class="memname">
256         <tr>
257           <td class="memname">__kernel void accumulate_squared </td>
258           <td>(</td>
259           <td class="paramtype">__global uchar *&#160;</td>
260           <td class="paramname"><em>input_ptr</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_stride_x</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_step_x</em>, </td>
273         </tr>
274         <tr>
275           <td class="paramkey"></td>
276           <td></td>
277           <td class="paramtype">uint&#160;</td>
278           <td class="paramname"><em>input_stride_y</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>input_step_y</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>input_offset_first_element_in_bytes</em>, </td>
291         </tr>
292         <tr>
293           <td class="paramkey"></td>
294           <td></td>
295           <td class="paramtype">__global uchar *&#160;</td>
296           <td class="paramname"><em>accu_ptr</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>accu_stride_x</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>accu_step_x</em>, </td>
309         </tr>
310         <tr>
311           <td class="paramkey"></td>
312           <td></td>
313           <td class="paramtype">uint&#160;</td>
314           <td class="paramname"><em>accu_stride_y</em>, </td>
315         </tr>
316         <tr>
317           <td class="paramkey"></td>
318           <td></td>
319           <td class="paramtype">uint&#160;</td>
320           <td class="paramname"><em>accu_step_y</em>, </td>
321         </tr>
322         <tr>
323           <td class="paramkey"></td>
324           <td></td>
325           <td class="paramtype">uint&#160;</td>
326           <td class="paramname"><em>accu_offset_first_element_in_bytes</em>, </td>
327         </tr>
328         <tr>
329           <td class="paramkey"></td>
330           <td></td>
331           <td class="paramtype">const uint&#160;</td>
332           <td class="paramname"><em>shift</em>&#160;</td>
333         </tr>
334         <tr>
335           <td></td>
336           <td>)</td>
337           <td></td><td></td>
338         </tr>
339       </table>
340 </div><div class="memdoc">
341
342 <p>This function accumulates a squared value from an input image to an output image. </p>
343 <dl class="params"><dt>Parameters</dt><dd>
344   <table class="params">
345     <tr><td class="paramdir">[in]</td><td class="paramname">input_ptr</td><td>Pointer to the source image. Supported data types: U8 </td></tr>
346     <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>
347     <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>
348     <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>
349     <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>
350     <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>
351     <tr><td class="paramdir">[out]</td><td class="paramname">accu_ptr</td><td>Pointer to the destination image. Supported data types: S16 </td></tr>
352     <tr><td class="paramdir">[in]</td><td class="paramname">accu_stride_x</td><td>Stride of the destination image in X dimension (in bytes) </td></tr>
353     <tr><td class="paramdir">[in]</td><td class="paramname">accu_step_x</td><td>accu_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
354     <tr><td class="paramdir">[in]</td><td class="paramname">accu_stride_y</td><td>Stride of the destination image in Y dimension (in bytes) </td></tr>
355     <tr><td class="paramdir">[in]</td><td class="paramname">accu_step_y</td><td>accu_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
356     <tr><td class="paramdir">[in]</td><td class="paramname">accu_offset_first_element_in_bytes</td><td>The offset of the first element in the destination image </td></tr>
357     <tr><td class="paramdir">[in]</td><td class="paramname">shift</td><td>The U32 scalar value with a value in the range of 0 to 15 </td></tr>
358   </table>
359   </dd>
360 </dl>
361
362 <p>Definition at line <a class="el" href="accumulate_8cl_source.xhtml#l00112">112</a> of file <a class="el" href="accumulate_8cl_source.xhtml">accumulate.cl</a>.</p>
363
364 <p>References <a class="el" href="helpers_8h_source.xhtml#l00073">CONVERT_TO_IMAGE_STRUCT</a>, and <a class="el" href="helpers_8h_source.xhtml#l00097">Image::ptr</a>.</p>
365 <div class="fragment"><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;{</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;    <span class="comment">// Get pixels pointer</span></div><div class="line"><a name="l00118"></a><span class="lineno">  118</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="l00119"></a><span class="lineno">  119</span>&#160;    <a class="code" href="struct_image.xhtml">Image</a> accu  = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(accu);</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;</div><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;    <span class="comment">// Load data</span></div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    ushort16 in_data   = convert_ushort16(vload16(0, input.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>));</div><div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;    uint16   accu_data = convert_uint16(vload16(0, (__global <span class="keywordtype">short</span> *)accu.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>));</div><div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;    <span class="comment">// Calculate squared accumulation</span></div><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;    short16 res = convert_short16_sat(accu_data + convert_uint16((in_data * in_data) &gt;&gt; shift));</div><div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;</div><div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;    <span class="comment">// Store result</span></div><div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;    vstore16(res, 0, (__global <span class="keywordtype">short</span> *)accu.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>);</div><div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;}</div><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>
366 <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>
367 <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>
368 </div><!-- fragment -->
369 </div>
370 </div>
371 <a class="anchor" id="ab64020e40663a4356d6037079d7292fb"></a>
372 <div class="memitem">
373 <div class="memproto">
374       <table class="memname">
375         <tr>
376           <td class="memname">__kernel void accumulate_weighted </td>
377           <td>(</td>
378           <td class="paramtype">__global uchar *&#160;</td>
379           <td class="paramname"><em>input_ptr</em>, </td>
380         </tr>
381         <tr>
382           <td class="paramkey"></td>
383           <td></td>
384           <td class="paramtype">uint&#160;</td>
385           <td class="paramname"><em>input_stride_x</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_step_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_stride_y</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_step_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_offset_first_element_in_bytes</em>, </td>
410         </tr>
411         <tr>
412           <td class="paramkey"></td>
413           <td></td>
414           <td class="paramtype">__global uchar *&#160;</td>
415           <td class="paramname"><em>accu_ptr</em>, </td>
416         </tr>
417         <tr>
418           <td class="paramkey"></td>
419           <td></td>
420           <td class="paramtype">uint&#160;</td>
421           <td class="paramname"><em>accu_stride_x</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>accu_step_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>accu_stride_y</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>accu_step_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>accu_offset_first_element_in_bytes</em>, </td>
446         </tr>
447         <tr>
448           <td class="paramkey"></td>
449           <td></td>
450           <td class="paramtype">const float&#160;</td>
451           <td class="paramname"><em>alpha</em>&#160;</td>
452         </tr>
453         <tr>
454           <td></td>
455           <td>)</td>
456           <td></td><td></td>
457         </tr>
458       </table>
459 </div><div class="memdoc">
460
461 <p>This function accumulates a weighted value from an input image to an output image. </p>
462 <dl class="params"><dt>Parameters</dt><dd>
463   <table class="params">
464     <tr><td class="paramdir">[in]</td><td class="paramname">input_ptr</td><td>Pointer to the source image. Supported data types: U8 </td></tr>
465     <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>
466     <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>
467     <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>
468     <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>
469     <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>
470     <tr><td class="paramdir">[out]</td><td class="paramname">accu_ptr</td><td>Pointer to the destination image. Supported data types: S16 </td></tr>
471     <tr><td class="paramdir">[in]</td><td class="paramname">accu_stride_x</td><td>Stride of the destination image in X dimension (in bytes) </td></tr>
472     <tr><td class="paramdir">[in]</td><td class="paramname">accu_step_x</td><td>accu_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
473     <tr><td class="paramdir">[in]</td><td class="paramname">accu_stride_y</td><td>Stride of the destination image in Y dimension (in bytes) </td></tr>
474     <tr><td class="paramdir">[in]</td><td class="paramname">accu_step_y</td><td>accu_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
475     <tr><td class="paramdir">[in]</td><td class="paramname">accu_offset_first_element_in_bytes</td><td>The offset of the first element in the destination image </td></tr>
476     <tr><td class="paramdir">[in]</td><td class="paramname">alpha</td><td>The float scalar value with a value in the range of 0 to 1 </td></tr>
477   </table>
478   </dd>
479 </dl>
480
481 <p>Definition at line <a class="el" href="accumulate_8cl_source.xhtml#l00076">76</a> of file <a class="el" href="accumulate_8cl_source.xhtml">accumulate.cl</a>.</p>
482
483 <p>References <a class="el" href="helpers_8h_source.xhtml#l00073">CONVERT_TO_IMAGE_STRUCT</a>, and <a class="el" href="helpers_8h_source.xhtml#l00097">Image::ptr</a>.</p>
484 <div class="fragment"><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;{</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    <span class="comment">// Get pixels pointer</span></div><div class="line"><a name="l00082"></a><span class="lineno">   82</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="l00083"></a><span class="lineno">   83</span>&#160;    <a class="code" href="struct_image.xhtml">Image</a> accu  = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(accu);</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    <span class="comment">// Load data</span></div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    <span class="keyword">const</span> float16 in_data   = convert_float16(vload16(0, input.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>));</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    <span class="keyword">const</span> float16 accu_data = convert_float16(vload16(0, accu.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>));</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;    <span class="comment">// Calculate weighted accumulation</span></div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    <span class="keyword">const</span> uchar16 res = convert_uchar16((1.0f - alpha) * accu_data + alpha * in_data);</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;    vstore16(res, 0, accu.<a class="code" href="struct_image.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>);</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;}</div><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>
485 <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>
486 <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>
487 </div><!-- fragment -->
488 </div>
489 </div>
490 </div><!-- contents -->
491 </div><!-- doc-content -->
492 <!-- start footer part -->
493 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
494   <ul>
495     <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="accumulate_8cl.xhtml">accumulate.cl</a></li>
496     <li class="footer">Generated on Wed Apr 12 2017 14:26:05 for ARM Compute Library by
497     <a href="http://www.doxygen.org/index.html">
498     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
499   </ul>
500 </div>
501 </body>
502 </html>