blob: feda79cf5a3b8ba581c6c38c3e6e9b39957118cd [file] [log] [blame]
Jenkins514be652019-02-28 12:25:18 +00001<!-- HTML header for doxygen 1.8.15-->
2<!-- Remember to use version doxygen 1.8.15 +-->
Anthony Barbier871448e2017-03-24 14:54:29 +00003<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml">
5<head>
6<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
7<meta http-equiv="X-UA-Compatible" content="IE=9"/>
Jenkins514be652019-02-28 12:25:18 +00008<meta name="generator" content="Doxygen 1.8.15"/>
Anthony Barbier871448e2017-03-24 14:54:29 +00009<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
Anthony Barbierdbdab852017-06-23 15:42:00 +010010<title>Compute Library: Vector Struct Reference</title>
Anthony Barbier871448e2017-03-24 14:54:29 +000011<link href="tabs.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="jquery.js"></script>
13<script type="text/javascript" src="dynsections.js"></script>
14<link href="navtree.css" rel="stylesheet" type="text/css"/>
15<script type="text/javascript" src="resize.js"></script>
Anthony Barbier8140e1e2017-12-14 23:48:46 +000016<script type="text/javascript" src="navtreedata.js"></script>
Anthony Barbier871448e2017-03-24 14:54:29 +000017<script type="text/javascript" src="navtree.js"></script>
18<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +000019/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Anthony Barbier871448e2017-03-24 14:54:29 +000020 $(document).ready(initResizable);
Jenkins514be652019-02-28 12:25:18 +000021/* @license-end */</script>
Anthony Barbier871448e2017-03-24 14:54:29 +000022<link href="search/search.css" rel="stylesheet" type="text/css"/>
Anthony Barbier8140e1e2017-12-14 23:48:46 +000023<script type="text/javascript" src="search/searchdata.js"></script>
Anthony Barbier871448e2017-03-24 14:54:29 +000024<script type="text/javascript" src="search/search.js"></script>
Anthony Barbier871448e2017-03-24 14:54:29 +000025<script type="text/x-mathjax-config">
26 MathJax.Hub.Config({
27 extensions: ["tex2jax.js"],
28 jax: ["input/TeX","output/HTML-CSS"],
29});
Jenkins514be652019-02-28 12:25:18 +000030</script><script type="text/javascript" async="async" 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" />
Jenkins514be652019-02-28 12:25:18 +000032<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
Anthony Barbier871448e2017-03-24 14:54:29 +000033</head>
34<body>
35<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
36<div id="titlearea">
37<table cellspacing="0" cellpadding="0">
38 <tbody>
39 <tr style="height: 56px;">
Jenkins514be652019-02-28 12:25:18 +000040 <img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/>
Anthony Barbier871448e2017-03-24 14:54:29 +000041 <td style="padding-left: 0.5em;">
Jenkins514be652019-02-28 12:25:18 +000042 <div id="projectname">
Jenkins575c81f2020-03-05 16:07:35 +000043 &#160;<span id="projectnumber">20.02.1</span>
Anthony Barbier871448e2017-03-24 14:54:29 +000044 </div>
45 </td>
46 </tr>
47 </tbody>
48</table>
49</div>
50<!-- end header part -->
Jenkins514be652019-02-28 12:25:18 +000051<!-- Generated by Doxygen 1.8.15 -->
Anthony Barbier871448e2017-03-24 14:54:29 +000052<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +000053/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Anthony Barbier871448e2017-03-24 14:54:29 +000054var searchBox = new SearchBox("searchBox", "search",false,'Search');
Jenkins514be652019-02-28 12:25:18 +000055/* @license-end */
Anthony Barbier871448e2017-03-24 14:54:29 +000056</script>
Jenkinsb9abeae2018-11-22 11:58:08 +000057<script type="text/javascript" src="menudata.js"></script>
58<script type="text/javascript" src="menu.js"></script>
59<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +000060/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Jenkinsb9abeae2018-11-22 11:58:08 +000061$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
Jenkins514be652019-02-28 12:25:18 +000065/* @license-end */</script>
Jenkinsb9abeae2018-11-22 11:58:08 +000066<div id="main-nav"></div>
Anthony Barbier871448e2017-03-24 14:54:29 +000067</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +000079/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Anthony Barbier871448e2017-03-24 14:54:29 +000080$(document).ready(function(){initNavTree('struct_vector.xhtml','');});
Jenkins514be652019-02-28 12:25:18 +000081/* @license-end */
Anthony Barbier871448e2017-03-24 14:54:29 +000082</script>
83<div id="doc-content">
84<!-- window showing the filter options -->
85<div id="MSearchSelectWindow"
86 onmouseover="return searchBox.OnSearchSelectShow()"
87 onmouseout="return searchBox.OnSearchSelectHide()"
88 onkeydown="return searchBox.OnSearchSelectKey(event)">
Anthony Barbier8140e1e2017-12-14 23:48:46 +000089</div>
Anthony Barbier871448e2017-03-24 14:54:29 +000090
91<!-- iframe showing the search results (closed by default) -->
92<div id="MSearchResultsWindow">
93<iframe src="javascript:void(0)" frameborder="0"
94 name="MSearchResults" id="MSearchResults">
95</iframe>
96</div>
97
98<div class="header">
99 <div class="summary">
100<a href="#pub-attribs">Data Fields</a> </div>
101 <div class="headertitle">
102<div class="title">Vector Struct Reference</div> </div>
103</div><!--header-->
104<div class="contents">
105
Jenkins514be652019-02-28 12:25:18 +0000106<p>Structure to hold <a class="el" href="struct_vector.xhtml" title="Structure to hold Vector information.">Vector</a> information.
Anthony Barbier871448e2017-03-24 14:54:29 +0000107 <a href="struct_vector.xhtml#details">More...</a></p>
108
Jenkinsb9abeae2018-11-22 11:58:08 +0000109<p><code>#include &lt;<a class="el" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml">helpers.h</a>&gt;</code></p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000110<table class="memberdecls">
111<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
112Data Fields</h2></td></tr>
113<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>
Anthony Barbier8140e1e2017-12-14 23:48:46 +0000114<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 +0000115<tr class="separator:acf52c23cbd7424606c10a606524e3e32"><td class="memSeparator" colspan="2">&#160;</td></tr>
116<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>
Anthony Barbier8140e1e2017-12-14 23:48:46 +0000117<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 +0000118<tr class="separator:a35e5a91338398273f3b4a6010004bddd"><td class="memSeparator" colspan="2">&#160;</td></tr>
119<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>
Anthony Barbier8140e1e2017-12-14 23:48:46 +0000120<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 +0000121<tr class="separator:ae01febbfd0689ef709f3ff6fdd2abc7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
122</table>
123<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
Jenkins514be652019-02-28 12:25:18 +0000124<div class="textblock"><p>Structure to hold <a class="el" href="struct_vector.xhtml" title="Structure to hold Vector information.">Vector</a> information. </p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000125
Jenkins0e205f72019-11-28 16:53:35 +0000126<p class="definition">Definition at line <a class="el" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml#l00341">341</a> of file <a class="el" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml">helpers.h</a>.</p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000127</div><h2 class="groupheader">Field Documentation</h2>
Jenkinsb9abeae2018-11-22 11:58:08 +0000128<a id="a35e5a91338398273f3b4a6010004bddd"></a>
129<h2 class="memtitle"><span class="permalink"><a href="#a35e5a91338398273f3b4a6010004bddd">&#9670;&nbsp;</a></span>offset_first_element_in_bytes</h2>
130
Anthony Barbier871448e2017-03-24 14:54:29 +0000131<div class="memitem">
132<div class="memproto">
133 <table class="memname">
134 <tr>
135 <td class="memname">int offset_first_element_in_bytes</td>
136 </tr>
137 </table>
138</div><div class="memdoc">
139
140<p>The offset of the first element in the source image. </p>
141
Jenkins0e205f72019-11-28 16:53:35 +0000142<p class="definition">Definition at line <a class="el" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml#l00344">344</a> of file <a class="el" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml">helpers.h</a>.</p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000143
Jenkins0e205f72019-11-28 16:53:35 +0000144<p class="reference">Referenced by <a class="el" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml#l00387">update_vector_workitem_ptr()</a>.</p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000145
146</div>
147</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000148<a id="acf52c23cbd7424606c10a606524e3e32"></a>
149<h2 class="memtitle"><span class="permalink"><a href="#acf52c23cbd7424606c10a606524e3e32">&#9670;&nbsp;</a></span>ptr</h2>
150
Anthony Barbier871448e2017-03-24 14:54:29 +0000151<div class="memitem">
152<div class="memproto">
153 <table class="memname">
154 <tr>
155 <td class="memname">__global uchar* ptr</td>
156 </tr>
157 </table>
158</div><div class="memdoc">
159
160<p>Pointer to the starting postion of the buffer. </p>
161
Jenkins0e205f72019-11-28 16:53:35 +0000162<p class="definition">Definition at line <a class="el" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml#l00343">343</a> of file <a class="el" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml">helpers.h</a>.</p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000163
Jenkins0e205f72019-11-28 16:53:35 +0000164<p class="reference">Referenced by <a class="el" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml#l00387">update_vector_workitem_ptr()</a>, and <a class="el" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml#l00499">vector_offset()</a>.</p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000165
166</div>
167</div>
Jenkinsb9abeae2018-11-22 11:58:08 +0000168<a id="ae01febbfd0689ef709f3ff6fdd2abc7e"></a>
169<h2 class="memtitle"><span class="permalink"><a href="#ae01febbfd0689ef709f3ff6fdd2abc7e">&#9670;&nbsp;</a></span>stride_x</h2>
170
Anthony Barbier871448e2017-03-24 14:54:29 +0000171<div class="memitem">
172<div class="memproto">
173 <table class="memname">
174 <tr>
175 <td class="memname">int stride_x</td>
176 </tr>
177 </table>
178</div><div class="memdoc">
179
180<p>Stride of the image in X dimension (in bytes) </p>
181
Jenkins0e205f72019-11-28 16:53:35 +0000182<p class="definition">Definition at line <a class="el" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml#l00345">345</a> of file <a class="el" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml">helpers.h</a>.</p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000183
Jenkins0e205f72019-11-28 16:53:35 +0000184<p class="reference">Referenced by <a class="el" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml#l00499">vector_offset()</a>.</p>
Anthony Barbier871448e2017-03-24 14:54:29 +0000185
186</div>
187</div>
188<hr/>The documentation for this struct was generated from the following file:<ul>
Jenkinsb9abeae2018-11-22 11:58:08 +0000189<li>src/core/CL/cl_kernels/<a class="el" href="src_2core_2_c_l_2cl__kernels_2_helpers_8h_source.xhtml">helpers.h</a></li>
Anthony Barbier871448e2017-03-24 14:54:29 +0000190</ul>
191</div><!-- contents -->
192</div><!-- doc-content -->
193<!-- start footer part -->
194<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
195 <ul>
196 <li class="navelem"><a class="el" href="struct_vector.xhtml">Vector</a></li>
Jenkins575c81f2020-03-05 16:07:35 +0000197 <li class="footer">Generated on Thu Mar 5 2020 16:07:08 for Compute Library by
Anthony Barbier871448e2017-03-24 14:54:29 +0000198 <a href="http://www.doxygen.org/index.html">
Jenkins514be652019-02-28 12:25:18 +0000199 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
Anthony Barbier871448e2017-03-24 14:54:29 +0000200 </ul>
201</div>
202</body>
203</html>