blob: 6057d9a5ebc42648f96090172c5d5e3da7b98145 [file] [log] [blame]
Anthony Barbierf45d5a92018-01-24 16:23:15 +00001<!-- 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>Compute Library: Tensor4D Struct 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">Compute Library
Jenkinsb3a371b2018-05-23 11:36:53 +010043 &#160;<span id="projectnumber">18.05</span>
Anthony Barbierf45d5a92018-01-24 16:23:15 +000044 </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="pages.xhtml"><span>Related&#160;Pages</span></a></li>
59 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60 <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
61 <li><a href="files.xhtml"><span>Files</span></a></li>
62 <li>
63 <div id="MSearchBox" class="MSearchBoxInactive">
64 <span class="left">
65 <img id="MSearchSelect" src="search/mag_sel.png"
66 onmouseover="return searchBox.OnSearchSelectShow()"
67 onmouseout="return searchBox.OnSearchSelectHide()"
68 alt=""/>
69 <input type="text" id="MSearchField" value="Search" accesskey="S"
70 onfocus="searchBox.OnSearchFieldFocus(true)"
71 onblur="searchBox.OnSearchFieldFocus(false)"
72 onkeyup="searchBox.OnSearchFieldChange(event)"/>
73 </span><span class="right">
74 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
75 </span>
76 </div>
77 </li>
78 </ul>
79 </div>
80 <div id="navrow2" class="tabs2">
81 <ul class="tablist">
82 <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
83 <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
84 <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
85 <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
86 </ul>
87 </div>
88</div><!-- top -->
89<div id="side-nav" class="ui-resizable side-nav-resizable">
90 <div id="nav-tree">
91 <div id="nav-tree-contents">
92 <div id="nav-sync" class="sync"></div>
93 </div>
94 </div>
95 <div id="splitbar" style="-moz-user-select:none;"
96 class="ui-resizable-handle">
97 </div>
98</div>
99<script type="text/javascript">
100$(document).ready(function(){initNavTree('struct_tensor4_d.xhtml','');});
101</script>
102<div id="doc-content">
103<!-- window showing the filter options -->
104<div id="MSearchSelectWindow"
105 onmouseover="return searchBox.OnSearchSelectShow()"
106 onmouseout="return searchBox.OnSearchSelectHide()"
107 onkeydown="return searchBox.OnSearchSelectKey(event)">
108</div>
109
110<!-- iframe showing the search results (closed by default) -->
111<div id="MSearchResultsWindow">
112<iframe src="javascript:void(0)" frameborder="0"
113 name="MSearchResults" id="MSearchResults">
114</iframe>
115</div>
116
117<div class="header">
118 <div class="summary">
119<a href="#pub-attribs">Data Fields</a> </div>
120 <div class="headertitle">
121<div class="title">Tensor4D Struct Reference</div> </div>
122</div><!--header-->
123<div class="contents">
124
125<p>Structure to hold 4D tensor information.
126 <a href="struct_tensor4_d.xhtml#details">More...</a></p>
127
128<p><code>#include &lt;<a class="el" href="helpers_8h_source.xhtml">helpers.h</a>&gt;</code></p>
129<table class="memberdecls">
130<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
131Data Fields</h2></td></tr>
132<tr class="memitem:acf52c23cbd7424606c10a606524e3e32"><td class="memItemLeft" align="right" valign="top">__global uchar *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor4_d.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a></td></tr>
133<tr class="memdesc:acf52c23cbd7424606c10a606524e3e32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to the starting postion of the buffer. <a href="#acf52c23cbd7424606c10a606524e3e32">More...</a><br /></td></tr>
134<tr class="separator:acf52c23cbd7424606c10a606524e3e32"><td class="memSeparator" colspan="2">&#160;</td></tr>
135<tr class="memitem:a35e5a91338398273f3b4a6010004bddd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor4_d.xhtml#a35e5a91338398273f3b4a6010004bddd">offset_first_element_in_bytes</a></td></tr>
136<tr class="memdesc:a35e5a91338398273f3b4a6010004bddd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The offset of the first element in the source image. <a href="#a35e5a91338398273f3b4a6010004bddd">More...</a><br /></td></tr>
137<tr class="separator:a35e5a91338398273f3b4a6010004bddd"><td class="memSeparator" colspan="2">&#160;</td></tr>
138<tr class="memitem:ae01febbfd0689ef709f3ff6fdd2abc7e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor4_d.xhtml#ae01febbfd0689ef709f3ff6fdd2abc7e">stride_x</a></td></tr>
139<tr class="memdesc:ae01febbfd0689ef709f3ff6fdd2abc7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stride of the image in X dimension (in bytes) <a href="#ae01febbfd0689ef709f3ff6fdd2abc7e">More...</a><br /></td></tr>
140<tr class="separator:ae01febbfd0689ef709f3ff6fdd2abc7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
141<tr class="memitem:a4f0b90c9ecd6e57ceb3f37332fefe8f1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor4_d.xhtml#a4f0b90c9ecd6e57ceb3f37332fefe8f1">stride_y</a></td></tr>
142<tr class="memdesc:a4f0b90c9ecd6e57ceb3f37332fefe8f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stride of the image in Y dimension (in bytes) <a href="#a4f0b90c9ecd6e57ceb3f37332fefe8f1">More...</a><br /></td></tr>
143<tr class="separator:a4f0b90c9ecd6e57ceb3f37332fefe8f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
144<tr class="memitem:ad5ff7a2b2bd0eec50fe09c254b127d1c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor4_d.xhtml#ad5ff7a2b2bd0eec50fe09c254b127d1c">stride_z</a></td></tr>
145<tr class="memdesc:ad5ff7a2b2bd0eec50fe09c254b127d1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stride of the image in Z dimension (in bytes) <a href="#ad5ff7a2b2bd0eec50fe09c254b127d1c">More...</a><br /></td></tr>
146<tr class="separator:ad5ff7a2b2bd0eec50fe09c254b127d1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
147<tr class="memitem:a13a60f6e75f64f1953b8858ea454a880"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor4_d.xhtml#a13a60f6e75f64f1953b8858ea454a880">stride_w</a></td></tr>
148<tr class="memdesc:a13a60f6e75f64f1953b8858ea454a880"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stride of the image in W dimension (in bytes) <a href="#a13a60f6e75f64f1953b8858ea454a880">More...</a><br /></td></tr>
149<tr class="separator:a13a60f6e75f64f1953b8858ea454a880"><td class="memSeparator" colspan="2">&#160;</td></tr>
150</table>
151<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
152<div class="textblock"><p>Structure to hold 4D tensor information. </p>
153
Jenkinsb3a371b2018-05-23 11:36:53 +0100154<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00161">161</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Anthony Barbierf45d5a92018-01-24 16:23:15 +0000155</div><h2 class="groupheader">Field Documentation</h2>
156<a class="anchor" id="a35e5a91338398273f3b4a6010004bddd"></a>
157<div class="memitem">
158<div class="memproto">
159 <table class="memname">
160 <tr>
161 <td class="memname">int offset_first_element_in_bytes</td>
162 </tr>
163 </table>
164</div><div class="memdoc">
165
166<p>The offset of the first element in the source image. </p>
167
Jenkinsb3a371b2018-05-23 11:36:53 +0100168<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00164">164</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Anthony Barbierf45d5a92018-01-24 16:23:15 +0000169
Jenkinsb3a371b2018-05-23 11:36:53 +0100170<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00269">update_tensor4D_workitem_ptr()</a>.</p>
Anthony Barbierf45d5a92018-01-24 16:23:15 +0000171
172</div>
173</div>
174<a class="anchor" id="acf52c23cbd7424606c10a606524e3e32"></a>
175<div class="memitem">
176<div class="memproto">
177 <table class="memname">
178 <tr>
179 <td class="memname">__global uchar* ptr</td>
180 </tr>
181 </table>
182</div><div class="memdoc">
183
184<p>Pointer to the starting postion of the buffer. </p>
185
Jenkinsb3a371b2018-05-23 11:36:53 +0100186<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00163">163</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Anthony Barbierf45d5a92018-01-24 16:23:15 +0000187
Jenkinsb3a371b2018-05-23 11:36:53 +0100188<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00328">tensor4D_offset()</a>, and <a class="el" href="helpers_8h_source.xhtml#l00269">update_tensor4D_workitem_ptr()</a>.</p>
Anthony Barbierf45d5a92018-01-24 16:23:15 +0000189
190</div>
191</div>
192<a class="anchor" id="a13a60f6e75f64f1953b8858ea454a880"></a>
193<div class="memitem">
194<div class="memproto">
195 <table class="memname">
196 <tr>
197 <td class="memname">int stride_w</td>
198 </tr>
199 </table>
200</div><div class="memdoc">
201
202<p>Stride of the image in W dimension (in bytes) </p>
203
Jenkinsb3a371b2018-05-23 11:36:53 +0100204<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00168">168</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Anthony Barbierf45d5a92018-01-24 16:23:15 +0000205
Jenkinsb3a371b2018-05-23 11:36:53 +0100206<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00328">tensor4D_offset()</a>.</p>
Anthony Barbierf45d5a92018-01-24 16:23:15 +0000207
208</div>
209</div>
210<a class="anchor" id="ae01febbfd0689ef709f3ff6fdd2abc7e"></a>
211<div class="memitem">
212<div class="memproto">
213 <table class="memname">
214 <tr>
215 <td class="memname">int stride_x</td>
216 </tr>
217 </table>
218</div><div class="memdoc">
219
220<p>Stride of the image in X dimension (in bytes) </p>
221
Jenkinsb3a371b2018-05-23 11:36:53 +0100222<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00165">165</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Anthony Barbierf45d5a92018-01-24 16:23:15 +0000223
Jenkinsb3a371b2018-05-23 11:36:53 +0100224<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00328">tensor4D_offset()</a>.</p>
Anthony Barbierf45d5a92018-01-24 16:23:15 +0000225
226</div>
227</div>
228<a class="anchor" id="a4f0b90c9ecd6e57ceb3f37332fefe8f1"></a>
229<div class="memitem">
230<div class="memproto">
231 <table class="memname">
232 <tr>
233 <td class="memname">int stride_y</td>
234 </tr>
235 </table>
236</div><div class="memdoc">
237
238<p>Stride of the image in Y dimension (in bytes) </p>
239
Jenkinsb3a371b2018-05-23 11:36:53 +0100240<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00166">166</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Anthony Barbierf45d5a92018-01-24 16:23:15 +0000241
Jenkinsb3a371b2018-05-23 11:36:53 +0100242<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00328">tensor4D_offset()</a>.</p>
Anthony Barbierf45d5a92018-01-24 16:23:15 +0000243
244</div>
245</div>
246<a class="anchor" id="ad5ff7a2b2bd0eec50fe09c254b127d1c"></a>
247<div class="memitem">
248<div class="memproto">
249 <table class="memname">
250 <tr>
251 <td class="memname">int stride_z</td>
252 </tr>
253 </table>
254</div><div class="memdoc">
255
256<p>Stride of the image in Z dimension (in bytes) </p>
257
Jenkinsb3a371b2018-05-23 11:36:53 +0100258<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00167">167</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Anthony Barbierf45d5a92018-01-24 16:23:15 +0000259
Jenkinsb3a371b2018-05-23 11:36:53 +0100260<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00328">tensor4D_offset()</a>.</p>
Anthony Barbierf45d5a92018-01-24 16:23:15 +0000261
262</div>
263</div>
264<hr/>The documentation for this struct was generated from the following file:<ul>
265<li>src/core/CL/cl_kernels/<a class="el" href="helpers_8h_source.xhtml">helpers.h</a></li>
266</ul>
267</div><!-- contents -->
268</div><!-- doc-content -->
269<!-- start footer part -->
270<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
271 <ul>
272 <li class="navelem"><a class="el" href="struct_tensor4_d.xhtml">Tensor4D</a></li>
Jenkinsb3a371b2018-05-23 11:36:53 +0100273 <li class="footer">Generated on Wed May 23 2018 11:36:39 for Compute Library by
Anthony Barbierf45d5a92018-01-24 16:23:15 +0000274 <a href="http://www.doxygen.org/index.html">
275 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
276 </ul>
277</div>
278</body>
279</html>