arm_compute v18.05
[platform/upstream/armcl.git] / documentation / structarm__compute_1_1test_1_1framework_1_1dataset_1_1_initializer_list_dataset_1_1iterator.xhtml
1 <!-- 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"/>
7 <meta name="generator" content="Doxygen 1.8.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: InitializerListDataset&lt; T &gt;::iterator Struct Reference</title>
10 <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>
15 <script type="text/javascript" src="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17 <script type="text/javascript">
18   $(document).ready(initResizable);
19   $(window).load(resizeHeight);
20 </script>
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25   $(document).ready(function() { init_search(); });
26 </script>
27 <script type="text/x-mathjax-config">
28   MathJax.Hub.Config({
29     extensions: ["tex2jax.js"],
30     jax: ["input/TeX","output/HTML-CSS"],
31 });
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 56px;">
41   <td style="padding-left: 0.5em;">
42    <div id="projectname">Compute Library
43    &#160;<span id="projectnumber">18.05</span>
44    </div>
45   </td>
46  </tr>
47  </tbody>
48 </table>
49 </div>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
54 </script>
55   <div id="navrow1" class="tabs">
56     <ul class="tablist">
57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
61       <li><a href="files.xhtml"><span>Files</span></a></li>
62       <li>
63         <div id="MSearchBox" class="MSearchBoxInactive">
64         <span class="left">
65           <img id="MSearchSelect" src="search/mag_sel.png"
66                onmouseover="return searchBox.OnSearchSelectShow()"
67                onmouseout="return searchBox.OnSearchSelectHide()"
68                alt=""/>
69           <input type="text" id="MSearchField" value="Search" accesskey="S"
70                onfocus="searchBox.OnSearchFieldFocus(true)" 
71                onblur="searchBox.OnSearchFieldFocus(false)" 
72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
73           </span><span class="right">
74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
75           </span>
76         </div>
77       </li>
78     </ul>
79   </div>
80   <div id="navrow2" class="tabs2">
81     <ul class="tablist">
82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
86     </ul>
87   </div>
88 </div><!-- top -->
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
90   <div id="nav-tree">
91     <div id="nav-tree-contents">
92       <div id="nav-sync" class="sync"></div>
93     </div>
94   </div>
95   <div id="splitbar" style="-moz-user-select:none;" 
96        class="ui-resizable-handle">
97   </div>
98 </div>
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('structarm__compute_1_1test_1_1framework_1_1dataset_1_1_initializer_list_dataset_1_1iterator.xhtml','');});
101 </script>
102 <div id="doc-content">
103 <!-- window showing the filter options -->
104 <div id="MSearchSelectWindow"
105      onmouseover="return searchBox.OnSearchSelectShow()"
106      onmouseout="return searchBox.OnSearchSelectHide()"
107      onkeydown="return searchBox.OnSearchSelectKey(event)">
108 </div>
109
110 <!-- iframe showing the search results (closed by default) -->
111 <div id="MSearchResultsWindow">
112 <iframe src="javascript:void(0)" frameborder="0" 
113         name="MSearchResults" id="MSearchResults">
114 </iframe>
115 </div>
116
117 <div class="header">
118   <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a>  </div>
120   <div class="headertitle">
121 <div class="title">InitializerListDataset&lt; T &gt;::iterator Struct Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <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.  
126  <a href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_initializer_list_dataset_1_1iterator.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_initializer_list_dataset_8h_source.xhtml">InitializerListDataset.h</a>&gt;</code></p>
129 <table class="memberdecls">
130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
131 Public Member Functions</h2></td></tr>
132 <tr class="memitem:aca6a8613ae6d8960ace1c8894676ed3c"><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_initializer_list_dataset_1_1iterator.xhtml#aca6a8613ae6d8960ace1c8894676ed3c">iterator</a> (std::string <a class="el" href="classarm__compute_1_1test_1_1framework_1_1dataset_1_1_named_dataset.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a>, data_const_iterator <a class="el" href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_initializer_list_dataset_1_1iterator.xhtml">iterator</a>)</td></tr>
133 <tr class="memdesc:aca6a8613ae6d8960ace1c8894676ed3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct an iterator for the dataset.  <a href="#aca6a8613ae6d8960ace1c8894676ed3c">More...</a><br /></td></tr>
134 <tr class="separator:aca6a8613ae6d8960ace1c8894676ed3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <tr class="memitem:a7b5000e45c1386c4e56ef650f6b0ef5b"><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_initializer_list_dataset_1_1iterator.xhtml#a7b5000e45c1386c4e56ef650f6b0ef5b">description</a> () const </td></tr>
136 <tr class="memdesc:a7b5000e45c1386c4e56ef650f6b0ef5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a description of the current value.  <a href="#a7b5000e45c1386c4e56ef650f6b0ef5b">More...</a><br /></td></tr>
137 <tr class="separator:a7b5000e45c1386c4e56ef650f6b0ef5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:af85de6015a44d7ff25198be6265ea56b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1dataset_1_1_initializer_list_dataset.xhtml#a18b86dafc894ede9c2b71030a731a106">InitializerListDataset::type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_initializer_list_dataset_1_1iterator.xhtml#af85de6015a44d7ff25198be6265ea56b">operator*</a> () const </td></tr>
139 <tr class="memdesc:af85de6015a44d7ff25198be6265ea56b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current value.  <a href="#af85de6015a44d7ff25198be6265ea56b">More...</a><br /></td></tr>
140 <tr class="separator:af85de6015a44d7ff25198be6265ea56b"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <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_initializer_list_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_initializer_list_dataset_1_1iterator.xhtml#af1b1c7856a59f34c7d3570f946a2ff00">operator++</a> ()</td></tr>
142 <tr class="memdesc:af1b1c7856a59f34c7d3570f946a2ff00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increment the iterator.  <a href="#af1b1c7856a59f34c7d3570f946a2ff00">More...</a><br /></td></tr>
143 <tr class="separator:af1b1c7856a59f34c7d3570f946a2ff00"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 </table>
145 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
146 <div class="textblock"><h3>template&lt;typename T&gt;<br />
147 struct arm_compute::test::framework::dataset::InitializerListDataset&lt; T &gt;::iterator</h3>
148
149 <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>
150
151 <p>Definition at line <a class="el" href="_initializer_list_dataset_8h_source.xhtml#l00069">69</a> of file <a class="el" href="_initializer_list_dataset_8h_source.xhtml">InitializerListDataset.h</a>.</p>
152 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
153 <a class="anchor" id="aca6a8613ae6d8960ace1c8894676ed3c"></a>
154 <div class="memitem">
155 <div class="memproto">
156 <table class="mlabels">
157   <tr>
158   <td class="mlabels-left">
159       <table class="memname">
160         <tr>
161           <td class="memname"><a class="el" href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_initializer_list_dataset_1_1iterator.xhtml">iterator</a> </td>
162           <td>(</td>
163           <td class="paramtype">std::string&#160;</td>
164           <td class="paramname"><em>name</em>, </td>
165         </tr>
166         <tr>
167           <td class="paramkey"></td>
168           <td></td>
169           <td class="paramtype">data_const_iterator&#160;</td>
170           <td class="paramname"><em>iterator</em>&#160;</td>
171         </tr>
172         <tr>
173           <td></td>
174           <td>)</td>
175           <td></td><td></td>
176         </tr>
177       </table>
178   </td>
179   <td class="mlabels-right">
180 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
181   </tr>
182 </table>
183 </div><div class="memdoc">
184
185 <p>Construct an iterator for the dataset. </p>
186 <dl class="params"><dt>Parameters</dt><dd>
187   <table class="params">
188     <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the dataset. </td></tr>
189     <tr><td class="paramdir">[in]</td><td class="paramname">iterator</td><td><a class="el" href="classarm__compute_1_1_iterator.xhtml" title="Iterator updated by execute_window_loop for each window element. ">Iterator</a> of the dataset values. </td></tr>
190   </table>
191   </dd>
192 </dl>
193
194 <p>Definition at line <a class="el" href="_initializer_list_dataset_8h_source.xhtml#l00076">76</a> of file <a class="el" href="_initializer_list_dataset_8h_source.xhtml">InitializerListDataset.h</a>.</p>
195
196 <p>Referenced by <a class="el" href="_initializer_list_dataset_8h_source.xhtml#l00119">InitializerListDataset&lt; T &gt;::begin()</a>.</p>
197 <div class="fragment"><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;            : _name{ <a class="code" href="classarm__compute_1_1test_1_1framework_1_1dataset_1_1_named_dataset.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a> }, _iterator{ <a class="code" href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_initializer_list_dataset_1_1iterator.xhtml#aca6a8613ae6d8960ace1c8894676ed3c">iterator</a> }</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;        {</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;        }</div><div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1dataset_1_1_named_dataset_xhtml_a37627d5d5bba7f4a8690c71c2ab3cb07"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1dataset_1_1_named_dataset.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">arm_compute::test::framework::dataset::NamedDataset::name</a></div><div class="ttdeci">std::string name() const </div><div class="ttdoc">Return name of the dataset. </div><div class="ttdef"><b>Definition:</b> <a href="_dataset_8h_source.xhtml#l00079">Dataset.h:79</a></div></div>
198 <div class="ttc" id="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_initializer_list_dataset_1_1iterator_xhtml_aca6a8613ae6d8960ace1c8894676ed3c"><div class="ttname"><a href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_initializer_list_dataset_1_1iterator.xhtml#aca6a8613ae6d8960ace1c8894676ed3c">arm_compute::test::framework::dataset::InitializerListDataset::iterator::iterator</a></div><div class="ttdeci">iterator(std::string name, data_const_iterator iterator)</div><div class="ttdoc">Construct an iterator for the dataset. </div><div class="ttdef"><b>Definition:</b> <a href="_initializer_list_dataset_8h_source.xhtml#l00076">InitializerListDataset.h:76</a></div></div>
199 </div><!-- fragment -->
200 </div>
201 </div>
202 <h2 class="groupheader">Member Function Documentation</h2>
203 <a class="anchor" id="a7b5000e45c1386c4e56ef650f6b0ef5b"></a>
204 <div class="memitem">
205 <div class="memproto">
206 <table class="mlabels">
207   <tr>
208   <td class="mlabels-left">
209       <table class="memname">
210         <tr>
211           <td class="memname">std::string description </td>
212           <td>(</td>
213           <td class="paramname"></td><td>)</td>
214           <td> const</td>
215         </tr>
216       </table>
217   </td>
218   <td class="mlabels-right">
219 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
220   </tr>
221 </table>
222 </div><div class="memdoc">
223
224 <p>Get a description of the current value. </p>
225 <dl class="section return"><dt>Returns</dt><dd>a description. </dd></dl>
226
227 <p>Definition at line <a class="el" href="_initializer_list_dataset_8h_source.xhtml#l00085">85</a> of file <a class="el" href="_initializer_list_dataset_8h_source.xhtml">InitializerListDataset.h</a>.</p>
228
229 <p>References <a class="el" href="_dataset_modes_8h_source.xhtml#l00097">arm_compute::test::framework::to_string()</a>, and <a class="el" href="_toolchain_support_8h_source.xhtml#l00197">arm_compute::support::cpp11::to_string()</a>.</p>
230 <div class="fragment"><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;        {</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;            <span class="keyword">using</span> <a class="code" href="namespacearm__compute_1_1support_1_1cpp11.xhtml#acc5dddee1cbe93a4eaf0a9f74ee96bb7">support::cpp11::to_string</a>;</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;            <span class="keywordflow">return</span> _name + <span class="stringliteral">&quot;=&quot;</span> + <a class="code" href="namespacearm__compute_1_1test_1_1framework.xhtml#ace86dc6f3dfa4f3c256b3999ab250c0a">to_string</a>(*_iterator);</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;        }</div><div class="ttc" id="namespacearm__compute_1_1test_1_1framework_xhtml_ace86dc6f3dfa4f3c256b3999ab250c0a"><div class="ttname"><a href="namespacearm__compute_1_1test_1_1framework.xhtml#ace86dc6f3dfa4f3c256b3999ab250c0a">arm_compute::test::framework::to_string</a></div><div class="ttdeci">std::string to_string(DatasetMode mode)</div><div class="ttdef"><b>Definition:</b> <a href="_dataset_modes_8h_source.xhtml#l00097">DatasetModes.h:97</a></div></div>
231 <div class="ttc" id="namespacearm__compute_1_1support_1_1cpp11_xhtml_acc5dddee1cbe93a4eaf0a9f74ee96bb7"><div class="ttname"><a href="namespacearm__compute_1_1support_1_1cpp11.xhtml#acc5dddee1cbe93a4eaf0a9f74ee96bb7">arm_compute::support::cpp11::to_string</a></div><div class="ttdeci">std::string to_string(T &amp;&amp;value)</div><div class="ttdoc">Convert integer and float values to string. </div><div class="ttdef"><b>Definition:</b> <a href="_toolchain_support_8h_source.xhtml#l00197">ToolchainSupport.h:197</a></div></div>
232 </div><!-- fragment -->
233 </div>
234 </div>
235 <a class="anchor" id="af85de6015a44d7ff25198be6265ea56b"></a>
236 <div class="memitem">
237 <div class="memproto">
238 <table class="mlabels">
239   <tr>
240   <td class="mlabels-left">
241       <table class="memname">
242         <tr>
243           <td class="memname"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1dataset_1_1_initializer_list_dataset.xhtml#a18b86dafc894ede9c2b71030a731a106">InitializerListDataset::type</a> operator* </td>
244           <td>(</td>
245           <td class="paramname"></td><td>)</td>
246           <td> const</td>
247         </tr>
248       </table>
249   </td>
250   <td class="mlabels-right">
251 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
252   </tr>
253 </table>
254 </div><div class="memdoc">
255
256 <p>Get the current value. </p>
257 <dl class="section return"><dt>Returns</dt><dd>the current value. </dd></dl>
258
259 <p>Definition at line <a class="el" href="_initializer_list_dataset_8h_source.xhtml#l00095">95</a> of file <a class="el" href="_initializer_list_dataset_8h_source.xhtml">InitializerListDataset.h</a>.</p>
260 <div class="fragment"><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;        {</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;            <span class="keywordflow">return</span> std::make_tuple(*_iterator);</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;        }</div></div><!-- fragment -->
261 </div>
262 </div>
263 <a class="anchor" id="af1b1c7856a59f34c7d3570f946a2ff00"></a>
264 <div class="memitem">
265 <div class="memproto">
266 <table class="mlabels">
267   <tr>
268   <td class="mlabels-left">
269       <table class="memname">
270         <tr>
271           <td class="memname"><a class="el" href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_initializer_list_dataset_1_1iterator.xhtml">iterator</a>&amp; operator++ </td>
272           <td>(</td>
273           <td class="paramname"></td><td>)</td>
274           <td></td>
275         </tr>
276       </table>
277   </td>
278   <td class="mlabels-right">
279 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
280   </tr>
281 </table>
282 </div><div class="memdoc">
283
284 <p>Increment the iterator. </p>
285 <dl class="section return"><dt>Returns</dt><dd>*this. </dd></dl>
286
287 <p>Definition at line <a class="el" href="_initializer_list_dataset_8h_source.xhtml#l00104">104</a> of file <a class="el" href="_initializer_list_dataset_8h_source.xhtml">InitializerListDataset.h</a>.</p>
288 <div class="fragment"><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;        {</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;            ++_iterator;</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;            <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;        }</div></div><!-- fragment -->
289 </div>
290 </div>
291 <hr/>The documentation for this struct was generated from the following file:<ul>
292 <li>tests/framework/datasets/<a class="el" href="_initializer_list_dataset_8h_source.xhtml">InitializerListDataset.h</a></li>
293 </ul>
294 </div><!-- contents -->
295 </div><!-- doc-content -->
296 <!-- start footer part -->
297 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
298   <ul>
299     <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_initializer_list_dataset.xhtml">InitializerListDataset</a></li><li class="navelem"><a class="el" href="structarm__compute_1_1test_1_1framework_1_1dataset_1_1_initializer_list_dataset_1_1iterator.xhtml">iterator</a></li>
300     <li class="footer">Generated on Wed May 23 2018 11:36:44 for Compute Library by
301     <a href="http://www.doxygen.org/index.html">
302     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
303   </ul>
304 </div>
305 </body>
306 </html>