blob: 87b38fc8f454758f2cd5f0469bc6376027812d0f [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: /work/mxnet/3rdparty/dmlc-core/include/dmlc/json.h File 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="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_82e31a22178767beedddc7597fd1ecb6.html">dmlc-core</a></li><li class="navelem"><a class="el" href="dir_7dd5b88db83ff474628c03c453739a90.html">include</a></li><li class="navelem"><a class="el" href="dir_e30967e3ab51f65ad4b50dd298ccf4e7.html">dmlc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">json.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Lightweight JSON Reader/Writer that read save into C++ data structs. This includes STL composites and structures.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;vector&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;sstream&gt;</code><br />
<code>#include &lt;cctype&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;algorithm&gt;</code><br />
<code>#include &lt;map&gt;</code><br />
<code>#include &lt;list&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &quot;<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h_source.html">./base.h</a>&quot;</code><br />
<code>#include &quot;./logging.h&quot;</code><br />
<code>#include &quot;<a class="el" href="type__traits_8h_source.html">./type_traits.h</a>&quot;</code><br />
<code>#include &lt;typeindex&gt;</code><br />
<code>#include &lt;typeinfo&gt;</code><br />
<code>#include &lt;unordered_map&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for json.h:</div>
<div class="dyncontent">
<div class="center"><img src="json_8h__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2json_8h" alt=""/></div>
<!-- MAP 0 -->
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="json_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2json_8hdep" alt=""/></div>
<!-- MAP 1 -->
</div>
</div>
<p><a href="json_8h_source.html">Go to the source code of this file.</a></p>
<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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1JSONReader.html">dmlc::JSONReader</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lightweight JSON Reader to read any STL compositions and structs. The user need to know the schema of the. <a href="classdmlc_1_1JSONReader.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1JSONWriter.html">dmlc::JSONWriter</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lightweight json to write any STL compositions. <a href="classdmlc_1_1JSONWriter.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1JSONObjectReadHelper.html">dmlc::JSONObjectReadHelper</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper class to read JSON into a class or struct object. <a href="classdmlc_1_1JSONObjectReadHelper.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacedmlc"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html">dmlc</a></td></tr>
<tr class="memdesc:namespacedmlc"><td class="mdescLeft">&#160;</td><td class="mdescRight">namespace for dmlc <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a0b36bb83f1a151a7d76d36fe50ed9391"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json_8h.html#a0b36bb83f1a151a7d76d36fe50ed9391">DMLC_JSON_ENABLE_ANY_VAR_DEF</a>(KeyName)</td></tr>
<tr class="separator:a0b36bb83f1a151a7d76d36fe50ed9391"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31d781e5a925c9f547984887cc0167ef"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="json_8h.html#a31d781e5a925c9f547984887cc0167ef">DMLC_JSON_ENABLE_ANY</a>(Type, KeyName)</td></tr>
<tr class="memdesc:a31d781e5a925c9f547984887cc0167ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macro to enable save/load JSON of dmlc:: whose actual type is Type. Any type will be saved as json array [KeyName, content]. <a href="json_8h.html#a31d781e5a925c9f547984887cc0167ef">More...</a><br /></td></tr>
<tr class="separator:a31d781e5a925c9f547984887cc0167ef"><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>Lightweight JSON Reader/Writer that read save into C++ data structs. This includes STL composites and structures. </p>
<p>Copyright (c) 2015 by Contributors </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a31d781e5a925c9f547984887cc0167ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31d781e5a925c9f547984887cc0167ef">&#9670;&nbsp;</a></span>DMLC_JSON_ENABLE_ANY</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DMLC_JSON_ENABLE_ANY</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">Type, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">KeyName&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <a class="code" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#a4feb28faa4c6af06986ecfc8eec9cd49">DMLC_STR_CONCAT</a>(<a class="code" href="json_8h.html#a0b36bb83f1a151a7d76d36fe50ed9391">DMLC_JSON_ENABLE_ANY_VAR_DEF</a>(KeyName), __COUNTER__) = \</div>
<div class="line"> ::dmlc::json::AnyJSONManager::Global()-&gt;EnableType&lt;Type&gt;(#KeyName) \</div>
</div><!-- fragment -->
<p>Macro to enable save/load JSON of dmlc:: whose actual type is Type. Any type will be saved as json array [KeyName, content]. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Type</td><td>The type to be registered. </td></tr>
<tr><td class="paramname">KeyName</td><td>The Type key assigned to the type, must be same during load. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0b36bb83f1a151a7d76d36fe50ed9391"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b36bb83f1a151a7d76d36fe50ed9391">&#9670;&nbsp;</a></span>DMLC_JSON_ENABLE_ANY_VAR_DEF</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DMLC_JSON_ENABLE_ANY_VAR_DEF</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">KeyName</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">static</span> DMLC_ATTRIBUTE_UNUSED ::dmlc::json::AnyJSONManager&amp; \</div>
<div class="line"> __make_AnyJSONType ## _ ## KeyName ## __</div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
<div class="ttc" id="ajson_8h_html_a0b36bb83f1a151a7d76d36fe50ed9391"><div class="ttname"><a href="json_8h.html#a0b36bb83f1a151a7d76d36fe50ed9391">DMLC_JSON_ENABLE_ANY_VAR_DEF</a></div><div class="ttdeci">#define DMLC_JSON_ENABLE_ANY_VAR_DEF(KeyName)</div><div class="ttdef"><b>Definition:</b> json.h:372</div></div>
<div class="ttc" id="a3rdparty_2dmlc-core_2include_2dmlc_2base_8h_html_a4feb28faa4c6af06986ecfc8eec9cd49"><div class="ttname"><a href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#a4feb28faa4c6af06986ecfc8eec9cd49">DMLC_STR_CONCAT</a></div><div class="ttdeci">#define DMLC_STR_CONCAT(__x, __y)</div><div class="ttdef"><b>Definition:</b> base.h:162</div></div>
<!-- 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>