Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / master / api / cpp / docs / api / optional_8h.html
blob: 3f0c6cffb1f243937372395f7cc8f610dc53f23c [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/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.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="#func-members">Functions</a> &#124;
<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 &lt;iostream&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &lt;algorithm&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;<a class="el" href="common_8h_source.html">./common.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 />
</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 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="optional_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2optional_8hdep" alt=""/></div>
<!-- MAP 1 -->
</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 &#160;</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">&#160;</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">&#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_1optional.html">dmlc::optional&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</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">&#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="structstd_1_1hash_3_01dmlc_1_1optional_3_01T_01_4_01_4.html">std::hash&lt; dmlc::optional&lt; T &gt; &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</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">&#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>
<tr class="memitem:namespacestd"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacestd.html">std</a></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:acf31f99192b5ed0d5d77398d58023912"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:acf31f99192b5ed0d5d77398d58023912"><td class="memTemplItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#acf31f99192b5ed0d5d77398d58023912">dmlc::operator&lt;&lt;</a> (std::ostream &amp;os, const optional&lt; T &gt; &amp;t)</td></tr>
<tr class="memdesc:acf31f99192b5ed0d5d77398d58023912"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:acc4b71c13985425358cb63cc45d49512"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:acc4b71c13985425358cb63cc45d49512"><td class="memTemplItemLeft" align="right" valign="top">std::istream &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#acc4b71c13985425358cb63cc45d49512">dmlc::operator&gt;&gt;</a> (std::istream &amp;is, optional&lt; T &gt; &amp;t)</td></tr>
<tr class="memdesc:acc4b71c13985425358cb63cc45d49512"><td class="mdescLeft">&#160;</td><td class="mdescRight">parse a string object into optional&lt;T&gt; <a href="namespacedmlc.html#acc4b71c13985425358cb63cc45d49512">More...</a><br /></td></tr>
<tr class="separator:acc4b71c13985425358cb63cc45d49512"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5018d09b0f92f75d2c3ee572f62c0346"><td class="memItemLeft" align="right" valign="top">std::istream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a5018d09b0f92f75d2c3ee572f62c0346">dmlc::operator&gt;&gt;</a> (std::istream &amp;is, optional&lt; bool &gt; &amp;t)</td></tr>
<tr class="memdesc:a5018d09b0f92f75d2c3ee572f62c0346"><td class="mdescLeft">&#160;</td><td class="mdescRight">specialization of '&gt;&gt;' istream parsing for optional&lt;bool&gt; <a href="namespacedmlc.html#a5018d09b0f92f75d2c3ee572f62c0346">More...</a><br /></td></tr>
<tr class="separator:a5018d09b0f92f75d2c3ee572f62c0346"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0e0e4f86115e4c4e7f761de5c8a6797"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#ae0e0e4f86115e4c4e7f761de5c8a6797">dmlc::DMLC_DECLARE_TYPE_NAME</a> (optional&lt; int &gt;, &quot;int or None&quot;)</td></tr>
<tr class="memdesc:ae0e0e4f86115e4c4e7f761de5c8a6797"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:a45790e76c170593a12e9a31c2ca547a8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a45790e76c170593a12e9a31c2ca547a8">dmlc::DMLC_DECLARE_TYPE_NAME</a> (optional&lt; bool &gt;, &quot;boolean or None&quot;)</td></tr>
<tr class="memdesc:a45790e76c170593a12e9a31c2ca547a8"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:aa8d7950ad6b6392afa1ec41fa42bfbf6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#aa8d7950ad6b6392afa1ec41fa42bfbf6">dmlc::DMLC_DECLARE_TYPE_NAME</a> (optional&lt; float &gt;, &quot;float or None&quot;)</td></tr>
<tr class="memdesc:aa8d7950ad6b6392afa1ec41fa42bfbf6"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:a24514e2baa4d33161ba4cde558e6245e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a24514e2baa4d33161ba4cde558e6245e">dmlc::DMLC_DECLARE_TYPE_NAME</a> (optional&lt; double &gt;, &quot;double or None&quot;)</td></tr>
<tr class="memdesc:a24514e2baa4d33161ba4cde558e6245e"><td class="mdescLeft">&#160;</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">&#160;</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&#160;</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">&#160;</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 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>