arm_compute v17.04
[platform/upstream/armcl.git] / documentation / struct_tensor3_d.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: Tensor3D 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">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 class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
60       <li><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="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
85     </ul>
86   </div>
87 </div><!-- top -->
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
89   <div id="nav-tree">
90     <div id="nav-tree-contents">
91       <div id="nav-sync" class="sync"></div>
92     </div>
93   </div>
94   <div id="splitbar" style="-moz-user-select:none;" 
95        class="ui-resizable-handle">
96   </div>
97 </div>
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('struct_tensor3_d.xhtml','');});
100 </script>
101 <div id="doc-content">
102 <!-- window showing the filter options -->
103 <div id="MSearchSelectWindow"
104      onmouseover="return searchBox.OnSearchSelectShow()"
105      onmouseout="return searchBox.OnSearchSelectHide()"
106      onkeydown="return searchBox.OnSearchSelectKey(event)">
107 </div>
108
109 <!-- iframe showing the search results (closed by default) -->
110 <div id="MSearchResultsWindow">
111 <iframe src="javascript:void(0)" frameborder="0" 
112         name="MSearchResults" id="MSearchResults">
113 </iframe>
114 </div>
115
116 <div class="header">
117   <div class="summary">
118 <a href="#pub-attribs">Data Fields</a>  </div>
119   <div class="headertitle">
120 <div class="title">Tensor3D Struct Reference</div>  </div>
121 </div><!--header-->
122 <div class="contents">
123
124 <p>Structure to hold 3D tensor information.  
125  <a href="struct_tensor3_d.xhtml#details">More...</a></p>
126
127 <p><code>#include &lt;<a class="el" href="helpers_8h_source.xhtml">helpers.h</a>&gt;</code></p>
128 <table class="memberdecls">
129 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
130 Data Fields</h2></td></tr>
131 <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_tensor3_d.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a></td></tr>
132 <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>
133 <tr class="separator:acf52c23cbd7424606c10a606524e3e32"><td class="memSeparator" colspan="2">&#160;</td></tr>
134 <tr class="memitem:a35e5a91338398273f3b4a6010004bddd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor3_d.xhtml#a35e5a91338398273f3b4a6010004bddd">offset_first_element_in_bytes</a></td></tr>
135 <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>
136 <tr class="separator:a35e5a91338398273f3b4a6010004bddd"><td class="memSeparator" colspan="2">&#160;</td></tr>
137 <tr class="memitem:ae01febbfd0689ef709f3ff6fdd2abc7e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor3_d.xhtml#ae01febbfd0689ef709f3ff6fdd2abc7e">stride_x</a></td></tr>
138 <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>
139 <tr class="separator:ae01febbfd0689ef709f3ff6fdd2abc7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memitem:a4f0b90c9ecd6e57ceb3f37332fefe8f1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor3_d.xhtml#a4f0b90c9ecd6e57ceb3f37332fefe8f1">stride_y</a></td></tr>
141 <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>
142 <tr class="separator:a4f0b90c9ecd6e57ceb3f37332fefe8f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:ad5ff7a2b2bd0eec50fe09c254b127d1c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor3_d.xhtml#ad5ff7a2b2bd0eec50fe09c254b127d1c">stride_z</a></td></tr>
144 <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>
145 <tr class="separator:ad5ff7a2b2bd0eec50fe09c254b127d1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 </table>
147 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
148 <div class="textblock"><p>Structure to hold 3D tensor information. </p>
149
150 <p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00104">104</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
151 </div><h2 class="groupheader">Field Documentation</h2>
152 <a class="anchor" id="a35e5a91338398273f3b4a6010004bddd"></a>
153 <div class="memitem">
154 <div class="memproto">
155       <table class="memname">
156         <tr>
157           <td class="memname">int offset_first_element_in_bytes</td>
158         </tr>
159       </table>
160 </div><div class="memdoc">
161
162 <p>The offset of the first element in the source image. </p>
163
164 <p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00107">107</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
165
166 <p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00171">update_tensor3D_workitem_ptr()</a>.</p>
167
168 </div>
169 </div>
170 <a class="anchor" id="acf52c23cbd7424606c10a606524e3e32"></a>
171 <div class="memitem">
172 <div class="memproto">
173       <table class="memname">
174         <tr>
175           <td class="memname">__global uchar* ptr</td>
176         </tr>
177       </table>
178 </div><div class="memdoc">
179
180 <p>Pointer to the starting postion of the buffer. </p>
181
182 <p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00106">106</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
183
184 <p>Referenced by <a class="el" href="convolution__layer_8cl_source.xhtml#l00175">col2im()</a>, <a class="el" href="convolution__layer_8cl_source.xhtml#l00208">im2col_reduced()</a>, <a class="el" href="normalization__layer_8cl_source.xhtml#l00059">normalization_layer_cross_map()</a>, <a class="el" href="normalization__layer_8cl_source.xhtml#l00124">normalization_layer_in_map()</a>, <a class="el" href="convolution__layer_8cl_source.xhtml#l00053">reshape_to_columns()</a>, <a class="el" href="helpers_8h_source.xhtml#l00213">tensor3D_offset()</a>, and <a class="el" href="helpers_8h_source.xhtml#l00171">update_tensor3D_workitem_ptr()</a>.</p>
185
186 </div>
187 </div>
188 <a class="anchor" id="ae01febbfd0689ef709f3ff6fdd2abc7e"></a>
189 <div class="memitem">
190 <div class="memproto">
191       <table class="memname">
192         <tr>
193           <td class="memname">int stride_x</td>
194         </tr>
195       </table>
196 </div><div class="memdoc">
197
198 <p>Stride of the image in X dimension (in bytes) </p>
199
200 <p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00108">108</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
201
202 <p>Referenced by <a class="el" href="convolution__layer_8cl_source.xhtml#l00175">col2im()</a>, and <a class="el" href="helpers_8h_source.xhtml#l00213">tensor3D_offset()</a>.</p>
203
204 </div>
205 </div>
206 <a class="anchor" id="a4f0b90c9ecd6e57ceb3f37332fefe8f1"></a>
207 <div class="memitem">
208 <div class="memproto">
209       <table class="memname">
210         <tr>
211           <td class="memname">int stride_y</td>
212         </tr>
213       </table>
214 </div><div class="memdoc">
215
216 <p>Stride of the image in Y dimension (in bytes) </p>
217
218 <p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00109">109</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
219
220 <p>Referenced by <a class="el" href="convolution__layer_8cl_source.xhtml#l00175">col2im()</a>, and <a class="el" href="helpers_8h_source.xhtml#l00213">tensor3D_offset()</a>.</p>
221
222 </div>
223 </div>
224 <a class="anchor" id="ad5ff7a2b2bd0eec50fe09c254b127d1c"></a>
225 <div class="memitem">
226 <div class="memproto">
227       <table class="memname">
228         <tr>
229           <td class="memname">int stride_z</td>
230         </tr>
231       </table>
232 </div><div class="memdoc">
233
234 <p>Stride of the image in Z dimension (in bytes) </p>
235
236 <p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00110">110</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
237
238 <p>Referenced by <a class="el" href="convolution__layer_8cl_source.xhtml#l00175">col2im()</a>, and <a class="el" href="helpers_8h_source.xhtml#l00213">tensor3D_offset()</a>.</p>
239
240 </div>
241 </div>
242 <hr/>The documentation for this struct was generated from the following file:<ul>
243 <li>src/core/CL/cl_kernels/<a class="el" href="helpers_8h_source.xhtml">helpers.h</a></li>
244 </ul>
245 </div><!-- contents -->
246 </div><!-- doc-content -->
247 <!-- start footer part -->
248 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
249   <ul>
250     <li class="navelem"><a class="el" href="struct_tensor3_d.xhtml">Tensor3D</a></li>
251     <li class="footer">Generated on Wed Apr 12 2017 14:26:05 for ARM Compute Library by
252     <a href="http://www.doxygen.org/index.html">
253     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
254   </ul>
255 </div>
256 </body>
257 </html>