blob: 1dd7c1f0bc18fd8d4d5a9a5c1c30e9794d003a2e [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/common.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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">common.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>defines some common utility function.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;vector&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;sstream&gt;</code><br />
<code>#include &lt;mutex&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &quot;./logging.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for common.h:</div>
<div class="dyncontent">
<div class="center"><img src="common_8h__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2common_8h" alt=""/></div>
<map name="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2common_8h" id="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2common_8h">
</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="common_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2common_8hdep" alt=""/></div>
<map name="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2common_8hdep" id="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2common_8hdep">
<area shape="rect" id="node2" href="optional_8h.html" title="Container to hold optional data. " alt="" coords="1432,109,1611,165"/>
<area shape="rect" id="node21" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2base_8h.html" title="Configuration of nnvm as well as basic data structure. " alt="" coords="674,421,860,477"/>
<area shape="rect" id="node3" href="parameter_8h.html" title="Provide lightweight util to do parameter setup and checking. " alt="" coords="1432,213,1611,269"/>
<area shape="rect" id="node40" href="cuda__utils_8h.html" title="Common CUDA utilities. " alt="" coords="2530,325,2718,366"/>
<area shape="rect" id="node4" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html" title="/work/mxnet/3rdparty\l/dmlc&#45;core/include/dmlc\l/registry.h" alt="" coords="1820,317,1999,373"/>
<area shape="rect" id="node15" href="operator__util_8h.html" title="Utility functions and registries to help quickly build new operators. [Deprecated] Use the register f..." alt="" coords="2333,1611,2500,1652"/>
<area shape="rect" id="node24" href="include_2mxnet_2base_8h.html" title="/work/mxnet/include\l/mxnet/base.h" alt="" coords="1303,1149,1458,1191"/>
<area shape="rect" id="node36" href="op_8h.html" title="Operator information structor. " alt="" coords="1069,533,1286,574"/>
<area shape="rect" id="node39" 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="104,629,289,685"/>
<area shape="rect" id="node5" href="data_8h.html" title="defines common input data structure, and interface for handling the input data " alt="" coords="1947,421,2126,477"/>
<area shape="rect" id="node7" href="include_2mxnet_2io_8h.html" title="/work/mxnet/include\l/mxnet/io.h" alt="" coords="2067,1425,2222,1466"/>
<area shape="rect" id="node8" href="include_2mxnet_2ndarray_8h.html" title="/work/mxnet/include\l/mxnet/ndarray.h" alt="" coords="992,1328,1147,1369"/>
<area shape="rect" id="node14" href="include_2mxnet_2operator_8h.html" title="/work/mxnet/include\l/mxnet/operator.h" alt="" coords="1934,1521,2088,1563"/>
<area shape="rect" id="node6" 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="1947,525,2126,581"/>
<area shape="rect" id="node9" href="packed__func_8h.html" title="Type&#45;erased function used across MXNET API. " alt="" coords="736,1417,910,1473"/>
<area shape="rect" id="node12" href="include_2mxnet_2executor_8h.html" title="/work/mxnet/include\l/mxnet/executor.h" alt="" coords="1087,1611,1242,1652"/>
<area shape="rect" id="node13" href="include_2mxnet_2op__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/op_attr_types.h" alt="" coords="1512,1425,1686,1466"/>
<area shape="rect" id="node17" href="imperative_8h.html" title="/work/mxnet/include\l/mxnet/imperative.h" alt="" coords="762,1611,916,1652"/>
<area shape="rect" id="node18" href="utils_8h.html" title="Basic utilility functions. " alt="" coords="745,1700,933,1741"/>
<area shape="rect" id="node20" href="include_2mxnet_2kvstore_8h.html" title="/work/mxnet/include\l/mxnet/kvstore.h" alt="" coords="1138,1425,1292,1466"/>
<area shape="rect" id="node10" href="include_2mxnet_2runtime_2registry_8h.html" title="/work/mxnet/include\l/mxnet/runtime/registry.h" alt="" coords="419,1521,606,1563"/>
<area shape="rect" id="node11" href="api__registry_8h.html" title="This file contains utilities related to the MXNet&#39;s global function registry. " alt="" coords="433,1611,592,1652"/>
<area shape="rect" id="node16" href="include_2mxnet_2graph__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/graph_attr_types.h" alt="" coords="1367,1521,1562,1563"/>
<area shape="rect" id="node19" href="exec__utils_8h.html" title="Common utility functions for executors. " alt="" coords="136,1789,324,1831"/>
<area shape="rect" id="node22" href="graph_8h.html" title="Configuation of nnvm as well as basic data structure. " alt="" coords="517,837,702,893"/>
<area shape="rect" id="node31" href="pass_8h.html" title="Pass that can be applied to a graph. " alt="" coords="305,941,490,997"/>
<area shape="rect" id="node32" href="pass__functions_8h.html" title="Pass functions that simply redirect the calls to ApplyPass. " alt="" coords="6,1045,192,1101"/>
<area shape="rect" id="node33" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2node_8h.html" title="Graph node data structure. " alt="" coords="760,629,945,685"/>
<area shape="rect" id="node34" href="symbolic_8h.html" title="Symbolic graph construction API. " alt="" coords="629,733,814,789"/>
<area shape="rect" id="node35" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2op__attr__types_8h.html" title="Data structures that can appear in operator attributes. " alt="" coords="890,733,1076,789"/>
<area shape="rect" id="node37" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2tuple_8h.html" title="Data structure Tuple and TShape to store dynamic sized shapes. " alt="" coords="498,629,684,685"/>
<area shape="rect" id="node23" href="include_2mxnet_2tuple_8h.html" title="Data structure Tuple and TShape to store dynamic sized shapes. " alt="" coords="595,1053,750,1094"/>
<area shape="rect" id="node25" href="engine_8h.html" title="Engine that schedules all the operations according to dependency. " alt="" coords="1491,1239,1646,1280"/>
<area shape="rect" id="node26" href="resource_8h.html" title="Global resource allocation handling. " alt="" coords="1744,1328,1899,1369"/>
<area shape="rect" id="node27" href="storage_8h.html" title="Storage manager across multiple devices. " alt="" coords="899,1239,1054,1280"/>
<area shape="rect" id="node28" href="random__generator_8h.html" title="Parallel random number generator. " alt="" coords="1720,1239,1923,1280"/>
<area shape="rect" id="node29" href="rtc_8h.html" title="/work/mxnet/include\l/mxnet/rtc.h" alt="" coords="1128,1239,1283,1280"/>
<area shape="rect" id="node30" href="tensor__blob_8h.html" title="TBlob class that holds common representation of arbirary dimension tensor, can be used to transformed..." alt="" coords="1307,1239,1467,1280"/>
<area shape="rect" id="node38" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2graph__attr__types_8h.html" title="Data structures that can appear in graph attributes. " alt="" coords="44,941,229,997"/>
</map>
</div>
</div>
<p><a href="common_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_1OMPException.html">dmlc::OMPException</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">OMP Exception class catches, saves and rethrows exception from OMP blocks. <a href="classdmlc_1_1OMPException.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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a3a28a7405b2f734090912c073434091c"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a3a28a7405b2f734090912c073434091c">dmlc::Split</a> (const std::string &amp;s, char delim)</td></tr>
<tr class="memdesc:a3a28a7405b2f734090912c073434091c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Split a string by delimiter. <a href="namespacedmlc.html#a3a28a7405b2f734090912c073434091c">More...</a><br /></td></tr>
<tr class="separator:a3a28a7405b2f734090912c073434091c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8620a9c7572cd3aab1ed3135b7a8e137"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a8620a9c7572cd3aab1ed3135b7a8e137"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a8620a9c7572cd3aab1ed3135b7a8e137">dmlc::HashCombine</a> (size_t key, const T &amp;value)</td></tr>
<tr class="memdesc:a8620a9c7572cd3aab1ed3135b7a8e137"><td class="mdescLeft">&#160;</td><td class="mdescRight">hash an object and combines the key with previous keys <a href="namespacedmlc.html#a8620a9c7572cd3aab1ed3135b7a8e137">More...</a><br /></td></tr>
<tr class="separator:a8620a9c7572cd3aab1ed3135b7a8e137"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0be2b34771107606d968712e54b25ce6"><td class="memTemplParams" colspan="2">template&lt;&gt; </td></tr>
<tr class="memitem:a0be2b34771107606d968712e54b25ce6"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a0be2b34771107606d968712e54b25ce6">dmlc::HashCombine&lt; size_t &gt;</a> (size_t key, const size_t &amp;value)</td></tr>
<tr class="memdesc:a0be2b34771107606d968712e54b25ce6"><td class="mdescLeft">&#160;</td><td class="mdescRight">specialize for size_t <a href="namespacedmlc.html#a0be2b34771107606d968712e54b25ce6">More...</a><br /></td></tr>
<tr class="separator:a0be2b34771107606d968712e54b25ce6"><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>defines some common utility function. </p>
<p>Copyright (c) 2015 by Contributors </p>
</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>