blob: 3c644a37d596759eb17502739577b4b377a94759 [file] [log] [blame]
<!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.13"/>
<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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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 name="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2json_8h" id="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2json_8h">
<area shape="rect" id="node11" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html" title="./base.h" alt="" coords="312,184,386,211"/>
<area shape="rect" id="node16" href="type__traits_8h.html" title="type traits information header " alt="" coords="712,109,824,136"/>
<area shape="rect" id="node14" href="build__config__default_8h.html" title="Default detection logic for fopen64 and other symbols. May be overriden by CMake. ..." alt="" coords="416,259,618,285"/>
</map>
</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 name="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2json_8hdep" id="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2json_8hdep">
<area shape="rect" id="node2" href="parameter_8h.html" title="Provide lightweight util to do parameter setup and checking. " alt="" coords="2259,109,2437,165"/>
<area shape="rect" id="node13" href="include_2mxnet_2operator_8h.html" title="/work/mxnet/include\l/mxnet/operator.h" alt="" coords="2124,1417,2279,1459"/>
<area shape="rect" id="node29" href="tensor__blob_8h.html" title="TBlob class that holds common representation of arbirary dimension tensor, can be used to transformed..." alt="" coords="2353,1135,2513,1176"/>
<area shape="rect" id="node3" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html" title="/work/mxnet/3rdparty\l/dmlc&#45;core/include/dmlc\l/registry.h" alt="" coords="1688,213,1867,269"/>
<area shape="rect" id="node14" href="operator__util_8h.html" title="Utility functions and registries to help quickly build new operators. [Deprecated] Use the register f..." alt="" coords="2426,1507,2593,1548"/>
<area shape="rect" id="node23" href="include_2mxnet_2base_8h.html" title="/work/mxnet/include\l/mxnet/base.h" alt="" coords="1631,1045,1785,1087"/>
<area shape="rect" id="node35" href="op_8h.html" title="Operator information structor. " alt="" coords="1371,429,1589,470"/>
<area shape="rect" id="node38" href="layout_8h.html" title="Layout expression. The layout is composed of upper cases, lower cases and numbers, where upper case indicates a (super&#45;)dimension and the corresponding lower case with factor size indicates the split (sub&#45;)dimension. For example, NCHW16c can describe a 5&#45;D tensor of [batch_size, channel, height, width, channel_block]. Here sub&#45;dimension channel_block=16 is the split of super&#45;dimension C (channel). " alt="" coords="435,525,621,581"/>
<area shape="rect" id="node39" href="cuda__utils_8h.html" title="Common CUDA utilities. " alt="" coords="1475,221,1663,262"/>
<area shape="rect" id="node4" href="data_8h.html" title="defines common input data structure, and interface for handling the input data " alt="" coords="107,317,285,373"/>
<area shape="rect" id="node6" href="include_2mxnet_2io_8h.html" title="/work/mxnet/include\l/mxnet/io.h" alt="" coords="925,1321,1080,1362"/>
<area shape="rect" id="node7" href="include_2mxnet_2ndarray_8h.html" title="/work/mxnet/include\l/mxnet/ndarray.h" alt="" coords="1288,1224,1443,1265"/>
<area shape="rect" id="node20" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2base_8h.html" title="Configuration of nnvm as well as basic data structure. " alt="" coords="878,317,1063,373"/>
<area shape="rect" id="node5" href="threadediter_8h.html" title="thread backed iterator that can be used to implement general thread&#45;based pipeline such as prefetch a..." alt="" coords="5,421,184,477"/>
<area shape="rect" id="node8" href="packed__func_8h.html" title="Type&#45;erased function used across MXNET API. " alt="" coords="1105,1313,1279,1369"/>
<area shape="rect" id="node11" href="include_2mxnet_2executor_8h.html" title="/work/mxnet/include\l/mxnet/executor.h" alt="" coords="1609,1507,1764,1548"/>
<area shape="rect" id="node12" href="include_2mxnet_2op__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/op_attr_types.h" alt="" coords="1849,1321,2023,1362"/>
<area shape="rect" id="node16" href="imperative_8h.html" title="/work/mxnet/include\l/mxnet/imperative.h" alt="" coords="1291,1507,1445,1548"/>
<area shape="rect" id="node17" href="utils_8h.html" title="Basic utilility functions. " alt="" coords="934,1596,1122,1637"/>
<area shape="rect" id="node19" href="include_2mxnet_2kvstore_8h.html" title="/work/mxnet/include\l/mxnet/kvstore.h" alt="" coords="1405,1321,1560,1362"/>
<area shape="rect" id="node9" href="include_2mxnet_2runtime_2registry_8h.html" title="/work/mxnet/include\l/mxnet/runtime/registry.h" alt="" coords="804,1417,991,1459"/>
<area shape="rect" id="node10" href="api__registry_8h.html" title="This file contains utilities related to the MXNet&#39;s global function registry. " alt="" coords="818,1507,977,1548"/>
<area shape="rect" id="node15" href="include_2mxnet_2graph__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/graph_attr_types.h" alt="" coords="1839,1417,2033,1459"/>
<area shape="rect" id="node18" href="exec__utils_8h.html" title="Common utility functions for executors. " alt="" coords="439,1685,627,1727"/>
<area shape="rect" id="node21" href="graph_8h.html" title="Configuation of nnvm as well as basic data structure. " alt="" coords="813,733,998,789"/>
<area shape="rect" id="node30" href="pass_8h.html" title="Pass that can be applied to a graph. " alt="" coords="671,837,857,893"/>
<area shape="rect" id="node31" href="pass__functions_8h.html" title="Pass functions that simply redirect the calls to ApplyPass. " alt="" coords="447,941,633,997"/>
<area shape="rect" id="node32" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2node_8h.html" title="Graph node data structure. " alt="" coords="1059,525,1245,581"/>
<area shape="rect" id="node33" href="symbolic_8h.html" title="Symbolic graph construction API. " alt="" coords="1059,629,1245,685"/>
<area shape="rect" id="node34" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2op__attr__types_8h.html" title="Data structures that can appear in operator attributes. " alt="" coords="798,629,983,685"/>
<area shape="rect" id="node36" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2tuple_8h.html" title="Data structure Tuple and TShape to store dynamic sized shapes. " alt="" coords="747,525,933,581"/>
<area shape="rect" id="node22" href="include_2mxnet_2tuple_8h.html" title="Data structure Tuple and TShape to store dynamic sized shapes. " alt="" coords="905,949,1060,990"/>
<area shape="rect" id="node24" href="engine_8h.html" title="Engine that schedules all the operations according to dependency. " alt="" coords="1745,1135,1900,1176"/>
<area shape="rect" id="node25" href="resource_8h.html" title="Global resource allocation handling. " alt="" coords="1975,1224,2129,1265"/>
<area shape="rect" id="node26" href="storage_8h.html" title="Storage manager across multiple devices. " alt="" coords="1287,1135,1441,1176"/>
<area shape="rect" id="node27" href="random__generator_8h.html" title="Parallel random number generator. " alt="" coords="2025,1135,2228,1176"/>
<area shape="rect" id="node28" href="rtc_8h.html" title="/work/mxnet/include\l/mxnet/rtc.h" alt="" coords="1516,1135,1671,1176"/>
<area shape="rect" id="node37" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2graph__attr__types_8h.html" title="Data structures that can appear in graph attributes. " alt="" coords="462,837,647,893"/>
</map>
</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="#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 class="ttc" id="3rdparty_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>
<div class="ttc" id="json_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><!-- 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 -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:42 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>