blob: cd68017540b707abebb9c3908675084e865b6d14 [file] [log] [blame]
<!-- HTML header for doxygen 1.8.15-->
<!-- Remember to use version doxygen 1.8.15 +-->
<!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.15"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: JoinDataset&lt; T, U &gt;::iterator 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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="stylesheet.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;">
<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"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
&#160;<span id="projectnumber">20.02.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structarm__compute_1_1test_1_1framework_1_1dataset_1_1_join_dataset_1_1iterator.xhtml','');});
/* @license-end */
</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-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">JoinDataset&lt; T, U &gt;::iterator Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classarm__compute_1_1_iterator.xhtml" title="Iterator updated by execute_window_loop for each window element.">Iterator</a> for the dataset.
<a href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_join_dataset_1_1iterator.xhtml#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_join_dataset_8h_source.xhtml">JoinDataset.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a78cc7b5e65362760bcd99d070d163e94"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_join_dataset_1_1iterator.xhtml#a78cc7b5e65362760bcd99d070d163e94">iterator</a> (const T_noref *dataset1, const U_noref *dataset2)</td></tr>
<tr class="memdesc:a78cc7b5e65362760bcd99d070d163e94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct an iterator. <a href="#a78cc7b5e65362760bcd99d070d163e94">More...</a><br /></td></tr>
<tr class="separator:a78cc7b5e65362760bcd99d070d163e94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07ffe70037e0a16554c868bcdd8f83b5"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_join_dataset_1_1iterator.xhtml#a07ffe70037e0a16554c868bcdd8f83b5">description</a> () const</td></tr>
<tr class="memdesc:a07ffe70037e0a16554c868bcdd8f83b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the description of the current value. <a href="#a07ffe70037e0a16554c868bcdd8f83b5">More...</a><br /></td></tr>
<tr class="separator:a07ffe70037e0a16554c868bcdd8f83b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35793b9a0d8f7463a92c27eb1561891a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1dataset_1_1_join_dataset.xhtml#ad4f1d01a0af9cf719345464b2c3821ca">JoinDataset::type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_join_dataset_1_1iterator.xhtml#a35793b9a0d8f7463a92c27eb1561891a">operator *</a> () const</td></tr>
<tr class="memdesc:a35793b9a0d8f7463a92c27eb1561891a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of the iterator. <a href="#a35793b9a0d8f7463a92c27eb1561891a">More...</a><br /></td></tr>
<tr class="separator:a35793b9a0d8f7463a92c27eb1561891a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1b1c7856a59f34c7d3570f946a2ff00"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_join_dataset_1_1iterator.xhtml">iterator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_join_dataset_1_1iterator.xhtml#af1b1c7856a59f34c7d3570f946a2ff00">operator++</a> ()</td></tr>
<tr class="memdesc:af1b1c7856a59f34c7d3570f946a2ff00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inrement the iterator. <a href="#af1b1c7856a59f34c7d3570f946a2ff00">More...</a><br /></td></tr>
<tr class="separator:af1b1c7856a59f34c7d3570f946a2ff00"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T, typename U&gt;<br />
struct arm_compute::test::framework::dataset::JoinDataset&lt; T, U &gt;::iterator</h3>
<p><a class="el" href="classarm__compute_1_1_iterator.xhtml" title="Iterator updated by execute_window_loop for each window element.">Iterator</a> for the dataset. </p>
<p class="definition">Definition at line <a class="el" href="_join_dataset_8h_source.xhtml#l00074">74</a> of file <a class="el" href="_join_dataset_8h_source.xhtml">JoinDataset.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a78cc7b5e65362760bcd99d070d163e94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78cc7b5e65362760bcd99d070d163e94">&#9670;&nbsp;</a></span>iterator()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_join_dataset_1_1iterator.xhtml">iterator</a> </td>
<td>(</td>
<td class="paramtype">const T_noref *&#160;</td>
<td class="paramname"><em>dataset1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const U_noref *&#160;</td>
<td class="paramname"><em>dataset2</em>&#160;</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct an iterator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dataset1</td><td><a class="el" href="classarm__compute_1_1test_1_1framework_1_1dataset_1_1_dataset.xhtml" title="Abstract dataset base class.">Dataset</a> 1. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dataset2</td><td><a class="el" href="classarm__compute_1_1test_1_1framework_1_1dataset_1_1_dataset.xhtml" title="Abstract dataset base class.">Dataset</a> 2. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_join_dataset_8h_source.xhtml#l00081">81</a> of file <a class="el" href="_join_dataset_8h_source.xhtml">JoinDataset.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; : _iter1{ dataset1-&gt;begin() }, _iter2{ dataset2-&gt;begin() }, _first_size{ dataset1-&gt;size() }</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; }</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a07ffe70037e0a16554c868bcdd8f83b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07ffe70037e0a16554c868bcdd8f83b5">&#9670;&nbsp;</a></span>description()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string description </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the description of the current value. </p>
<dl class="section return"><dt>Returns</dt><dd>description of the current value. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_join_dataset_8h_source.xhtml#l00090">90</a> of file <a class="el" href="_join_dataset_8h_source.xhtml">JoinDataset.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; {</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordflow">return</span> _first_size &gt; 0 ? _iter1.description() : _iter2.description();</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; }</div></div><!-- fragment -->
</div>
</div>
<a id="a35793b9a0d8f7463a92c27eb1561891a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35793b9a0d8f7463a92c27eb1561891a">&#9670;&nbsp;</a></span>operator *()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1dataset_1_1_join_dataset.xhtml#ad4f1d01a0af9cf719345464b2c3821ca">JoinDataset::type</a> operator * </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the value of the iterator. </p>
<dl class="section return"><dt>Returns</dt><dd>the value of the iterator. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_join_dataset_8h_source.xhtml#l00099">99</a> of file <a class="el" href="_join_dataset_8h_source.xhtml">JoinDataset.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; {</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordflow">return</span> _first_size &gt; 0 ? *_iter1 : *_iter2;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; }</div></div><!-- fragment -->
</div>
</div>
<a id="af1b1c7856a59f34c7d3570f946a2ff00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1b1c7856a59f34c7d3570f946a2ff00">&#9670;&nbsp;</a></span>operator++()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_join_dataset_1_1iterator.xhtml">iterator</a>&amp; operator++ </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Inrement the iterator. </p>
<dl class="section return"><dt>Returns</dt><dd>*this; </dd></dl>
<p class="definition">Definition at line <a class="el" href="_join_dataset_8h_source.xhtml#l00108">108</a> of file <a class="el" href="_join_dataset_8h_source.xhtml">JoinDataset.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; {</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordflow">if</span>(_first_size &gt; 0)</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; {</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; --_first_size;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; ++_iter1;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; }</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordflow">else</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; {</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; ++_iter2;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; }</div></div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>tests/framework/datasets/<a class="el" href="_join_dataset_8h_source.xhtml">JoinDataset.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="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test.xhtml">test</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test_1_1framework.xhtml">framework</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test_1_1framework_1_1dataset.xhtml">dataset</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1dataset_1_1_join_dataset.xhtml">JoinDataset</a></li><li class="navelem"><a class="el" href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_join_dataset_1_1iterator.xhtml">iterator</a></li>
<li class="footer">Generated on Thu Mar 5 2020 16:07:19 for Compute Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>