arm_compute v18.01
Change-Id: I9bfa178c2e38bfd5fc812e62aab6760d87748e05
diff --git a/documentation/struct_tensor4_d.xhtml b/documentation/struct_tensor4_d.xhtml
new file mode 100644
index 0000000..b263102
--- /dev/null
+++ b/documentation/struct_tensor4_d.xhtml
@@ -0,0 +1,279 @@
+<!-- HTML header for doxygen 1.8.9.1-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.11"/>
+<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
+<title>Compute Library: Tensor4D Struct Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtreedata.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<script type="text/javascript">
+ $(document).ready(initResizable);
+ $(window).load(resizeHeight);
+</script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+ $(document).ready(function() { init_search(); });
+</script>
+<script type="text/x-mathjax-config">
+ MathJax.Hub.Config({
+ extensions: ["tex2jax.js"],
+ jax: ["input/TeX","output/HTML-CSS"],
+});
+</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+ <td style="padding-left: 0.5em;">
+ <div id="projectname">Compute Library
+  <span id="projectnumber">18.01</span>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.11 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+ <div id="navrow1" class="tabs">
+ <ul class="tablist">
+ <li><a href="index.xhtml"><span>Main Page</span></a></li>
+ <li><a href="pages.xhtml"><span>Related Pages</span></a></li>
+ <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
+ <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
+ <li><a href="files.xhtml"><span>Files</span></a></li>
+ <li>
+ <div id="MSearchBox" class="MSearchBoxInactive">
+ <span class="left">
+ <img id="MSearchSelect" src="search/mag_sel.png"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ alt=""/>
+ <input type="text" id="MSearchField" value="Search" accesskey="S"
+ onfocus="searchBox.OnSearchFieldFocus(true)"
+ onblur="searchBox.OnSearchFieldFocus(false)"
+ onkeyup="searchBox.OnSearchFieldChange(event)"/>
+ </span><span class="right">
+ <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+ </span>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <div id="navrow2" class="tabs2">
+ <ul class="tablist">
+ <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
+ <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
+ <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
+ <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
+ </ul>
+ </div>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+ <div id="nav-tree">
+ <div id="nav-tree-contents">
+ <div id="nav-sync" class="sync"></div>
+ </div>
+ </div>
+ <div id="splitbar" style="-moz-user-select:none;"
+ class="ui-resizable-handle">
+ </div>
+</div>
+<script type="text/javascript">
+$(document).ready(function(){initNavTree('struct_tensor4_d.xhtml','');});
+</script>
+<div id="doc-content">
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0"
+ name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="header">
+ <div class="summary">
+<a href="#pub-attribs">Data Fields</a> </div>
+ <div class="headertitle">
+<div class="title">Tensor4D Struct Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p>Structure to hold 4D tensor information.
+ <a href="struct_tensor4_d.xhtml#details">More...</a></p>
+
+<p><code>#include <<a class="el" href="helpers_8h_source.xhtml">helpers.h</a>></code></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
+Data Fields</h2></td></tr>
+<tr class="memitem:acf52c23cbd7424606c10a606524e3e32"><td class="memItemLeft" align="right" valign="top">__global uchar * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor4_d.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a></td></tr>
+<tr class="memdesc:acf52c23cbd7424606c10a606524e3e32"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the starting postion of the buffer. <a href="#acf52c23cbd7424606c10a606524e3e32">More...</a><br /></td></tr>
+<tr class="separator:acf52c23cbd7424606c10a606524e3e32"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a35e5a91338398273f3b4a6010004bddd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor4_d.xhtml#a35e5a91338398273f3b4a6010004bddd">offset_first_element_in_bytes</a></td></tr>
+<tr class="memdesc:a35e5a91338398273f3b4a6010004bddd"><td class="mdescLeft"> </td><td class="mdescRight">The offset of the first element in the source image. <a href="#a35e5a91338398273f3b4a6010004bddd">More...</a><br /></td></tr>
+<tr class="separator:a35e5a91338398273f3b4a6010004bddd"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:ae01febbfd0689ef709f3ff6fdd2abc7e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor4_d.xhtml#ae01febbfd0689ef709f3ff6fdd2abc7e">stride_x</a></td></tr>
+<tr class="memdesc:ae01febbfd0689ef709f3ff6fdd2abc7e"><td class="mdescLeft"> </td><td class="mdescRight">Stride of the image in X dimension (in bytes) <a href="#ae01febbfd0689ef709f3ff6fdd2abc7e">More...</a><br /></td></tr>
+<tr class="separator:ae01febbfd0689ef709f3ff6fdd2abc7e"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a4f0b90c9ecd6e57ceb3f37332fefe8f1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor4_d.xhtml#a4f0b90c9ecd6e57ceb3f37332fefe8f1">stride_y</a></td></tr>
+<tr class="memdesc:a4f0b90c9ecd6e57ceb3f37332fefe8f1"><td class="mdescLeft"> </td><td class="mdescRight">Stride of the image in Y dimension (in bytes) <a href="#a4f0b90c9ecd6e57ceb3f37332fefe8f1">More...</a><br /></td></tr>
+<tr class="separator:a4f0b90c9ecd6e57ceb3f37332fefe8f1"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:ad5ff7a2b2bd0eec50fe09c254b127d1c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor4_d.xhtml#ad5ff7a2b2bd0eec50fe09c254b127d1c">stride_z</a></td></tr>
+<tr class="memdesc:ad5ff7a2b2bd0eec50fe09c254b127d1c"><td class="mdescLeft"> </td><td class="mdescRight">Stride of the image in Z dimension (in bytes) <a href="#ad5ff7a2b2bd0eec50fe09c254b127d1c">More...</a><br /></td></tr>
+<tr class="separator:ad5ff7a2b2bd0eec50fe09c254b127d1c"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a13a60f6e75f64f1953b8858ea454a880"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_tensor4_d.xhtml#a13a60f6e75f64f1953b8858ea454a880">stride_w</a></td></tr>
+<tr class="memdesc:a13a60f6e75f64f1953b8858ea454a880"><td class="mdescLeft"> </td><td class="mdescRight">Stride of the image in W dimension (in bytes) <a href="#a13a60f6e75f64f1953b8858ea454a880">More...</a><br /></td></tr>
+<tr class="separator:a13a60f6e75f64f1953b8858ea454a880"><td class="memSeparator" colspan="2"> </td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>Structure to hold 4D tensor information. </p>
+
+<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>
+</div><h2 class="groupheader">Field Documentation</h2>
+<a class="anchor" id="a35e5a91338398273f3b4a6010004bddd"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">int offset_first_element_in_bytes</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>The offset of the first element in the source image. </p>
+
+<p>Definition at line <a class="el" href="helpers_8h_source.xhtml#l00162">162</a> of file <a class="el" href="helpers_8h_source.xhtml">helpers.h</a>.</p>
+
+<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00267">update_tensor4D_workitem_ptr()</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="acf52c23cbd7424606c10a606524e3e32"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">__global uchar* ptr</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Pointer to the starting postion of the buffer. </p>
+
+<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>
+
+<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00326">tensor4D_offset()</a>, and <a class="el" href="helpers_8h_source.xhtml#l00267">update_tensor4D_workitem_ptr()</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a13a60f6e75f64f1953b8858ea454a880"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">int stride_w</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Stride of the image in W dimension (in bytes) </p>
+
+<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>
+
+<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00326">tensor4D_offset()</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="ae01febbfd0689ef709f3ff6fdd2abc7e"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">int stride_x</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Stride of the image in X dimension (in bytes) </p>
+
+<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>
+
+<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00326">tensor4D_offset()</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a4f0b90c9ecd6e57ceb3f37332fefe8f1"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">int stride_y</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Stride of the image in Y dimension (in bytes) </p>
+
+<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>
+
+<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00326">tensor4D_offset()</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="ad5ff7a2b2bd0eec50fe09c254b127d1c"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">int stride_z</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Stride of the image in Z dimension (in bytes) </p>
+
+<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>
+
+<p>Referenced by <a class="el" href="helpers_8h_source.xhtml#l00326">tensor4D_offset()</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li>src/core/CL/cl_kernels/<a class="el" href="helpers_8h_source.xhtml">helpers.h</a></li>
+</ul>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+ <ul>
+ <li class="navelem"><a class="el" href="struct_tensor4_d.xhtml">Tensor4D</a></li>
+ <li class="footer">Generated on Wed Jan 24 2018 14:30:43 for Compute Library by
+ <a href="http://www.doxygen.org/index.html">
+ <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
+ </ul>
+</div>
+</body>
+</html>