blob: 1ecd87853e14cf56106fe57f9a18205cb1bd653e [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: dmlc::Config::ConfigIterator Class 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="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>
<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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacedmlc.html">dmlc</a></li><li class="navelem"><a class="el" href="classdmlc_1_1Config.html">Config</a></li><li class="navelem"><a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html">ConfigIterator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classdmlc_1_1Config_1_1ConfigIterator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dmlc::Config::ConfigIterator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>iterator class
<a href="classdmlc_1_1Config_1_1ConfigIterator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="config_8h_source.html">config.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for dmlc::Config::ConfigIterator:</div>
<div class="dyncontent">
<div class="center"><img src="classdmlc_1_1Config_1_1ConfigIterator__inherit__graph.png" border="0" usemap="#dmlc_1_1Config_1_1ConfigIterator_inherit__map" alt="Inheritance graph"/></div>
<!-- MAP 0 -->
</div>
<div class="dynheader">
Collaboration diagram for dmlc::Config::ConfigIterator:</div>
<div class="dyncontent">
<div class="center"><img src="classdmlc_1_1Config_1_1ConfigIterator__coll__graph.png" border="0" usemap="#dmlc_1_1Config_1_1ConfigIterator_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 1 -->
</div>
<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:aadadec1b2070d1e430aa49775319f375"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html#aadadec1b2070d1e430aa49775319f375">ConfigIterator</a> (const <a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html">ConfigIterator</a> &amp;other)</td></tr>
<tr class="memdesc:aadadec1b2070d1e430aa49775319f375"><td class="mdescLeft">&#160;</td><td class="mdescRight">copy constructor <a href="classdmlc_1_1Config_1_1ConfigIterator.html#aadadec1b2070d1e430aa49775319f375">More...</a><br /></td></tr>
<tr class="separator:aadadec1b2070d1e430aa49775319f375"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af20f1284874538c4a1abd0ec0e0f96ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html">ConfigIterator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html#af20f1284874538c4a1abd0ec0e0f96ca">operator++</a> ()</td></tr>
<tr class="memdesc:af20f1284874538c4a1abd0ec0e0f96ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">uni-increment operators <a href="classdmlc_1_1Config_1_1ConfigIterator.html#af20f1284874538c4a1abd0ec0e0f96ca">More...</a><br /></td></tr>
<tr class="separator:af20f1284874538c4a1abd0ec0e0f96ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b919e11fde7b3bfa6b8644d5aadaa6b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html">ConfigIterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html#a2b919e11fde7b3bfa6b8644d5aadaa6b">operator++</a> (int)</td></tr>
<tr class="memdesc:a2b919e11fde7b3bfa6b8644d5aadaa6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">uni-increment operators <a href="classdmlc_1_1Config_1_1ConfigIterator.html#a2b919e11fde7b3bfa6b8644d5aadaa6b">More...</a><br /></td></tr>
<tr class="separator:a2b919e11fde7b3bfa6b8644d5aadaa6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7499012829abcde9a27634f3e85e4f8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html#ab7499012829abcde9a27634f3e85e4f8">operator==</a> (const <a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html">ConfigIterator</a> &amp;rhs) const</td></tr>
<tr class="memdesc:ab7499012829abcde9a27634f3e85e4f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">compare operators <a href="classdmlc_1_1Config_1_1ConfigIterator.html#ab7499012829abcde9a27634f3e85e4f8">More...</a><br /></td></tr>
<tr class="separator:ab7499012829abcde9a27634f3e85e4f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab470fe8f202f8fcf5fe6f651db05d9ef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html#ab470fe8f202f8fcf5fe6f651db05d9ef">operator!=</a> (const <a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html">ConfigIterator</a> &amp;rhs) const</td></tr>
<tr class="memdesc:ab470fe8f202f8fcf5fe6f651db05d9ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">compare operators not equal <a href="classdmlc_1_1Config_1_1ConfigIterator.html#ab470fe8f202f8fcf5fe6f651db05d9ef">More...</a><br /></td></tr>
<tr class="separator:ab470fe8f202f8fcf5fe6f651db05d9ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa05de21d345f9a0a417a8596b51517bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1Config.html#afc2e054db64f1ece11f3bac84d775d12">ConfigEntry</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html#aa05de21d345f9a0a417a8596b51517bb">operator*</a> () const</td></tr>
<tr class="memdesc:aa05de21d345f9a0a417a8596b51517bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">retrieve value from operator <a href="classdmlc_1_1Config_1_1ConfigIterator.html#aa05de21d345f9a0a417a8596b51517bb">More...</a><br /></td></tr>
<tr class="separator:aa05de21d345f9a0a417a8596b51517bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ac3da7e21a05bf8852638db7e4dd1b81a"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html#ac3da7e21a05bf8852638db7e4dd1b81a">Config</a></td></tr>
<tr class="separator:ac3da7e21a05bf8852638db7e4dd1b81a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>iterator class </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aadadec1b2070d1e430aa49775319f375"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aadadec1b2070d1e430aa49775319f375">&#9670;&nbsp;</a></span>ConfigIterator()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dmlc::Config::ConfigIterator::ConfigIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html">ConfigIterator</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>copy constructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab470fe8f202f8fcf5fe6f651db05d9ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab470fe8f202f8fcf5fe6f651db05d9ef">&#9670;&nbsp;</a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dmlc::Config::ConfigIterator::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html">ConfigIterator</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>compare operators not equal </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rhs</td><td>the other config to compare against </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the compared result </dd></dl>
</div>
</div>
<a id="aa05de21d345f9a0a417a8596b51517bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa05de21d345f9a0a417a8596b51517bb">&#9670;&nbsp;</a></span>operator*()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdmlc_1_1Config.html#afc2e054db64f1ece11f3bac84d775d12">ConfigEntry</a> dmlc::Config::ConfigIterator::operator* </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>retrieve value from operator </p>
</div>
</div>
<a id="af20f1284874538c4a1abd0ec0e0f96ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af20f1284874538c4a1abd0ec0e0f96ca">&#9670;&nbsp;</a></span>operator++() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html">ConfigIterator</a>&amp; dmlc::Config::ConfigIterator::operator++ </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>uni-increment operators </p>
<dl class="section return"><dt>Returns</dt><dd>the reference of current config </dd></dl>
</div>
</div>
<a id="a2b919e11fde7b3bfa6b8644d5aadaa6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b919e11fde7b3bfa6b8644d5aadaa6b">&#9670;&nbsp;</a></span>operator++() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html">ConfigIterator</a> dmlc::Config::ConfigIterator::operator++ </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>uni-increment operators </p>
<dl class="section return"><dt>Returns</dt><dd>the reference of current config </dd></dl>
</div>
</div>
<a id="ab7499012829abcde9a27634f3e85e4f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7499012829abcde9a27634f3e85e4f8">&#9670;&nbsp;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dmlc::Config::ConfigIterator::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html">ConfigIterator</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>compare operators </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rhs</td><td>the other config to compare against </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the compared result </dd></dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="ac3da7e21a05bf8852638db7e4dd1b81a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3da7e21a05bf8852638db7e4dd1b81a">&#9670;&nbsp;</a></span>Config</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classdmlc_1_1Config.html">Config</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/work/mxnet/3rdparty/dmlc-core/include/dmlc/<a class="el" href="config_8h_source.html">config.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:40 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>