blob: 19c1ae44fccc8fa1bc599aca5fa82b680e25d8bf [file] [log] [blame]
Anthony Barbier871448e2017-03-24 14:54:29 +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"/>
Kaizen8938bd32017-09-28 14:38:23 +01007<meta name="generator" content="Doxygen 1.8.6"/>
Anthony Barbier871448e2017-03-24 14:54:29 +00008<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
Anthony Barbierdbdab852017-06-23 15:42:00 +01009<title>Compute Library: Vector Struct Reference</title>
Anthony Barbier871448e2017-03-24 14:54:29 +000010<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>
Anthony Barbier871448e2017-03-24 14:54:29 +000015<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"/>
Anthony Barbier871448e2017-03-24 14:54:29 +000021<script type="text/javascript" src="search/search.js"></script>
22<script type="text/javascript">
Kaizen8938bd32017-09-28 14:38:23 +010023 $(document).ready(function() { searchBox.OnSelectItem(0); });
Anthony Barbier871448e2017-03-24 14:54:29 +000024</script>
25<script type="text/x-mathjax-config">
26 MathJax.Hub.Config({
27 extensions: ["tex2jax.js"],
28 jax: ["input/TeX","output/HTML-CSS"],
29});
Kaizen8938bd32017-09-28 14:38:23 +010030</script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
Anthony Barbier871448e2017-03-24 14:54:29 +000031<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;">
Anthony Barbierdbdab852017-06-23 15:42:00 +010040 <div id="projectname">Compute Library
Kaizenbf8b01d2017-10-12 14:26:51 +010041 &#160;<span id="projectnumber">17.10</span>
Anthony Barbier871448e2017-03-24 14:54:29 +000042 </div>
43 </td>
44 </tr>
45 </tbody>
46</table>
47</div>
48<!-- end header part -->
Kaizen8938bd32017-09-28 14:38:23 +010049<!-- Generated by Doxygen 1.8.6 -->
Anthony Barbier871448e2017-03-24 14:54:29 +000050<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>
Anthony Barbierdbdab852017-06-23 15:42:00 +010056 <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
Anthony Barbier871448e2017-03-24 14:54:29 +000057 <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_vector.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)">
Kaizen8938bd32017-09-28 14:38:23 +0100106<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>
Anthony Barbier871448e2017-03-24 14:54:29 +0000107
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">Vector Struct Reference</div> </div>
120</div><!--header-->
121<div class="contents">
122
123<p>Structure to hold <a class="el" href="struct_vector.xhtml" title="Structure to hold Vector information. ">Vector</a> information.
124 <a href="struct_vector.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_vector.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a></td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100131<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>
Anthony Barbier871448e2017-03-24 14:54:29 +0000132<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_vector.xhtml#a35e5a91338398273f3b4a6010004bddd">offset_first_element_in_bytes</a></td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100134<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>
Anthony Barbier871448e2017-03-24 14:54:29 +0000135<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_vector.xhtml#ae01febbfd0689ef709f3ff6fdd2abc7e">stride_x</a></td></tr>
Kaizen8938bd32017-09-28 14:38:23 +0100137<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>
Anthony Barbier871448e2017-03-24 14:54:29 +0000138<tr class="separator:ae01febbfd0689ef709f3ff6fdd2abc7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
139</table>
140<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
141<div class="textblock"><p>Structure to hold <a class="el" href="struct_vector.xhtml" title="Structure to hold Vector information. ">Vector</a> information. </p>
142
Kaizenbf8b01d2017-10-12 14:26:51 +0100143<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00126">126</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000144</div><h2 class="groupheader">Field Documentation</h2>
145<a class="anchor" id="a35e5a91338398273f3b4a6010004bddd"></a>
146<div class="memitem">
147<div class="memproto">
148 <table class="memname">
149 <tr>
150 <td class="memname">int offset_first_element_in_bytes</td>
151 </tr>
152 </table>
153</div><div class="memdoc">
154
155<p>The offset of the first element in the source image. </p>
156
Kaizenbf8b01d2017-10-12 14:26:51 +0100157<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00129">129</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000158
Kaizenbf8b01d2017-10-12 14:26:51 +0100159<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00172">update_vector_workitem_ptr()</a>.</p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000160
161</div>
162</div>
163<a class="anchor" id="acf52c23cbd7424606c10a606524e3e32"></a>
164<div class="memitem">
165<div class="memproto">
166 <table class="memname">
167 <tr>
168 <td class="memname">__global uchar* ptr</td>
169 </tr>
170 </table>
171</div><div class="memdoc">
172
173<p>Pointer to the starting postion of the buffer. </p>
174
Kaizenbf8b01d2017-10-12 14:26:51 +0100175<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00128">128</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000176
Kaizenbf8b01d2017-10-12 14:26:51 +0100177<p>Referenced by <a class="el" href="batchnormalization__layer_8cl_source.xhtml#l00081">batchnormalization_layer()</a>, <a class="el" href="dequantization__layer_8cl_source.xhtml#l00049">dequantization_layer()</a>, <a class="el" href="l2__normalize_8cl_source.xhtml#l00045">l2_normalize()</a>, <a class="el" href="reduction__operation_8cl_source.xhtml#l00080">reduction_operation()</a>, <a class="el" href="helpers_8h_source.xhtml#l00172">update_vector_workitem_ptr()</a>, and <a class="el" href="helpers_8h_source.xhtml#l00284">vector_offset()</a>.</p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000178
179</div>
180</div>
181<a class="anchor" id="ae01febbfd0689ef709f3ff6fdd2abc7e"></a>
182<div class="memitem">
183<div class="memproto">
184 <table class="memname">
185 <tr>
186 <td class="memname">int stride_x</td>
187 </tr>
188 </table>
189</div><div class="memdoc">
190
191<p>Stride of the image in X dimension (in bytes) </p>
192
Kaizenbf8b01d2017-10-12 14:26:51 +0100193<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00130">130</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000194
Kaizenbf8b01d2017-10-12 14:26:51 +0100195<p>Referenced by <a class="el" href="batchnormalization__layer_8cl_source.xhtml#l00081">batchnormalization_layer()</a>, and <a class="el" href="helpers_8h_source.xhtml#l00284">vector_offset()</a>.</p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000196
197</div>
198</div>
199<hr/>The documentation for this struct was generated from the following file:<ul>
200<li>src/core/CL/cl_kernels/<a class="el" href="helpers_8h_source.xhtml">helpers.h</a></li>
201</ul>
202</div><!-- contents -->
203</div><!-- doc-content -->
204<!-- start footer part -->
205<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
206 <ul>
207 <li class="navelem"><a class="el" href="struct_vector.xhtml">Vector</a></li>
Kaizenbf8b01d2017-10-12 14:26:51 +0100208 <li class="footer">Generated on Thu Oct 12 2017 14:26:35 for Compute Library by
Anthony Barbier871448e2017-03-24 14:54:29 +0000209 <a href="http://www.doxygen.org/index.html">
Kaizen8938bd32017-09-28 14:38:23 +0100210 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
Anthony Barbier871448e2017-03-24 14:54:29 +0000211 </ul>
212</div>
213</body>
214</html>