blob: 0759ba0d8902d2e1a75979acf291ee407f0014de [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/type_traits.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> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">type_traits.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>type traits information header
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h_source.html">./base.h</a>&quot;</code><br />
<code>#include &lt;type_traits&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for type_traits.h:</div>
<div class="dyncontent">
<div class="center"><img src="type__traits_8h__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2type__traits_8h" alt=""/></div>
<map name="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2type__traits_8h" id="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2type__traits_8h">
<area shape="rect" id="node2" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html" title="./base.h" alt="" coords="309,109,382,136"/>
<area shape="rect" id="node7" href="build__config__default_8h.html" title="Default detection logic for fopen64 and other symbols. May be overriden by CMake. ..." alt="" coords="323,184,525,211"/>
</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="type__traits_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2type__traits_8hdep" alt=""/></div>
<map name="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2type__traits_8hdep" id="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2type__traits_8hdep">
<area shape="rect" id="node2" href="serializer_8h.html" title="serializer template class that helps serialization. This file do not need to be directly used by most..." alt="" coords="663,927,841,983"/>
<area shape="rect" id="node10" href="include_2mxnet_2base_8h.html" title="/work/mxnet/include\l/mxnet/base.h" alt="" coords="1669,1142,1824,1183"/>
<area shape="rect" id="node15" href="include_2mxnet_2ndarray_8h.html" title="/work/mxnet/include\l/mxnet/ndarray.h" alt="" coords="2121,1343,2276,1384"/>
<area shape="rect" id="node30" href="json_8h.html" title="Lightweight JSON Reader/Writer that read save into C++ data structs. This includes STL composites and..." alt="" coords="1492,109,1671,165"/>
<area shape="rect" id="node31" href="parameter_8h.html" title="Provide lightweight util to do parameter setup and checking. " alt="" coords="1844,213,2023,269"/>
<area shape="rect" id="node32" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html" title="/work/mxnet/3rdparty\l/dmlc&#45;core/include/dmlc\l/registry.h" alt="" coords="1193,317,1372,373"/>
<area shape="rect" id="node46" href="optional_8h.html" title="Container to hold optional data. " alt="" coords="1895,109,2073,165"/>
<area shape="rect" id="node3" href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h.html" title="/work/mxnet/3rdparty\l/dmlc&#45;core/include/dmlc/io.h" alt="" coords="649,1038,855,1079"/>
<area shape="rect" id="node4" href="data_8h.html" title="defines common input data structure, and interface for handling the input data " alt="" coords="803,1135,981,1191"/>
<area shape="rect" id="node7" href="filesystem_8h.html" title="Utilities to manipulate files. " alt="" coords="397,1135,576,1191"/>
<area shape="rect" id="node8" href="memory__io_8h.html" title="defines binary serialization class to serialize things into/from memory region. " alt="" coords="600,1135,779,1191"/>
<area shape="rect" id="node9" href="recordio_8h.html" title="recordio that is able to pack binary data into a splittable format, useful to exchange data in binary..." alt="" coords="195,1135,373,1191"/>
<area shape="rect" id="node24" href="include_2mxnet_2kvstore_8h.html" title="/work/mxnet/include\l/mxnet/kvstore.h" alt="" coords="1112,1439,1267,1481"/>
<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="600,1239,779,1295"/>
<area shape="rect" id="node6" href="include_2mxnet_2io_8h.html" title="/work/mxnet/include\l/mxnet/io.h" alt="" coords="933,1439,1088,1481"/>
<area shape="rect" id="node11" href="packed__func_8h.html" title="Type&#45;erased function used across MXNET API. " alt="" coords="1518,1432,1693,1488"/>
<area shape="rect" id="node14" href="engine_8h.html" title="Engine that schedules all the operations according to dependency. " alt="" coords="2331,1246,2485,1287"/>
<area shape="rect" id="node16" href="include_2mxnet_2executor_8h.html" title="/work/mxnet/include\l/mxnet/executor.h" alt="" coords="1679,1625,1833,1667"/>
<area shape="rect" id="node17" href="include_2mxnet_2op__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/op_attr_types.h" alt="" coords="2316,1439,2489,1481"/>
<area shape="rect" id="node18" href="include_2mxnet_2operator_8h.html" title="/work/mxnet/include\l/mxnet/operator.h" alt="" coords="1328,1536,1483,1577"/>
<area shape="rect" id="node19" href="operator__util_8h.html" title="Utility functions and registries to help quickly build new operators. [Deprecated] Use the register f..." alt="" coords="641,1625,807,1667"/>
<area shape="rect" id="node25" href="resource_8h.html" title="Global resource allocation handling. " alt="" coords="1797,1343,1952,1384"/>
<area shape="rect" id="node26" href="storage_8h.html" title="Storage manager across multiple devices. " alt="" coords="2000,1246,2155,1287"/>
<area shape="rect" id="node27" href="random__generator_8h.html" title="Parallel random number generator. " alt="" coords="1773,1246,1976,1287"/>
<area shape="rect" id="node28" href="rtc_8h.html" title="/work/mxnet/include\l/mxnet/rtc.h" alt="" coords="1443,1246,1597,1287"/>
<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="1056,1246,1216,1287"/>
<area shape="rect" id="node12" href="include_2mxnet_2runtime_2registry_8h.html" title="/work/mxnet/include\l/mxnet/runtime/registry.h" alt="" coords="1507,1536,1693,1577"/>
<area shape="rect" id="node13" href="api__registry_8h.html" title="This file contains utilities related to the MXNet&#39;s global function registry. " alt="" coords="1495,1625,1654,1667"/>
<area shape="rect" id="node22" href="utils_8h.html" title="Basic utilility functions. " alt="" coords="2609,1715,2797,1756"/>
<area shape="rect" id="node21" href="imperative_8h.html" title="/work/mxnet/include\l/mxnet/imperative.h" alt="" coords="2625,1625,2780,1667"/>
<area shape="rect" id="node20" href="include_2mxnet_2graph__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/graph_attr_types.h" alt="" coords="2305,1536,2500,1577"/>
<area shape="rect" id="node23" href="exec__utils_8h.html" title="Common utility functions for executors. " alt="" coords="2958,1804,3146,1845"/>
<area shape="rect" id="node41" href="op_8h.html" title="Operator information structor. " alt="" coords="2191,525,2409,567"/>
<area shape="rect" id="node44" 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="2898,615,3083,671"/>
<area shape="rect" id="node45" href="cuda__utils_8h.html" title="Common CUDA utilities. " alt="" coords="2949,325,3137,366"/>
<area shape="rect" id="node33" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2base_8h.html" title="Configuration of nnvm as well as basic data structure. " alt="" coords="2405,421,2590,477"/>
<area shape="rect" id="node34" href="graph_8h.html" title="Configuation of nnvm as well as basic data structure. " alt="" coords="2618,823,2803,879"/>
<area shape="rect" id="node36" href="pass_8h.html" title="Pass that can be applied to a graph. " alt="" coords="2517,927,2702,983"/>
<area shape="rect" id="node37" href="pass__functions_8h.html" title="Pass functions that simply redirect the calls to ApplyPass. " alt="" coords="2930,1031,3115,1087"/>
<area shape="rect" id="node38" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2node_8h.html" title="Graph node data structure. " alt="" coords="2241,615,2426,671"/>
<area shape="rect" id="node39" href="symbolic_8h.html" title="Symbolic graph construction API. " alt="" coords="2309,719,2494,775"/>
<area shape="rect" id="node40" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2op__attr__types_8h.html" title="Data structures that can appear in operator attributes. " alt="" coords="2099,719,2285,775"/>
<area shape="rect" id="node42" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2tuple_8h.html" title="Data structure Tuple and TShape to store dynamic sized shapes. " alt="" coords="2586,615,2771,671"/>
<area shape="rect" id="node35" href="include_2mxnet_2tuple_8h.html" title="Data structure Tuple and TShape to store dynamic sized shapes. " alt="" coords="2415,1038,2569,1079"/>
<area shape="rect" id="node43" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2graph__attr__types_8h.html" title="Data structures that can appear in graph attributes. " alt="" coords="2879,927,3065,983"/>
</map>
</div>
</div>
<p><a href="type__traits_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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1is__pod.html">dmlc::is_pod&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">whether a type is pod type <a href="structdmlc_1_1is__pod.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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1is__integral.html">dmlc::is_integral&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">whether a type is integer type <a href="structdmlc_1_1is__integral.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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1is__floating__point.html">dmlc::is_floating_point&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">whether a type is floating point type <a href="structdmlc_1_1is__floating__point.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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1is__arithmetic.html">dmlc::is_arithmetic&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">whether a type is arithemetic type <a href="structdmlc_1_1is__arithmetic.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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1type__name__helper.html">dmlc::type_name_helper&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">helper class to construct a string that represents type name <a href="structdmlc_1_1type__name__helper.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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1has__saveload.html">dmlc::has_saveload&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">whether a type have save/load function <a href="structdmlc_1_1has__saveload.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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1IfThenElseType.html">dmlc::IfThenElseType&lt; cond, Then, Else &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">template to select type based on condition For example, IfThenElseType&lt;true, int, float&gt;::Type will give int <a href="structdmlc_1_1IfThenElseType.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:ad29838fb4e93a8dd3efbdcd292c98bd5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="type__traits_8h.html#ad29838fb4e93a8dd3efbdcd292c98bd5">DMLC_DECLARE_TRAITS</a>(Trait, Type, Value)</td></tr>
<tr class="memdesc:ad29838fb4e93a8dd3efbdcd292c98bd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">macro to quickly declare traits information <a href="#ad29838fb4e93a8dd3efbdcd292c98bd5">More...</a><br /></td></tr>
<tr class="separator:ad29838fb4e93a8dd3efbdcd292c98bd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada1b1bad88ec717de715829068ff0d3e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="type__traits_8h.html#ada1b1bad88ec717de715829068ff0d3e">DMLC_DECLARE_TYPE_NAME</a>(Type, Name)</td></tr>
<tr class="memdesc:ada1b1bad88ec717de715829068ff0d3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">macro to quickly declare traits information <a href="#ada1b1bad88ec717de715829068ff0d3e">More...</a><br /></td></tr>
<tr class="separator:ada1b1bad88ec717de715829068ff0d3e"><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:a1e731f276d3a3efa8e17f46ccf35f828"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a1e731f276d3a3efa8e17f46ccf35f828"><td class="memTemplItemLeft" align="right" valign="top">std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a1e731f276d3a3efa8e17f46ccf35f828">dmlc::type_name</a> ()</td></tr>
<tr class="memdesc:a1e731f276d3a3efa8e17f46ccf35f828"><td class="mdescLeft">&#160;</td><td class="mdescRight">the string representation of type name <a href="namespacedmlc.html#a1e731f276d3a3efa8e17f46ccf35f828">More...</a><br /></td></tr>
<tr class="separator:a1e731f276d3a3efa8e17f46ccf35f828"><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>type traits information header </p>
<p>Copyright (c) 2015 by Contributors </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ad29838fb4e93a8dd3efbdcd292c98bd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad29838fb4e93a8dd3efbdcd292c98bd5">&#9670;&nbsp;</a></span>DMLC_DECLARE_TRAITS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DMLC_DECLARE_TRAITS</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">Trait, </td>
</tr>
<tr>
<td class="paramkey"></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">Value&#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"><span class="keyword">template</span>&lt;&gt; \</div><div class="line"> struct Trait&lt;Type&gt; { \</div><div class="line"> static <span class="keyword">const</span> <span class="keywordtype">bool</span> value = Value; \</div><div class="line"> }</div></div><!-- fragment -->
<p>macro to quickly declare traits information </p>
</div>
</div>
<a id="ada1b1bad88ec717de715829068ff0d3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada1b1bad88ec717de715829068ff0d3e">&#9670;&nbsp;</a></span>DMLC_DECLARE_TYPE_NAME</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DMLC_DECLARE_TYPE_NAME</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">Name&#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"><span class="keyword">template</span>&lt;&gt; \</div><div class="line"> struct type_name_helper&lt;Type&gt; { \</div><div class="line"> static <span class="keyword">inline</span> std::string value() { \</div><div class="line"> return Name; \</div><div class="line"> } \</div><div class="line"> }</div></div><!-- fragment -->
<p>macro to quickly declare traits information </p>
</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>