arm_compute v17.09
Change-Id: I4bf8f4e6e5f84ce0d5b6f5ba570d276879f42a81
diff --git a/documentation/struct_transform_impl.xhtml b/documentation/struct_transform_impl.xhtml
new file mode 100644
index 0000000..2b40301
--- /dev/null
+++ b/documentation/struct_transform_impl.xhtml
@@ -0,0 +1,339 @@
+<!-- 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.6"/>
+<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
+<title>Compute Library: TransformImpl< IntBy, BlockBy, Transposed, TOutSize, TInSize > Struct Template 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="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/search.js"></script>
+<script type="text/javascript">
+ $(document).ready(function() { searchBox.OnSelectItem(0); });
+</script>
+<script type="text/x-mathjax-config">
+ MathJax.Hub.Config({
+ extensions: ["tex2jax.js"],
+ jax: ["input/TeX","output/HTML-CSS"],
+});
+</script><script 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">17.09</span>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.6 -->
+<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_transform_impl.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)">
+<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></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-static-methods">Static Public Member Functions</a> </div>
+ <div class="headertitle">
+<div class="title">TransformImpl< IntBy, BlockBy, Transposed, TOutSize, TInSize > Struct Template Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include <<a class="el" href="transform_8hpp_source.xhtml">transform.hpp</a>></code></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
+Static Public Member Functions</h2></td></tr>
+<tr class="memitem:a63b509dd384dfffc0d4f650115799f8b"><td class="memTemplParams" colspan="2">template<typename TOut , typename TIn > </td></tr>
+<tr class="memitem:a63b509dd384dfffc0d4f650115799f8b"><td class="memTemplItemLeft" align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="struct_transform_impl.xhtml#a63b509dd384dfffc0d4f650115799f8b">Transform</a> (TOut *out, const TIn *const in, const int stride, const int y0, const int ymax, const int x0, const int xmax)</td></tr>
+<tr class="separator:a63b509dd384dfffc0d4f650115799f8b"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a1c7a0b8d7bd5f883e459db42f2165755"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
+<tr class="memitem:a1c7a0b8d7bd5f883e459db42f2165755"><td class="memTemplItemLeft" align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="struct_transform_impl.xhtml#a1c7a0b8d7bd5f883e459db42f2165755">Transform</a> (T *out, const T *const in, const int stride, const int k0, const int kmax, const int x0, const int xmax)</td></tr>
+<tr class="separator:a1c7a0b8d7bd5f883e459db42f2165755"><td class="memSeparator" colspan="2"> </td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><h3>template<unsigned IntBy, unsigned int BlockBy, bool Transposed, size_t TOutSize, size_t TInSize><br/>
+struct TransformImpl< IntBy, BlockBy, Transposed, TOutSize, TInSize ></h3>
+
+
+<p>Definition at line <a class="el" href="transform_8hpp_source.xhtml#l00038">38</a> of file <a class="el" href="transform_8hpp_source.xhtml">transform.hpp</a>.</p>
+</div><h2 class="groupheader">Member Function Documentation</h2>
+<a class="anchor" id="a63b509dd384dfffc0d4f650115799f8b"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname">static void Transform </td>
+ <td>(</td>
+ <td class="paramtype">TOut * </td>
+ <td class="paramname"><em>out</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const TIn *const </td>
+ <td class="paramname"><em>in</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const int </td>
+ <td class="paramname"><em>stride</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const int </td>
+ <td class="paramname"><em>y0</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const int </td>
+ <td class="paramname"><em>ymax</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const int </td>
+ <td class="paramname"><em>x0</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const int </td>
+ <td class="paramname"><em>xmax</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+ </td>
+ <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Definition at line <a class="el" href="transform_8hpp_source.xhtml#l00040">40</a> of file <a class="el" href="transform_8hpp_source.xhtml">transform.hpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  {</div>
+<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> n_whole_y_blocks = (ymax - y0) / IntBy;</div>
+<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> y_remainders = (ymax - y0) % IntBy;</div>
+<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> n_y_blocks = n_whole_y_blocks + (y_remainders ? 1 : 0);</div>
+<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
+<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> n_whole_x_blocks = (xmax - x0) / BlockBy;</div>
+<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> x_remainders = (xmax - x0) % BlockBy;</div>
+<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> n_x_blocks = n_whole_x_blocks + (x_remainders ? 1 : 0);</div>
+<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
+<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// "Y" loop: advance down the rows of the source IntBy rows at a time.</span></div>
+<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// Set up fill_rows to show the number rows to copy from, and blank_rows</span></div>
+<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// for the number of blank rows to add.</span></div>
+<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> y_block=0 ; y_block < n_y_blocks; y_block++) {</div>
+<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">int</span> fill_rows = (y_block < n_whole_y_blocks) ? IntBy : y_remainders;</div>
+<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">int</span> blank_rows = IntBy - fill_rows;</div>
+<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
+<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">int</span> y_base = y0 + (y_block * IntBy);</div>
+<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
+<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// So now advance along this block of rows, BlockBy columns at a time.</span></div>
+<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> x_block=0 ; x_block < n_x_blocks; x_block++) {</div>
+<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">int</span> fill_cols = (x_block < n_whole_x_blocks) ? BlockBy : x_remainders;</div>
+<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">int</span> blank_cols = BlockBy - fill_cols;</div>
+<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
+<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">int</span> x_base = x0 + (x_block * BlockBy);</div>
+<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
+<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> row = 0; row < fill_rows; row++) {</div>
+<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> col = 0; col < fill_cols; col++) {</div>
+<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// In-range copy. If it's transposed, we reverse the sense of rows and columns here.</span></div>
+<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">if</span> (Transposed) {</div>
+<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  *out++ = <span class="keyword">static_cast<</span>TOut<span class="keyword">></span>(in[(x_base + col) * stride + y_base + row]);</div>
+<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  } <span class="keywordflow">else</span> {</div>
+<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  *out++ = <span class="keyword">static_cast<</span>TOut<span class="keyword">></span>(in[(y_base + row) * stride + x_base + col]);</div>
+<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div>
+<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</div>
+<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// "col" tail - row is in range but column is out of range.</span></div>
+<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> col=0; col < blank_cols; col++) {</div>
+<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  *out++ = <span class="keyword">static_cast<</span>TOut<span class="keyword">></span>(0);</div>
+<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  }</div>
+<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div>
+<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// "row" tail - row is out of range so fill with zeros always.</span></div>
+<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> row = 0; row < blank_rows; row++) {</div>
+<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> col=0; col < (fill_cols + blank_cols); col++) {</div>
+<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  *out++ = <span class="keyword">static_cast<</span>TOut<span class="keyword">></span>(0);</div>
+<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  }</div>
+<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  }</div>
+<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  }</div>
+<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div>
+<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  }</div>
+</div><!-- fragment -->
+</div>
+</div>
+<a class="anchor" id="a1c7a0b8d7bd5f883e459db42f2165755"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname">static void Transform </td>
+ <td>(</td>
+ <td class="paramtype">T * </td>
+ <td class="paramname"><em>out</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const T *const </td>
+ <td class="paramname"><em>in</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const int </td>
+ <td class="paramname"><em>stride</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const int </td>
+ <td class="paramname"><em>k0</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const int </td>
+ <td class="paramname"><em>kmax</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const int </td>
+ <td class="paramname"><em>x0</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const int </td>
+ <td class="paramname"><em>xmax</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+ </td>
+ <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Definition at line <a class="el" href="transform_8hpp_source.xhtml#l00091">91</a> of file <a class="el" href="transform_8hpp_source.xhtml">transform.hpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  {</div>
+<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  Transform<T, T>(out, in, stride, k0, kmax, x0, xmax);</div>
+<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div>
+</div><!-- fragment -->
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li>arm_compute/core/NEON/kernels/assembly/<a class="el" href="transform_8hpp_source.xhtml">transform.hpp</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_transform_impl.xhtml">TransformImpl</a></li>
+ <li class="footer">Generated on Thu Sep 28 2017 14:37:54 for Compute Library by
+ <a href="http://www.doxygen.org/index.html">
+ <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
+ </ul>
+</div>
+</body>
+</html>