| <!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/optional.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> | |
| <a href="#namespaces">Namespaces</a> | |
| <a href="#func-members">Functions</a> | |
| <a href="#var-members">Variables</a> </div> |
| <div class="headertitle"> |
| <div class="title">optional.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Container to hold optional data. |
| <a href="#details">More...</a></p> |
| <div class="textblock"><code>#include <iostream></code><br /> |
| <code>#include <string></code><br /> |
| <code>#include <utility></code><br /> |
| <code>#include <algorithm></code><br /> |
| <code>#include "<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h_source.html">./base.h</a>"</code><br /> |
| <code>#include "<a class="el" href="common_8h_source.html">./common.h</a>"</code><br /> |
| <code>#include "./logging.h"</code><br /> |
| <code>#include "<a class="el" href="type__traits_8h_source.html">./type_traits.h</a>"</code><br /> |
| </div><div class="textblock"><div class="dynheader"> |
| Include dependency graph for optional.h:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="optional_8h__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2optional_8h" alt=""/></div> |
| <map name="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2optional_8h" id="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2optional_8h"> |
| <area shape="rect" id="node6" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html" title="./base.h" alt="" coords="815,184,889,211"/> |
| <area shape="rect" id="node11" href="common_8h.html" title="defines some common utility function. " alt="" coords="367,109,465,136"/> |
| <area shape="rect" id="node15" href="type__traits_8h.html" title="type traits information header " alt="" coords="629,109,741,136"/> |
| <area shape="rect" id="node10" href="build__config__default_8h.html" title="Default detection logic for fopen64 and other symbols. May be overriden by CMake. ..." alt="" coords="919,259,1121,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="optional_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2optional_8hdep" alt=""/></div> |
| <map name="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2optional_8hdep" id="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2optional_8hdep"> |
| <area shape="rect" id="node2" href="parameter_8h.html" title="Provide lightweight util to do parameter setup and checking. " alt="" coords="535,109,714,165"/> |
| <area shape="rect" id="node39" href="cuda__utils_8h.html" title="Common CUDA utilities. " alt="" coords="865,221,1053,262"/> |
| <area shape="rect" id="node3" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html" title="/work/mxnet/3rdparty\l/dmlc-core/include/dmlc\l/registry.h" alt="" coords="662,213,841,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="5,1507,172,1548"/> |
| <area shape="rect" id="node23" href="include_2mxnet_2base_8h.html" title="/work/mxnet/include\l/mxnet/base.h" alt="" coords="970,1045,1125,1087"/> |
| <area shape="rect" id="node35" href="op_8h.html" title="Operator information structor. " alt="" coords="995,429,1212,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-)dimension and the corresponding lower case with factor size indicates the split (sub-)dimension. For example, NCHW16c can describe a 5-D tensor of [batch_size, channel, height, width, channel_block]. Here sub-dimension channel_block=16 is the split of super-dimension C (channel). " alt="" coords="713,525,899,581"/> |
| <area shape="rect" id="node4" href="data_8h.html" title="defines common input data structure, and interface for handling the input data " alt="" coords="1922,317,2101,373"/> |
| <area shape="rect" id="node6" href="include_2mxnet_2io_8h.html" title="/work/mxnet/include\l/mxnet/io.h" alt="" coords="1890,1321,2045,1362"/> |
| <area shape="rect" id="node7" href="include_2mxnet_2ndarray_8h.html" title="/work/mxnet/include\l/mxnet/ndarray.h" alt="" coords="1471,1224,1626,1265"/> |
| <area shape="rect" id="node13" href="include_2mxnet_2operator_8h.html" title="/work/mxnet/include\l/mxnet/operator.h" alt="" coords="343,1417,498,1459"/> |
| <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="1248,317,1433,373"/> |
| <area shape="rect" id="node5" href="threadediter_8h.html" title="thread backed iterator that can be used to implement general thread-based pipeline such as prefetch a..." alt="" coords="1973,421,2151,477"/> |
| <area shape="rect" id="node8" href="packed__func_8h.html" title="Type-erased function used across MXNET API. " alt="" coords="768,1313,943,1369"/> |
| <area shape="rect" id="node11" href="include_2mxnet_2executor_8h.html" title="/work/mxnet/include\l/mxnet/executor.h" alt="" coords="1042,1507,1197,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="1157,1321,1330,1362"/> |
| <area shape="rect" id="node16" href="imperative_8h.html" title="/work/mxnet/include\l/mxnet/imperative.h" alt="" coords="1661,1507,1815,1548"/> |
| <area shape="rect" id="node17" href="utils_8h.html" title="Basic utilility functions. " alt="" coords="1424,1596,1612,1637"/> |
| <area shape="rect" id="node19" href="include_2mxnet_2kvstore_8h.html" title="/work/mxnet/include\l/mxnet/kvstore.h" alt="" coords="1455,1321,1610,1362"/> |
| <area shape="rect" id="node9" href="include_2mxnet_2runtime_2registry_8h.html" title="/work/mxnet/include\l/mxnet/runtime/registry.h" alt="" coords="762,1417,949,1459"/> |
| <area shape="rect" id="node10" href="api__registry_8h.html" title="This file contains utilities related to the MXNet's global function registry. " alt="" coords="776,1507,935,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="1286,1417,1481,1459"/> |
| <area shape="rect" id="node18" href="exec__utils_8h.html" title="Common utility functions for executors. " alt="" coords="1759,1685,1947,1727"/> |
| <area shape="rect" id="node21" href="graph_8h.html" title="Configuation of nnvm as well as basic data structure. " alt="" coords="1585,733,1771,789"/> |
| <area shape="rect" id="node30" href="pass_8h.html" title="Pass that can be applied to a graph. " alt="" coords="1507,837,1692,893"/> |
| <area shape="rect" id="node31" href="pass__functions_8h.html" title="Pass functions that simply redirect the calls to ApplyPass. " alt="" coords="1537,941,1723,997"/> |
| <area shape="rect" id="node32" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2node_8h.html" title="Graph node data structure. " alt="" coords="1248,525,1433,581"/> |
| <area shape="rect" id="node33" href="symbolic_8h.html" title="Symbolic graph construction API. " alt="" coords="1560,629,1745,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="895,629,1080,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="923,525,1108,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="970,949,1125,990"/> |
| <area shape="rect" id="node24" href="engine_8h.html" title="Engine that schedules all the operations according to dependency. " alt="" coords="1258,1135,1413,1176"/> |
| <area shape="rect" id="node25" href="resource_8h.html" title="Global resource allocation handling. " alt="" coords="927,1224,1082,1265"/> |
| <area shape="rect" id="node26" href="storage_8h.html" title="Storage manager across multiple devices. " alt="" coords="1487,1135,1642,1176"/> |
| <area shape="rect" id="node27" href="random__generator_8h.html" title="Parallel random number generator. " alt="" coords="466,1135,669,1176"/> |
| <area shape="rect" id="node28" href="rtc_8h.html" title="/work/mxnet/include\l/mxnet/rtc.h" alt="" coords="693,1135,847,1176"/> |
| <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="871,1135,1031,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="764,837,949,893"/> |
| </map> |
| </div> |
| </div> |
| <p><a href="optional_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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1nullopt__t.html">dmlc::nullopt_t</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">dummy type for assign null to optional <a href="structdmlc_1_1nullopt__t.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </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_1optional.html">dmlc::optional< T ></a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">c++17 compatible optional class. <a href="classdmlc_1_1optional.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structstd_1_1hash_3_01dmlc_1_1optional_3_01T_01_4_01_4.html">std::hash< dmlc::optional< T > ></a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">std hash function for optional <a href="structstd_1_1hash_3_01dmlc_1_1optional_3_01T_01_4_01_4.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="namespaces"></a> |
| Namespaces</h2></td></tr> |
| <tr class="memitem:namespacedmlc"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html">dmlc</a></td></tr> |
| <tr class="memdesc:namespacedmlc"><td class="mdescLeft"> </td><td class="mdescRight">namespace for dmlc <br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:namespacestd"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacestd.html">std</a></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="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:acf31f99192b5ed0d5d77398d58023912"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> |
| <tr class="memitem:acf31f99192b5ed0d5d77398d58023912"><td class="memTemplItemLeft" align="right" valign="top">std::ostream & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#acf31f99192b5ed0d5d77398d58023912">dmlc::operator<<</a> (std::ostream &os, const optional< T > &t)</td></tr> |
| <tr class="memdesc:acf31f99192b5ed0d5d77398d58023912"><td class="mdescLeft"> </td><td class="mdescRight">serialize an optional object to string. <a href="namespacedmlc.html#acf31f99192b5ed0d5d77398d58023912">More...</a><br /></td></tr> |
| <tr class="separator:acf31f99192b5ed0d5d77398d58023912"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acc4b71c13985425358cb63cc45d49512"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> |
| <tr class="memitem:acc4b71c13985425358cb63cc45d49512"><td class="memTemplItemLeft" align="right" valign="top">std::istream & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#acc4b71c13985425358cb63cc45d49512">dmlc::operator>></a> (std::istream &is, optional< T > &t)</td></tr> |
| <tr class="memdesc:acc4b71c13985425358cb63cc45d49512"><td class="mdescLeft"> </td><td class="mdescRight">parse a string object into optional<T> <a href="namespacedmlc.html#acc4b71c13985425358cb63cc45d49512">More...</a><br /></td></tr> |
| <tr class="separator:acc4b71c13985425358cb63cc45d49512"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5018d09b0f92f75d2c3ee572f62c0346"><td class="memItemLeft" align="right" valign="top">std::istream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a5018d09b0f92f75d2c3ee572f62c0346">dmlc::operator>></a> (std::istream &is, optional< bool > &t)</td></tr> |
| <tr class="memdesc:a5018d09b0f92f75d2c3ee572f62c0346"><td class="mdescLeft"> </td><td class="mdescRight">specialization of '>>' istream parsing for optional<bool> <a href="namespacedmlc.html#a5018d09b0f92f75d2c3ee572f62c0346">More...</a><br /></td></tr> |
| <tr class="separator:a5018d09b0f92f75d2c3ee572f62c0346"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae0e0e4f86115e4c4e7f761de5c8a6797"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#ae0e0e4f86115e4c4e7f761de5c8a6797">dmlc::DMLC_DECLARE_TYPE_NAME</a> (optional< int >, "int or None")</td></tr> |
| <tr class="memdesc:ae0e0e4f86115e4c4e7f761de5c8a6797"><td class="mdescLeft"> </td><td class="mdescRight">description for optional int <a href="namespacedmlc.html#ae0e0e4f86115e4c4e7f761de5c8a6797">More...</a><br /></td></tr> |
| <tr class="separator:ae0e0e4f86115e4c4e7f761de5c8a6797"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a45790e76c170593a12e9a31c2ca547a8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a45790e76c170593a12e9a31c2ca547a8">dmlc::DMLC_DECLARE_TYPE_NAME</a> (optional< bool >, "boolean or None")</td></tr> |
| <tr class="memdesc:a45790e76c170593a12e9a31c2ca547a8"><td class="mdescLeft"> </td><td class="mdescRight">description for optional bool <a href="namespacedmlc.html#a45790e76c170593a12e9a31c2ca547a8">More...</a><br /></td></tr> |
| <tr class="separator:a45790e76c170593a12e9a31c2ca547a8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa8d7950ad6b6392afa1ec41fa42bfbf6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#aa8d7950ad6b6392afa1ec41fa42bfbf6">dmlc::DMLC_DECLARE_TYPE_NAME</a> (optional< float >, "float or None")</td></tr> |
| <tr class="memdesc:aa8d7950ad6b6392afa1ec41fa42bfbf6"><td class="mdescLeft"> </td><td class="mdescRight">description for optional float <a href="namespacedmlc.html#aa8d7950ad6b6392afa1ec41fa42bfbf6">More...</a><br /></td></tr> |
| <tr class="separator:aa8d7950ad6b6392afa1ec41fa42bfbf6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a24514e2baa4d33161ba4cde558e6245e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a24514e2baa4d33161ba4cde558e6245e">dmlc::DMLC_DECLARE_TYPE_NAME</a> (optional< double >, "double or None")</td></tr> |
| <tr class="memdesc:a24514e2baa4d33161ba4cde558e6245e"><td class="mdescLeft"> </td><td class="mdescRight">description for optional double <a href="namespacedmlc.html#a24514e2baa4d33161ba4cde558e6245e">More...</a><br /></td></tr> |
| <tr class="separator:a24514e2baa4d33161ba4cde558e6245e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> |
| Variables</h2></td></tr> |
| <tr class="memitem:a7e0f62af45e67c3b6fa22080e756b379"><td class="memItemLeft" align="right" valign="top">constexpr const nullopt_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a7e0f62af45e67c3b6fa22080e756b379">dmlc::nullopt</a> = nullopt_t(0)</td></tr> |
| <tr class="separator:a7e0f62af45e67c3b6fa22080e756b379"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Container to hold optional data. </p> |
| <p>Copyright (c) 2016 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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
