Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ComputeLibrary / 871448ee8eff790c4ccc3250008dd71170cc78b2 / . / documentation / arithmetic__op_8cl.xhtml
blob: 5c8fc5ed9dadb30513801a95a9fe88276f06b490 [file] [log] [blame]
Anthony Barbier871448e2017-03-24 14:54:29 +0000[diff] [blame^]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/arithmetic_op.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.03.1</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">
53var 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('arithmetic__op_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">arithmetic_op.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="arithmetic__op_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>
127Macros</h2></td></tr>
128<tr class="memitem:af3b709fb668cf93ca09e2a46a2a031a8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arithmetic__op_8cl.xhtml#af3b709fb668cf93ca09e2a46a2a031a8">ADD</a>(x, y)&#160;&#160;&#160;(x) + (y)</td></tr>
129<tr class="separator:af3b709fb668cf93ca09e2a46a2a031a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
130<tr class="memitem:aafc2c4f262a0686c07f86c7d2e1d8d14"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arithmetic__op_8cl.xhtml#aafc2c4f262a0686c07f86c7d2e1d8d14">SUB</a>(x, y)&#160;&#160;&#160;(x) - (y)</td></tr>
131<tr class="separator:aafc2c4f262a0686c07f86c7d2e1d8d14"><td class="memSeparator" colspan="2">&#160;</td></tr>
132</table><table class="memberdecls">
133<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
134Functions</h2></td></tr>
135<tr class="memitem:a3e7b06c866bbf410b0c4ec80a73084a9"><td class="memItemLeft" align="right" valign="top">__kernel void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arithmetic__op_8cl.xhtml#a3e7b06c866bbf410b0c4ec80a73084a9">arithmetic_add</a> (__global uchar *in1_ptr, uint in1_stride_x, uint in1_step_x, uint in1_stride_y, uint in1_step_y, uint in1_offset_first_element_in_bytes, __global uchar *in2_ptr, uint in2_stride_x, uint in2_step_x, uint in2_stride_y, uint in2_step_y, uint in2_offset_first_element_in_bytes, __global uchar *out_ptr, uint out_stride_x, uint out_step_x, uint out_stride_y, uint out_step_y, uint out_offset_first_element_in_bytes)</td></tr>
136<tr class="memdesc:a3e7b06c866bbf410b0c4ec80a73084a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function add two images. <a href="#a3e7b06c866bbf410b0c4ec80a73084a9">More...</a><br /></td></tr>
137<tr class="separator:a3e7b06c866bbf410b0c4ec80a73084a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
138<tr class="memitem:a9524adc496c5155e4215068005ac6da5"><td class="memItemLeft" align="right" valign="top">__kernel void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arithmetic__op_8cl.xhtml#a9524adc496c5155e4215068005ac6da5">arithmetic_sub</a> (__global uchar *in1_ptr, uint in1_stride_x, uint in1_step_x, uint in1_stride_y, uint in1_step_y, uint in1_offset_first_element_in_bytes, __global uchar *in2_ptr, uint in2_stride_x, uint in2_step_x, uint in2_stride_y, uint in2_step_y, uint in2_offset_first_element_in_bytes, __global uchar *out_ptr, uint out_stride_x, uint out_step_x, uint out_stride_y, uint out_step_y, uint out_offset_first_element_in_bytes)</td></tr>
139<tr class="memdesc:a9524adc496c5155e4215068005ac6da5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function subtracts one image from another. <a href="#a9524adc496c5155e4215068005ac6da5">More...</a><br /></td></tr>
140<tr class="separator:a9524adc496c5155e4215068005ac6da5"><td class="memSeparator" colspan="2">&#160;</td></tr>
141</table>
142<h2 class="groupheader">Macro Definition Documentation</h2>
143<a class="anchor" id="af3b709fb668cf93ca09e2a46a2a031a8"></a>
144<div class="memitem">
145<div class="memproto">
146 <table class="memname">
147 <tr>
148 <td class="memname">#define ADD</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="arithmetic__op_8cl_source.xhtml#l00030">30</a> of file <a class="el" href="arithmetic__op_8cl_source.xhtml">arithmetic_op.cl</a>.</p>
168
169<p>Referenced by <a class="el" href="arithmetic__op_8cl_source.xhtml#l00059">arithmetic_add()</a>.</p>
170
171</div>
172</div>
173<a class="anchor" id="aafc2c4f262a0686c07f86c7d2e1d8d14"></a>
174<div class="memitem">
175<div class="memproto">
176 <table class="memname">
177 <tr>
178 <td class="memname">#define SUB</td>
179 <td>(</td>
180 <td class="paramtype">&#160;</td>
181 <td class="paramname">x, </td>
182 </tr>
183 <tr>
184 <td class="paramkey"></td>
185 <td></td>
186 <td class="paramtype">&#160;</td>
187 <td class="paramname">y&#160;</td>
188 </tr>
189 <tr>
190 <td></td>
191 <td>)</td>
192 <td></td><td>&#160;&#160;&#160;(x) - (y)</td>
193 </tr>
194 </table>
195</div><div class="memdoc">
196
197<p>Definition at line <a class="el" href="arithmetic__op_8cl_source.xhtml#l00031">31</a> of file <a class="el" href="arithmetic__op_8cl_source.xhtml">arithmetic_op.cl</a>.</p>
198
199<p>Referenced by <a class="el" href="arithmetic__op_8cl_source.xhtml#l00104">arithmetic_sub()</a>.</p>
200
201</div>
202</div>
203<h2 class="groupheader">Function Documentation</h2>
204<a class="anchor" id="a3e7b06c866bbf410b0c4ec80a73084a9"></a>
205<div class="memitem">
206<div class="memproto">
207 <table class="memname">
208 <tr>
209 <td class="memname">__kernel void arithmetic_add </td>
210 <td>(</td>
211 <td class="paramtype">__global uchar *&#160;</td>
212 <td class="paramname"><em>in1_ptr</em>, </td>
213 </tr>
214 <tr>
215 <td class="paramkey"></td>
216 <td></td>
217 <td class="paramtype">uint&#160;</td>
218 <td class="paramname"><em>in1_stride_x</em>, </td>
219 </tr>
220 <tr>
221 <td class="paramkey"></td>
222 <td></td>
223 <td class="paramtype">uint&#160;</td>
224 <td class="paramname"><em>in1_step_x</em>, </td>
225 </tr>
226 <tr>
227 <td class="paramkey"></td>
228 <td></td>
229 <td class="paramtype">uint&#160;</td>
230 <td class="paramname"><em>in1_stride_y</em>, </td>
231 </tr>
232 <tr>
233 <td class="paramkey"></td>
234 <td></td>
235 <td class="paramtype">uint&#160;</td>
236 <td class="paramname"><em>in1_step_y</em>, </td>
237 </tr>
238 <tr>
239 <td class="paramkey"></td>
240 <td></td>
241 <td class="paramtype">uint&#160;</td>
242 <td class="paramname"><em>in1_offset_first_element_in_bytes</em>, </td>
243 </tr>
244 <tr>
245 <td class="paramkey"></td>
246 <td></td>
247 <td class="paramtype">__global uchar *&#160;</td>
248 <td class="paramname"><em>in2_ptr</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>in2_stride_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>in2_step_x</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>in2_stride_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>in2_step_y</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>in2_offset_first_element_in_bytes</em>, </td>
279 </tr>
280 <tr>
281 <td class="paramkey"></td>
282 <td></td>
283 <td class="paramtype">__global uchar *&#160;</td>
284 <td class="paramname"><em>out_ptr</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>out_stride_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>out_step_x</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>out_stride_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>out_step_y</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>out_offset_first_element_in_bytes</em>&#160;</td>
315 </tr>
316 <tr>
317 <td></td>
318 <td>)</td>
319 <td></td><td></td>
320 </tr>
321 </table>
322</div><div class="memdoc">
323
324<p>This function add two images. </p>
325<dl class="section attention"><dt>Attention</dt><dd>The input and output data_types need to be passed at compile time using -DDATA_TYPE_IN1, -DDATA_TYPE_IN2 and -DDATA_TYPE_OUT: e.g. -DDATA_TYPE_IN1=uchar -DDATA_TYPE_IN2=uchar -DDATA_TYPE_OUT=short </dd>
326<dd>
327To perform saturating operation -DSATURATE has to be passed to the compiler otherwise wrapping policy will be used.</dd></dl>
328<dl class="params"><dt>Parameters</dt><dd>
329 <table class="params">
330 <tr><td class="paramdir">[in]</td><td class="paramname">in1_ptr</td><td>Pointer to the source image. Supported data types: U8, S16 </td></tr>
331 <tr><td class="paramdir">[in]</td><td class="paramname">in1_stride_x</td><td>Stride of the source image in X dimension (in bytes) </td></tr>
332 <tr><td class="paramdir">[in]</td><td class="paramname">in1_step_x</td><td>in1_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
333 <tr><td class="paramdir">[in]</td><td class="paramname">in1_stride_y</td><td>Stride of the source image in Y dimension (in bytes) </td></tr>
334 <tr><td class="paramdir">[in]</td><td class="paramname">in1_step_y</td><td>in1_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
335 <tr><td class="paramdir">[in]</td><td class="paramname">in1_offset_first_element_in_bytes</td><td>The offset of the first element in the source image </td></tr>
336 <tr><td class="paramdir">[in]</td><td class="paramname">in2_ptr</td><td>Pointer to the source image. Supported data types: U8, S16 </td></tr>
337 <tr><td class="paramdir">[in]</td><td class="paramname">in2_stride_x</td><td>Stride of the source image in X dimension (in bytes) </td></tr>
338 <tr><td class="paramdir">[in]</td><td class="paramname">in2_step_x</td><td>in2_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
339 <tr><td class="paramdir">[in]</td><td class="paramname">in2_stride_y</td><td>Stride of the source image in Y dimension (in bytes) </td></tr>
340 <tr><td class="paramdir">[in]</td><td class="paramname">in2_step_y</td><td>in2_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
341 <tr><td class="paramdir">[in]</td><td class="paramname">in2_offset_first_element_in_bytes</td><td>The offset of the first element in the source image </td></tr>
342 <tr><td class="paramdir">[out]</td><td class="paramname">out_ptr</td><td>Pointer to the destination image. Supported data types: U8, S16 </td></tr>
343 <tr><td class="paramdir">[in]</td><td class="paramname">out_stride_x</td><td>Stride of the destination image in X dimension (in bytes) </td></tr>
344 <tr><td class="paramdir">[in]</td><td class="paramname">out_step_x</td><td>out_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
345 <tr><td class="paramdir">[in]</td><td class="paramname">out_stride_y</td><td>Stride of the destination image in Y dimension (in bytes) </td></tr>
346 <tr><td class="paramdir">[in]</td><td class="paramname">out_step_y</td><td>out_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
347 <tr><td class="paramdir">[in]</td><td class="paramname">out_offset_first_element_in_bytes</td><td>The offset of the first element in the destination image </td></tr>
348 </table>
349 </dd>
350</dl>
351
352<p>Definition at line <a class="el" href="arithmetic__op_8cl_source.xhtml#l00059">59</a> of file <a class="el" href="arithmetic__op_8cl_source.xhtml">arithmetic_op.cl</a>.</p>
353
354<p>References <a class="el" href="arithmetic__op_8cl_source.xhtml#l00030">ADD</a>, <a class="el" href="helpers_8h_source.xhtml#l00035">CONVERT</a>, <a class="el" href="helpers_8h_source.xhtml#l00073">CONVERT_TO_IMAGE_STRUCT</a>, <a class="el" href="convolution3x3_8cl_source.xhtml#l00031">DATA_TYPE_OUT</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>
355<div class="fragment"><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;{</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="comment">// Get pixels pointer</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <a class="code" href="struct_image.xhtml">Image</a> in1 = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(in1);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <a class="code" href="struct_image.xhtml">Image</a> in2 = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(in2);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <a class="code" href="struct_image.xhtml">Image</a> out = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(out);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="comment">// Load values</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="helpers_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(<a class="code" href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a>, 16)</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; in_a = <a class="code" href="helpers_8h.xhtml#aa8d95ba04fc73845abc6045952cae5be">CONVERT</a>(vload16(0, (__global DATA_TYPE_IN1 *)in1.ptr), <a class="code" href="helpers_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(<a class="code" href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a>, 16));</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <a class="code" href="helpers_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(DATA_TYPE_OUT, 16)</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; in_b = <a class="code" href="helpers_8h.xhtml#aa8d95ba04fc73845abc6045952cae5be">CONVERT</a>(vload16(0, (__global DATA_TYPE_IN2 *)in2.ptr), <a class="code" href="helpers_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(DATA_TYPE_OUT, 16));</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="comment">// Calculate and store result</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; vstore16(<a class="code" href="arithmetic__op_8cl.xhtml#af3b709fb668cf93ca09e2a46a2a031a8">ADD</a>(in_a, in_b), 0, (__global DATA_TYPE_OUT *)out.ptr);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</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>
356<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>
357<div class="ttc" id="arithmetic__op_8cl_xhtml_af3b709fb668cf93ca09e2a46a2a031a8"><div class="ttname"><a href="arithmetic__op_8cl.xhtml#af3b709fb668cf93ca09e2a46a2a031a8">ADD</a></div><div class="ttdeci">#define ADD(x, y)</div><div class="ttdef"><b>Definition:</b> <a href="arithmetic__op_8cl_source.xhtml#l00030">arithmetic_op.cl:30</a></div></div>
358<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>
359<div class="ttc" id="convolution3x3_8cl_xhtml_ac06f3e24d3fffd3c465d8b2a6e7c985e"><div class="ttname"><a href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a></div><div class="ttdeci">#define DATA_TYPE_OUT</div><div class="ttdef"><b>Definition:</b> <a href="convolution3x3_8cl_source.xhtml#l00031">convolution3x3.cl:31</a></div></div>
360<div class="ttc" id="helpers_8h_xhtml_aa8d95ba04fc73845abc6045952cae5be"><div class="ttname"><a href="helpers_8h.xhtml#aa8d95ba04fc73845abc6045952cae5be">CONVERT</a></div><div class="ttdeci">#define CONVERT(x, type)</div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00035">helpers.h:35</a></div></div>
361</div><!-- fragment -->
362</div>
363</div>
364<a class="anchor" id="a9524adc496c5155e4215068005ac6da5"></a>
365<div class="memitem">
366<div class="memproto">
367 <table class="memname">
368 <tr>
369 <td class="memname">__kernel void arithmetic_sub </td>
370 <td>(</td>
371 <td class="paramtype">__global uchar *&#160;</td>
372 <td class="paramname"><em>in1_ptr</em>, </td>
373 </tr>
374 <tr>
375 <td class="paramkey"></td>
376 <td></td>
377 <td class="paramtype">uint&#160;</td>
378 <td class="paramname"><em>in1_stride_x</em>, </td>
379 </tr>
380 <tr>
381 <td class="paramkey"></td>
382 <td></td>
383 <td class="paramtype">uint&#160;</td>
384 <td class="paramname"><em>in1_step_x</em>, </td>
385 </tr>
386 <tr>
387 <td class="paramkey"></td>
388 <td></td>
389 <td class="paramtype">uint&#160;</td>
390 <td class="paramname"><em>in1_stride_y</em>, </td>
391 </tr>
392 <tr>
393 <td class="paramkey"></td>
394 <td></td>
395 <td class="paramtype">uint&#160;</td>
396 <td class="paramname"><em>in1_step_y</em>, </td>
397 </tr>
398 <tr>
399 <td class="paramkey"></td>
400 <td></td>
401 <td class="paramtype">uint&#160;</td>
402 <td class="paramname"><em>in1_offset_first_element_in_bytes</em>, </td>
403 </tr>
404 <tr>
405 <td class="paramkey"></td>
406 <td></td>
407 <td class="paramtype">__global uchar *&#160;</td>
408 <td class="paramname"><em>in2_ptr</em>, </td>
409 </tr>
410 <tr>
411 <td class="paramkey"></td>
412 <td></td>
413 <td class="paramtype">uint&#160;</td>
414 <td class="paramname"><em>in2_stride_x</em>, </td>
415 </tr>
416 <tr>
417 <td class="paramkey"></td>
418 <td></td>
419 <td class="paramtype">uint&#160;</td>
420 <td class="paramname"><em>in2_step_x</em>, </td>
421 </tr>
422 <tr>
423 <td class="paramkey"></td>
424 <td></td>
425 <td class="paramtype">uint&#160;</td>
426 <td class="paramname"><em>in2_stride_y</em>, </td>
427 </tr>
428 <tr>
429 <td class="paramkey"></td>
430 <td></td>
431 <td class="paramtype">uint&#160;</td>
432 <td class="paramname"><em>in2_step_y</em>, </td>
433 </tr>
434 <tr>
435 <td class="paramkey"></td>
436 <td></td>
437 <td class="paramtype">uint&#160;</td>
438 <td class="paramname"><em>in2_offset_first_element_in_bytes</em>, </td>
439 </tr>
440 <tr>
441 <td class="paramkey"></td>
442 <td></td>
443 <td class="paramtype">__global uchar *&#160;</td>
444 <td class="paramname"><em>out_ptr</em>, </td>
445 </tr>
446 <tr>
447 <td class="paramkey"></td>
448 <td></td>
449 <td class="paramtype">uint&#160;</td>
450 <td class="paramname"><em>out_stride_x</em>, </td>
451 </tr>
452 <tr>
453 <td class="paramkey"></td>
454 <td></td>
455 <td class="paramtype">uint&#160;</td>
456 <td class="paramname"><em>out_step_x</em>, </td>
457 </tr>
458 <tr>
459 <td class="paramkey"></td>
460 <td></td>
461 <td class="paramtype">uint&#160;</td>
462 <td class="paramname"><em>out_stride_y</em>, </td>
463 </tr>
464 <tr>
465 <td class="paramkey"></td>
466 <td></td>
467 <td class="paramtype">uint&#160;</td>
468 <td class="paramname"><em>out_step_y</em>, </td>
469 </tr>
470 <tr>
471 <td class="paramkey"></td>
472 <td></td>
473 <td class="paramtype">uint&#160;</td>
474 <td class="paramname"><em>out_offset_first_element_in_bytes</em>&#160;</td>
475 </tr>
476 <tr>
477 <td></td>
478 <td>)</td>
479 <td></td><td></td>
480 </tr>
481 </table>
482</div><div class="memdoc">
483
484<p>This function subtracts one image from another. </p>
485<dl class="section attention"><dt>Attention</dt><dd>The input and output data_types need to be passed at compile time using -DDATA_TYPE_IN1, -DDATA_TYPE_IN2 and -DDATA_TYPE_OUT: e.g. -DDATA_TYPE_IN1=uchar -DDATA_TYPE_IN2=uchar -DDATA_TYPE_OUT=short </dd>
486<dd>
487To perform saturating operation -DSATURATE has to be passed to the compiler otherwise wrapping policy will be used.</dd></dl>
488<dl class="params"><dt>Parameters</dt><dd>
489 <table class="params">
490 <tr><td class="paramdir">[in]</td><td class="paramname">in1_ptr</td><td>Pointer to the source image. Supported data types: U8, S16 </td></tr>
491 <tr><td class="paramdir">[in]</td><td class="paramname">in1_stride_x</td><td>Stride of the source image in X dimension (in bytes) </td></tr>
492 <tr><td class="paramdir">[in]</td><td class="paramname">in1_step_x</td><td>in1_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
493 <tr><td class="paramdir">[in]</td><td class="paramname">in1_stride_y</td><td>Stride of the source image in Y dimension (in bytes) </td></tr>
494 <tr><td class="paramdir">[in]</td><td class="paramname">in1_step_y</td><td>in1_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
495 <tr><td class="paramdir">[in]</td><td class="paramname">in1_offset_first_element_in_bytes</td><td>The offset of the first element in the source image </td></tr>
496 <tr><td class="paramdir">[in]</td><td class="paramname">in2_ptr</td><td>Pointer to the source image. Supported data types: U8, S16 </td></tr>
497 <tr><td class="paramdir">[in]</td><td class="paramname">in2_stride_x</td><td>Stride of the source image in X dimension (in bytes) </td></tr>
498 <tr><td class="paramdir">[in]</td><td class="paramname">in2_step_x</td><td>in2_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
499 <tr><td class="paramdir">[in]</td><td class="paramname">in2_stride_y</td><td>Stride of the source image in Y dimension (in bytes) </td></tr>
500 <tr><td class="paramdir">[in]</td><td class="paramname">in2_step_y</td><td>in2_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
501 <tr><td class="paramdir">[in]</td><td class="paramname">in2_offset_first_element_in_bytes</td><td>The offset of the first element in the source image </td></tr>
502 <tr><td class="paramdir">[out]</td><td class="paramname">out_ptr</td><td>Pointer to the destination image. Supported data types: U8, S16 </td></tr>
503 <tr><td class="paramdir">[in]</td><td class="paramname">out_stride_x</td><td>Stride of the destination image in X dimension (in bytes) </td></tr>
504 <tr><td class="paramdir">[in]</td><td class="paramname">out_step_x</td><td>out_stride_x * number of elements along X processed per workitem(in bytes) </td></tr>
505 <tr><td class="paramdir">[in]</td><td class="paramname">out_stride_y</td><td>Stride of the destination image in Y dimension (in bytes) </td></tr>
506 <tr><td class="paramdir">[in]</td><td class="paramname">out_step_y</td><td>out_stride_y * number of elements along Y processed per workitem(in bytes) </td></tr>
507 <tr><td class="paramdir">[in]</td><td class="paramname">out_offset_first_element_in_bytes</td><td>The offset of the first element in the destination image </td></tr>
508 </table>
509 </dd>
510</dl>
511
512<p>Definition at line <a class="el" href="arithmetic__op_8cl_source.xhtml#l00104">104</a> of file <a class="el" href="arithmetic__op_8cl_source.xhtml">arithmetic_op.cl</a>.</p>
513
514<p>References <a class="el" href="helpers_8h_source.xhtml#l00035">CONVERT</a>, <a class="el" href="helpers_8h_source.xhtml#l00073">CONVERT_TO_IMAGE_STRUCT</a>, <a class="el" href="convolution3x3_8cl_source.xhtml#l00031">DATA_TYPE_OUT</a>, <a class="el" href="helpers_8h_source.xhtml#l00097">Image::ptr</a>, <a class="el" href="arithmetic__op_8cl_source.xhtml#l00031">SUB</a>, and <a class="el" href="helpers_8h_source.xhtml#l00032">VEC_DATA_TYPE</a>.</p>
515<div class="fragment"><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;{</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="comment">// Get pixels pointer</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <a class="code" href="struct_image.xhtml">Image</a> in1 = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(in1);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <a class="code" href="struct_image.xhtml">Image</a> in2 = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(in2);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <a class="code" href="struct_image.xhtml">Image</a> out = <a class="code" href="helpers_8h.xhtml#aebe814363556c244be043b13e7969197">CONVERT_TO_IMAGE_STRUCT</a>(out);</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="comment">// Load values</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <a class="code" href="helpers_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(<a class="code" href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a>, 16)</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; in_a = <a class="code" href="helpers_8h.xhtml#aa8d95ba04fc73845abc6045952cae5be">CONVERT</a>(vload16(0, (__global DATA_TYPE_IN1 *)in1.ptr), <a class="code" href="helpers_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(<a class="code" href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a>, 16));</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <a class="code" href="helpers_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(DATA_TYPE_OUT, 16)</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; in_b = <a class="code" href="helpers_8h.xhtml#aa8d95ba04fc73845abc6045952cae5be">CONVERT</a>(vload16(0, (__global DATA_TYPE_IN2 *)in2.ptr), <a class="code" href="helpers_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(DATA_TYPE_OUT, 16));</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="comment">// Calculate and store result</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; vstore16(<a class="code" href="arithmetic__op_8cl.xhtml#aafc2c4f262a0686c07f86c7d2e1d8d14">SUB</a>(in_a, in_b), 0, (__global DATA_TYPE_OUT *)out.ptr);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</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>
516<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>
517<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>
518<div class="ttc" id="arithmetic__op_8cl_xhtml_aafc2c4f262a0686c07f86c7d2e1d8d14"><div class="ttname"><a href="arithmetic__op_8cl.xhtml#aafc2c4f262a0686c07f86c7d2e1d8d14">SUB</a></div><div class="ttdeci">#define SUB(x, y)</div><div class="ttdef"><b>Definition:</b> <a href="arithmetic__op_8cl_source.xhtml#l00031">arithmetic_op.cl:31</a></div></div>
519<div class="ttc" id="convolution3x3_8cl_xhtml_ac06f3e24d3fffd3c465d8b2a6e7c985e"><div class="ttname"><a href="convolution3x3_8cl.xhtml#ac06f3e24d3fffd3c465d8b2a6e7c985e">DATA_TYPE_OUT</a></div><div class="ttdeci">#define DATA_TYPE_OUT</div><div class="ttdef"><b>Definition:</b> <a href="convolution3x3_8cl_source.xhtml#l00031">convolution3x3.cl:31</a></div></div>
520<div class="ttc" id="helpers_8h_xhtml_aa8d95ba04fc73845abc6045952cae5be"><div class="ttname"><a href="helpers_8h.xhtml#aa8d95ba04fc73845abc6045952cae5be">CONVERT</a></div><div class="ttdeci">#define CONVERT(x, type)</div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00035">helpers.h:35</a></div></div>
521</div><!-- fragment -->
522</div>
523</div>
524</div><!-- contents -->
525</div><!-- doc-content -->
526<!-- start footer part -->
527<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
528 <ul>
529 <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="arithmetic__op_8cl.xhtml">arithmetic_op.cl</a></li>
530 <li class="footer">Generated on Fri Mar 24 2017 17:23:50 for ARM Compute Library by
531 <a href="http://www.doxygen.org/index.html">
532 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
533 </ul>
534</div>
535</body>
536</html>