blob: c8542ddd0ea6f760731a13caf9de8ba6ffe6dce1 [file] [log] [blame]
Kaizen8938bd32017-09-28 14:38:23 +01001<!-- 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.6"/>
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="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18 $(window).load(resizeHeight);
19</script>
20<link href="search/search.css" rel="stylesheet" type="text/css"/>
21<script type="text/javascript" src="search/search.js"></script>
22<script type="text/javascript">
23 $(document).ready(function() { searchBox.OnSelectItem(0); });
24</script>
25<script type="text/x-mathjax-config">
26 MathJax.Hub.Config({
27 extensions: ["tex2jax.js"],
28 jax: ["input/TeX","output/HTML-CSS"],
29});
30</script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
31<link href="doxygen.css" rel="stylesheet" type="text/css" />
32</head>
33<body>
34<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
35<div id="titlearea">
36<table cellspacing="0" cellpadding="0">
37 <tbody>
38 <tr style="height: 56px;">
39 <td style="padding-left: 0.5em;">
40 <div id="projectname">Compute Library
Kaizenbf8b01d2017-10-12 14:26:51 +010041 &#160;<span id="projectnumber">17.10</span>
Kaizen8938bd32017-09-28 14:38:23 +010042 </div>
43 </td>
44 </tr>
45 </tbody>
46</table>
47</div>
48<!-- end header part -->
49<!-- Generated by Doxygen 1.8.6 -->
50<script type="text/javascript">
51var searchBox = new SearchBox("searchBox", "search",false,'Search');
52</script>
53 <div id="navrow1" class="tabs">
54 <ul class="tablist">
55 <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
56 <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
57 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
58 <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
59 <li><a href="files.xhtml"><span>Files</span></a></li>
60 <li>
61 <div id="MSearchBox" class="MSearchBoxInactive">
62 <span class="left">
63 <img id="MSearchSelect" src="search/mag_sel.png"
64 onmouseover="return searchBox.OnSearchSelectShow()"
65 onmouseout="return searchBox.OnSearchSelectHide()"
66 alt=""/>
67 <input type="text" id="MSearchField" value="Search" accesskey="S"
68 onfocus="searchBox.OnSearchFieldFocus(true)"
69 onblur="searchBox.OnSearchFieldFocus(false)"
70 onkeyup="searchBox.OnSearchFieldChange(event)"/>
71 </span><span class="right">
72 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
73 </span>
74 </div>
75 </li>
76 </ul>
77 </div>
78 <div id="navrow2" class="tabs2">
79 <ul class="tablist">
80 <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
81 <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
82 <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
83 <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
84 </ul>
85 </div>
86</div><!-- top -->
87<div id="side-nav" class="ui-resizable side-nav-resizable">
88 <div id="nav-tree">
89 <div id="nav-tree-contents">
90 <div id="nav-sync" class="sync"></div>
91 </div>
92 </div>
93 <div id="splitbar" style="-moz-user-select:none;"
94 class="ui-resizable-handle">
95 </div>
96</div>
97<script type="text/javascript">
98$(document).ready(function(){initNavTree('struct_tensor4_d.xhtml','');});
99</script>
100<div id="doc-content">
101<!-- window showing the filter options -->
102<div id="MSearchSelectWindow"
103 onmouseover="return searchBox.OnSearchSelectShow()"
104 onmouseout="return searchBox.OnSearchSelectHide()"
105 onkeydown="return searchBox.OnSearchSelectKey(event)">
106<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
107
108<!-- iframe showing the search results (closed by default) -->
109<div id="MSearchResultsWindow">
110<iframe src="javascript:void(0)" frameborder="0"
111 name="MSearchResults" id="MSearchResults">
112</iframe>
113</div>
114
115<div class="header">
116 <div class="summary">
117<a href="#pub-attribs">Data Fields</a> </div>
118 <div class="headertitle">
119<div class="title">Tensor4D Struct Reference</div> </div>
120</div><!--header-->
121<div class="contents">
122
123<p>Structure to hold 4D tensor information.
124 <a href="struct_tensor4_d.xhtml#details">More...</a></p>
125
126<p><code>#include &lt;<a class="el" href="helpers_8h_source.xhtml">helpers.h</a>&gt;</code></p>
127<table class="memberdecls">
128<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
129Data Fields</h2></td></tr>
130<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>
131<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>
132<tr class="separator:acf52c23cbd7424606c10a606524e3e32"><td class="memSeparator" colspan="2">&#160;</td></tr>
133<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>
134<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>
135<tr class="separator:a35e5a91338398273f3b4a6010004bddd"><td class="memSeparator" colspan="2">&#160;</td></tr>
136<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>
137<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>
138<tr class="separator:ae01febbfd0689ef709f3ff6fdd2abc7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
139<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>
140<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>
141<tr class="separator:a4f0b90c9ecd6e57ceb3f37332fefe8f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
142<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>
143<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>
144<tr class="separator:ad5ff7a2b2bd0eec50fe09c254b127d1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
145<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>
146<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>
147<tr class="separator:a13a60f6e75f64f1953b8858ea454a880"><td class="memSeparator" colspan="2">&#160;</td></tr>
148</table>
149<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
150<div class="textblock"><p>Structure to hold 4D tensor information. </p>
151
Kaizenbf8b01d2017-10-12 14:26:51 +0100152<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00153">153</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100153</div><h2 class="groupheader">Field Documentation</h2>
154<a class="anchor" id="a35e5a91338398273f3b4a6010004bddd"></a>
155<div class="memitem">
156<div class="memproto">
157 <table class="memname">
158 <tr>
159 <td class="memname">int offset_first_element_in_bytes</td>
160 </tr>
161 </table>
162</div><div class="memdoc">
163
164<p>The offset of the first element in the source image. </p>
165
Kaizenbf8b01d2017-10-12 14:26:51 +0100166<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00156">156</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100167
Kaizenbf8b01d2017-10-12 14:26:51 +0100168<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00261">update_tensor4D_workitem_ptr()</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100169
170</div>
171</div>
172<a class="anchor" id="acf52c23cbd7424606c10a606524e3e32"></a>
173<div class="memitem">
174<div class="memproto">
175 <table class="memname">
176 <tr>
177 <td class="memname">__global uchar* ptr</td>
178 </tr>
179 </table>
180</div><div class="memdoc">
181
182<p>Pointer to the starting postion of the buffer. </p>
183
Kaizenbf8b01d2017-10-12 14:26:51 +0100184<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00155">155</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100185
Kaizenbf8b01d2017-10-12 14:26:51 +0100186<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00320">tensor4D_offset()</a>, and <a class="el" href="helpers_8h_source.xhtml#l00261">update_tensor4D_workitem_ptr()</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100187
188</div>
189</div>
190<a class="anchor" id="a13a60f6e75f64f1953b8858ea454a880"></a>
191<div class="memitem">
192<div class="memproto">
193 <table class="memname">
194 <tr>
195 <td class="memname">int stride_w</td>
196 </tr>
197 </table>
198</div><div class="memdoc">
199
200<p>Stride of the image in W dimension (in bytes) </p>
201
Kaizenbf8b01d2017-10-12 14:26:51 +0100202<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00160">160</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100203
Kaizenbf8b01d2017-10-12 14:26:51 +0100204<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00320">tensor4D_offset()</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100205
206</div>
207</div>
208<a class="anchor" id="ae01febbfd0689ef709f3ff6fdd2abc7e"></a>
209<div class="memitem">
210<div class="memproto">
211 <table class="memname">
212 <tr>
213 <td class="memname">int stride_x</td>
214 </tr>
215 </table>
216</div><div class="memdoc">
217
218<p>Stride of the image in X dimension (in bytes) </p>
219
Kaizenbf8b01d2017-10-12 14:26:51 +0100220<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00157">157</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100221
Kaizenbf8b01d2017-10-12 14:26:51 +0100222<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00320">tensor4D_offset()</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100223
224</div>
225</div>
226<a class="anchor" id="a4f0b90c9ecd6e57ceb3f37332fefe8f1"></a>
227<div class="memitem">
228<div class="memproto">
229 <table class="memname">
230 <tr>
231 <td class="memname">int stride_y</td>
232 </tr>
233 </table>
234</div><div class="memdoc">
235
236<p>Stride of the image in Y dimension (in bytes) </p>
237
Kaizenbf8b01d2017-10-12 14:26:51 +0100238<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00158">158</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100239
Kaizenbf8b01d2017-10-12 14:26:51 +0100240<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00320">tensor4D_offset()</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100241
242</div>
243</div>
244<a class="anchor" id="ad5ff7a2b2bd0eec50fe09c254b127d1c"></a>
245<div class="memitem">
246<div class="memproto">
247 <table class="memname">
248 <tr>
249 <td class="memname">int stride_z</td>
250 </tr>
251 </table>
252</div><div class="memdoc">
253
254<p>Stride of the image in Z dimension (in bytes) </p>
255
Kaizenbf8b01d2017-10-12 14:26:51 +0100256<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00159">159</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100257
Kaizenbf8b01d2017-10-12 14:26:51 +0100258<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00320">tensor4D_offset()</a>.</p>
Kaizen8938bd32017-09-28 14:38:23 +0100259
260</div>
261</div>
262<hr/>The documentation for this struct was generated from the following file:<ul>
263<li>src/core/CL/cl_kernels/<a class="el" href="helpers_8h_source.xhtml">helpers.h</a></li>
264</ul>
265</div><!-- contents -->
266</div><!-- doc-content -->
267<!-- start footer part -->
268<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
269 <ul>
270 <li class="navelem"><a class="el" href="struct_tensor4_d.xhtml">Tensor4D</a></li>
Kaizenbf8b01d2017-10-12 14:26:51 +0100271 <li class="footer">Generated on Thu Oct 12 2017 14:26:35 for Compute Library by
Kaizen8938bd32017-09-28 14:38:23 +0100272 <a href="http://www.doxygen.org/index.html">
273 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
274 </ul>
275</div>
276</body>
277</html>