| <!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 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&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&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> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classdmlc_1_1Config-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::Config Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>class for config parser |
| <a href="classdmlc_1_1Config.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="config_8h_source.html">config.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::Config:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1Config__coll__graph.png" border="0" usemap="#dmlc_1_1Config_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 0 --> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html">ConfigIterator</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">iterator class <a href="classdmlc_1_1Config_1_1ConfigIterator.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:afc2e054db64f1ece11f3bac84d775d12"><td class="memItemLeft" align="right" valign="top">typedef std::pair< std::string, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config.html#afc2e054db64f1ece11f3bac84d775d12">ConfigEntry</a></td></tr> |
| <tr class="memdesc:afc2e054db64f1ece11f3bac84d775d12"><td class="mdescLeft"> </td><td class="mdescRight">type when extracting from iterator <a href="classdmlc_1_1Config.html#afc2e054db64f1ece11f3bac84d775d12">More...</a><br /></td></tr> |
| <tr class="separator:afc2e054db64f1ece11f3bac84d775d12"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><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:aaf5cc7d0b8147e671693827db4772a3a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config.html#aaf5cc7d0b8147e671693827db4772a3a">Config</a> (bool multi_value=false)</td></tr> |
| <tr class="memdesc:aaf5cc7d0b8147e671693827db4772a3a"><td class="mdescLeft"> </td><td class="mdescRight">create empty config <a href="classdmlc_1_1Config.html#aaf5cc7d0b8147e671693827db4772a3a">More...</a><br /></td></tr> |
| <tr class="separator:aaf5cc7d0b8147e671693827db4772a3a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4ca685b092b7745eca0b3a5bb4e5102f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config.html#a4ca685b092b7745eca0b3a5bb4e5102f">Config</a> (std::istream &is, bool multi_value=false)</td></tr> |
| <tr class="memdesc:a4ca685b092b7745eca0b3a5bb4e5102f"><td class="mdescLeft"> </td><td class="mdescRight">create config and load content from the given stream <a href="classdmlc_1_1Config.html#a4ca685b092b7745eca0b3a5bb4e5102f">More...</a><br /></td></tr> |
| <tr class="separator:a4ca685b092b7745eca0b3a5bb4e5102f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a207c8acc2017acc2d3d655863d6edb5f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config.html#a207c8acc2017acc2d3d655863d6edb5f">Clear</a> (void)</td></tr> |
| <tr class="memdesc:a207c8acc2017acc2d3d655863d6edb5f"><td class="mdescLeft"> </td><td class="mdescRight">clear all the values <a href="classdmlc_1_1Config.html#a207c8acc2017acc2d3d655863d6edb5f">More...</a><br /></td></tr> |
| <tr class="separator:a207c8acc2017acc2d3d655863d6edb5f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af2b8b9527113ebb371bfc20119d52f98"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config.html#af2b8b9527113ebb371bfc20119d52f98">LoadFromStream</a> (std::istream &is)</td></tr> |
| <tr class="memdesc:af2b8b9527113ebb371bfc20119d52f98"><td class="mdescLeft"> </td><td class="mdescRight">load the contents from the stream <a href="classdmlc_1_1Config.html#af2b8b9527113ebb371bfc20119d52f98">More...</a><br /></td></tr> |
| <tr class="separator:af2b8b9527113ebb371bfc20119d52f98"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaee438e73aea45b432badb46c328a93a"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:aaee438e73aea45b432badb46c328a93a"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config.html#aaee438e73aea45b432badb46c328a93a">SetParam</a> (const std::string &key, const T &value, bool is_string=false)</td></tr> |
| <tr class="memdesc:aaee438e73aea45b432badb46c328a93a"><td class="mdescLeft"> </td><td class="mdescRight">set a key-value pair into the config; if the key already exists in the configure file, it will either replace the old value with the given one (in non-multi value mode) or store it directly (in multi-value mode); <a href="classdmlc_1_1Config.html#aaee438e73aea45b432badb46c328a93a">More...</a><br /></td></tr> |
| <tr class="separator:aaee438e73aea45b432badb46c328a93a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6d02501d01e99cb87b6462041aaa07b7"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config.html#a6d02501d01e99cb87b6462041aaa07b7">GetParam</a> (const std::string &key) const</td></tr> |
| <tr class="memdesc:a6d02501d01e99cb87b6462041aaa07b7"><td class="mdescLeft"> </td><td class="mdescRight">get the config under the key; if multiple values exist for the same key, return the last inserted one. <a href="classdmlc_1_1Config.html#a6d02501d01e99cb87b6462041aaa07b7">More...</a><br /></td></tr> |
| <tr class="separator:a6d02501d01e99cb87b6462041aaa07b7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a220891b3a485a68ad185de569e20a517"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config.html#a220891b3a485a68ad185de569e20a517">IsGenuineString</a> (const std::string &key) const</td></tr> |
| <tr class="memdesc:a220891b3a485a68ad185de569e20a517"><td class="mdescLeft"> </td><td class="mdescRight">check whether the configure value given by the key should be wrapped by quotes <a href="classdmlc_1_1Config.html#a220891b3a485a68ad185de569e20a517">More...</a><br /></td></tr> |
| <tr class="separator:a220891b3a485a68ad185de569e20a517"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afa8bf1b57515a781eb36106482a8a471"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config.html#afa8bf1b57515a781eb36106482a8a471">ToProtoString</a> (void) const</td></tr> |
| <tr class="memdesc:afa8bf1b57515a781eb36106482a8a471"><td class="mdescLeft"> </td><td class="mdescRight">transform all the configuration into string recognizable to protobuf <a href="classdmlc_1_1Config.html#afa8bf1b57515a781eb36106482a8a471">More...</a><br /></td></tr> |
| <tr class="separator:afa8bf1b57515a781eb36106482a8a471"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac2067ad6855bbe6992a5f83d1d3ad2f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html">ConfigIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config.html#ac2067ad6855bbe6992a5f83d1d3ad2f8">begin</a> () const</td></tr> |
| <tr class="memdesc:ac2067ad6855bbe6992a5f83d1d3ad2f8"><td class="mdescLeft"> </td><td class="mdescRight">get begin iterator <a href="classdmlc_1_1Config.html#ac2067ad6855bbe6992a5f83d1d3ad2f8">More...</a><br /></td></tr> |
| <tr class="separator:ac2067ad6855bbe6992a5f83d1d3ad2f8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3c83ca1539a914e39564c9675b6c9ae8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html">ConfigIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Config.html#a3c83ca1539a914e39564c9675b6c9ae8">end</a> () const</td></tr> |
| <tr class="memdesc:a3c83ca1539a914e39564c9675b6c9ae8"><td class="mdescLeft"> </td><td class="mdescRight">get end iterator <a href="classdmlc_1_1Config.html#a3c83ca1539a914e39564c9675b6c9ae8">More...</a><br /></td></tr> |
| <tr class="separator:a3c83ca1539a914e39564c9675b6c9ae8"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>class for config parser </p> |
| <p>Two modes are supported:</p><ol type="1"> |
| <li>non-multi value mode: if two same keys in the configure file, the later one will replace the ealier one; when using iterator, the order will be the "last effective insersion" order</li> |
| <li>multi value mode: multiple values with the same key could co-exist; when using iterator, the order will be the insersion order.</li> |
| </ol> |
| <p>[Basic usage]</p> |
| <p><a class="el" href="classdmlc_1_1Config.html" title="class for config parser">Config</a> cfg(file_input_stream); for(<a class="el" href="classdmlc_1_1Config_1_1ConfigIterator.html" title="iterator class">Config::ConfigIterator</a> iter = cfg.begin(); iter != cfg.end(); ++iter) { ConfigEntry ent = *iter; std::string key = ent.first; std::string value = ent.second; do_something_with(key, value); } </p> |
| </div><h2 class="groupheader">Member Typedef Documentation</h2> |
| <a id="afc2e054db64f1ece11f3bac84d775d12"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afc2e054db64f1ece11f3bac84d775d12">◆ </a></span>ConfigEntry</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef std::pair<std::string, std::string> <a class="el" href="classdmlc_1_1Config.html#afc2e054db64f1ece11f3bac84d775d12">dmlc::Config::ConfigEntry</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>type when extracting from iterator </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="aaf5cc7d0b8147e671693827db4772a3a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaf5cc7d0b8147e671693827db4772a3a">◆ </a></span>Config() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">dmlc::Config::Config </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>multi_value</em> = <code>false</code></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>create empty config </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">multi_value</td><td>whether the config supports multi value </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a4ca685b092b7745eca0b3a5bb4e5102f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4ca685b092b7745eca0b3a5bb4e5102f">◆ </a></span>Config() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">dmlc::Config::Config </td> |
| <td>(</td> |
| <td class="paramtype">std::istream & </td> |
| <td class="paramname"><em>is</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>multi_value</em> = <code>false</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>create config and load content from the given stream </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">is</td><td>input stream </td></tr> |
| <tr><td class="paramname">multi_value</td><td>whether the config supports multi value </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ac2067ad6855bbe6992a5f83d1d3ad2f8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac2067ad6855bbe6992a5f83d1d3ad2f8">◆ </a></span>begin()</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::begin </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>get begin iterator </p> |
| <dl class="section return"><dt>Returns</dt><dd>begin iterator </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a207c8acc2017acc2d3d655863d6edb5f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a207c8acc2017acc2d3d655863d6edb5f">◆ </a></span>Clear()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::Config::Clear </td> |
| <td>(</td> |
| <td class="paramtype">void </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>clear all the values </p> |
| |
| </div> |
| </div> |
| <a id="a3c83ca1539a914e39564c9675b6c9ae8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3c83ca1539a914e39564c9675b6c9ae8">◆ </a></span>end()</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::end </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>get end iterator </p> |
| <dl class="section return"><dt>Returns</dt><dd>end iterator </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a6d02501d01e99cb87b6462041aaa07b7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6d02501d01e99cb87b6462041aaa07b7">◆ </a></span>GetParam()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& dmlc::Config::GetParam </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>key</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>get the config under the key; if multiple values exist for the same key, return the last inserted one. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">key</td><td>key </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>config value </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a220891b3a485a68ad185de569e20a517"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a220891b3a485a68ad185de569e20a517">◆ </a></span>IsGenuineString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool dmlc::Config::IsGenuineString </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>key</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>check whether the configure value given by the key should be wrapped by quotes </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">key</td><td>key </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>whether the configure value is represented by string </dd></dl> |
| |
| </div> |
| </div> |
| <a id="af2b8b9527113ebb371bfc20119d52f98"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af2b8b9527113ebb371bfc20119d52f98">◆ </a></span>LoadFromStream()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::Config::LoadFromStream </td> |
| <td>(</td> |
| <td class="paramtype">std::istream & </td> |
| <td class="paramname"><em>is</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>load the contents from the stream </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">is</td><td>the stream as input </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="aaee438e73aea45b432badb46c328a93a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaee438e73aea45b432badb46c328a93a">◆ </a></span>SetParam()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class T > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::Config::SetParam </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const T & </td> |
| <td class="paramname"><em>value</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>is_string</em> = <code>false</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>set a key-value pair into the config; if the key already exists in the configure file, it will either replace the old value with the given one (in non-multi value mode) or store it directly (in multi-value mode); </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">key</td><td>key </td></tr> |
| <tr><td class="paramname">value</td><td>value </td></tr> |
| <tr><td class="paramname">is_string</td><td>whether the value should be wrapped by quotes in proto string </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="afa8bf1b57515a781eb36106482a8a471"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afa8bf1b57515a781eb36106482a8a471">◆ </a></span>ToProtoString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string dmlc::Config::ToProtoString </td> |
| <td>(</td> |
| <td class="paramtype">void </td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>transform all the configuration into string recognizable to protobuf </p> |
| <dl class="section return"><dt>Returns</dt><dd>string that could be parsed directly by protobuf </dd></dl> |
| |
| </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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |