Google Git
Sign in
apache / mxnet-site / fce135bbc9f0f8596c6dccdcc32917144d78ccf2 / . / versions / 1.7.0 / api / cpp / docs / api / classmxnet_1_1runtime_1_1ObjectRef.html
blob: 9d7fb6788a198c943a40d9ce874d738caa5dba64 [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.11"/>
<title>mxnet: mxnet::runtime::ObjectRef Class 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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</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="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="namespacemxnet_1_1runtime.html">runtime</a></li><li class="navelem"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html">ObjectRef</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-static-methods">Static Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classmxnet_1_1runtime_1_1ObjectRef-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::runtime::ObjectRef Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Base class of all object reference.
<a href="classmxnet_1_1runtime_1_1ObjectRef.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="object_8h_source.html">object.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mxnet::runtime::ObjectRef:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1runtime_1_1ObjectRef__inherit__graph.png" border="0" usemap="#mxnet_1_1runtime_1_1ObjectRef_inherit__map" alt="Inheritance graph"/></div>
<map name="mxnet_1_1runtime_1_1ObjectRef_inherit__map" id="mxnet_1_1runtime_1_1ObjectRef_inherit__map">
<area shape="rect" id="node2" href="classmxnet_1_1runtime_1_1ADT.html" title="reference to algebraic data type objects. " alt="" coords="5,321,192,516"/>
<area shape="rect" id="node3" href="classmxnet_1_1runtime_1_1Integer.html" title="{mxnet::runtime::Integer\n||+ Integer()\l+ MXNET_DEFINE_OBJECT\l_REF_METHODS()\l}" alt="" coords="216,365,403,472"/>
<area shape="rect" id="node4" href="classmxnet_1_1runtime_1_1Slice.html" title="{mxnet::runtime::Slice\n|+ kNoneValue\l|+ Slice()\l+ Slice()\l+ MXNET_DEFINE_OBJECT\l_REF_METHODS()\l}" alt="" coords="427,358,613,479"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for mxnet::runtime::ObjectRef:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1runtime_1_1ObjectRef__coll__graph.png" border="0" usemap="#mxnet_1_1runtime_1_1ObjectRef_coll__map" alt="Collaboration graph"/></div>
<map name="mxnet_1_1runtime_1_1ObjectRef_coll__map" id="mxnet_1_1runtime_1_1ObjectRef_coll__map">
<area shape="rect" id="node2" href="classmxnet_1_1runtime_1_1ObjectPtr.html" title="{mxnet::runtime::ObjectPtr\l\&lt; mxnet::runtime::Object \&gt;\n||+ ObjectPtr()\l+ ObjectPtr()\l+ ObjectPtr()\l+ ObjectPtr()\l+ ObjectPtr()\l+ ObjectPtr()\l+ ~ObjectPtr()\l+ swap()\l+ get()\l+ operator&#45;\&gt;()\land 10 more...\l}" alt="" coords="5,5,205,244"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:afb17c6afa35f39c755d92fa2090fe0af"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#afb17c6afa35f39c755d92fa2090fe0af">ContainerType</a> = <a class="el" href="classmxnet_1_1runtime_1_1Object.html">Object</a></td></tr>
<tr class="memdesc:afb17c6afa35f39c755d92fa2090fe0af"><td class="mdescLeft">&#160;</td><td class="mdescRight">type indicate the container type. <a href="#afb17c6afa35f39c755d92fa2090fe0af">More...</a><br /></td></tr>
<tr class="separator:afb17c6afa35f39c755d92fa2090fe0af"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1eeff522c6cb7503f2f2205bc69c0fce"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#a1eeff522c6cb7503f2f2205bc69c0fce">ObjectRef</a> ()=default</td></tr>
<tr class="memdesc:a1eeff522c6cb7503f2f2205bc69c0fce"><td class="mdescLeft">&#160;</td><td class="mdescRight">default constructor <a href="#a1eeff522c6cb7503f2f2205bc69c0fce">More...</a><br /></td></tr>
<tr class="separator:a1eeff522c6cb7503f2f2205bc69c0fce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a075f794b50f9d9d89d3d31930a1bc38c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#a075f794b50f9d9d89d3d31930a1bc38c">ObjectRef</a> (<a class="el" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr</a>&lt; <a class="el" href="classmxnet_1_1runtime_1_1Object.html">Object</a> &gt; data)</td></tr>
<tr class="memdesc:a075f794b50f9d9d89d3d31930a1bc38c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor from existing object ptr. <a href="#a075f794b50f9d9d89d3d31930a1bc38c">More...</a><br /></td></tr>
<tr class="separator:a075f794b50f9d9d89d3d31930a1bc38c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbdd1b7fd9d82ffd59d3afca8d667a03"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#abbdd1b7fd9d82ffd59d3afca8d667a03">same_as</a> (const <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html">ObjectRef</a> &amp;other) const </td></tr>
<tr class="memdesc:abbdd1b7fd9d82ffd59d3afca8d667a03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Comparator. <a href="#abbdd1b7fd9d82ffd59d3afca8d667a03">More...</a><br /></td></tr>
<tr class="separator:abbdd1b7fd9d82ffd59d3afca8d667a03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab20eea6fad83c353d3736b38c9658a3b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#ab20eea6fad83c353d3736b38c9658a3b">operator==</a> (const <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html">ObjectRef</a> &amp;other) const </td></tr>
<tr class="memdesc:ab20eea6fad83c353d3736b38c9658a3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Comparator. <a href="#ab20eea6fad83c353d3736b38c9658a3b">More...</a><br /></td></tr>
<tr class="separator:ab20eea6fad83c353d3736b38c9658a3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2be613b528bf792d25edfbe767a9b4f4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#a2be613b528bf792d25edfbe767a9b4f4">operator!=</a> (const <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html">ObjectRef</a> &amp;other) const </td></tr>
<tr class="memdesc:a2be613b528bf792d25edfbe767a9b4f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Comparator. <a href="#a2be613b528bf792d25edfbe767a9b4f4">More...</a><br /></td></tr>
<tr class="separator:a2be613b528bf792d25edfbe767a9b4f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add01022d85abd2a785a37cfa5d53f2c2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#add01022d85abd2a785a37cfa5d53f2c2">operator&lt;</a> (const <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html">ObjectRef</a> &amp;other) const </td></tr>
<tr class="memdesc:add01022d85abd2a785a37cfa5d53f2c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Comparator. <a href="#add01022d85abd2a785a37cfa5d53f2c2">More...</a><br /></td></tr>
<tr class="separator:add01022d85abd2a785a37cfa5d53f2c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43bb1383d82a95a065bcb41e41a98f60"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#a43bb1383d82a95a065bcb41e41a98f60">defined</a> () const </td></tr>
<tr class="separator:a43bb1383d82a95a065bcb41e41a98f60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3245c3898421021340dd854e71337d71"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classmxnet_1_1runtime_1_1Object.html">Object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#a3245c3898421021340dd854e71337d71">get</a> () const </td></tr>
<tr class="separator:a3245c3898421021340dd854e71337d71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c5db5403829f339af3f0b9de7a9ea76"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classmxnet_1_1runtime_1_1Object.html">Object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#a7c5db5403829f339af3f0b9de7a9ea76">operator-&gt;</a> () const </td></tr>
<tr class="separator:a7c5db5403829f339af3f0b9de7a9ea76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2153ea41d9e35f8f89d142ad38a03cc5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#a2153ea41d9e35f8f89d142ad38a03cc5">unique</a> () const </td></tr>
<tr class="separator:a2153ea41d9e35f8f89d142ad38a03cc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab779f2a029b3a6172b574a27e311ffee"><td class="memTemplParams" colspan="2">template&lt;typename ObjectType &gt; </td></tr>
<tr class="memitem:ab779f2a029b3a6172b574a27e311ffee"><td class="memTemplItemLeft" align="right" valign="top">const ObjectType *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#ab779f2a029b3a6172b574a27e311ffee">as</a> () const </td></tr>
<tr class="memdesc:ab779f2a029b3a6172b574a27e311ffee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Try to downcast the internal <a class="el" href="classmxnet_1_1runtime_1_1Object.html" title="base class of all object containers. ">Object</a> to a raw pointer of a corresponding type. <a href="#ab779f2a029b3a6172b574a27e311ffee">More...</a><br /></td></tr>
<tr class="separator:ab779f2a029b3a6172b574a27e311ffee"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a325069edef06350393bd31515d355779"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1runtime_1_1Object.html">Object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#a325069edef06350393bd31515d355779">get_mutable</a> () const </td></tr>
<tr class="separator:a325069edef06350393bd31515d355779"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:ab5adba2e735bd310635cf9dfa1799e9c"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ab5adba2e735bd310635cf9dfa1799e9c"><td class="memTemplItemLeft" align="right" valign="top">static T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#ab5adba2e735bd310635cf9dfa1799e9c">DowncastNoCheck</a> (<a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html">ObjectRef</a> ref)</td></tr>
<tr class="memdesc:ab5adba2e735bd310635cf9dfa1799e9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal helper function downcast a ref without check. <a href="#ab5adba2e735bd310635cf9dfa1799e9c">More...</a><br /></td></tr>
<tr class="separator:ab5adba2e735bd310635cf9dfa1799e9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44873861fe3a0ee963314402eb3e1f47"><td class="memTemplParams" colspan="2">template&lt;typename ObjectType &gt; </td></tr>
<tr class="memitem:a44873861fe3a0ee963314402eb3e1f47"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr</a>&lt; ObjectType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#a44873861fe3a0ee963314402eb3e1f47">GetDataPtr</a> (const <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html">ObjectRef</a> &amp;ref)</td></tr>
<tr class="memdesc:a44873861fe3a0ee963314402eb3e1f47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal helper function get data_ as <a class="el" href="classmxnet_1_1runtime_1_1ObjectPtr.html" title="A custom smart pointer for Object. ">ObjectPtr</a> of ObjectType. <a href="#a44873861fe3a0ee963314402eb3e1f47">More...</a><br /></td></tr>
<tr class="separator:a44873861fe3a0ee963314402eb3e1f47"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a5009d0661d741e4b105402b3126663e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr</a>&lt; <a class="el" href="classmxnet_1_1runtime_1_1Object.html">Object</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#a5009d0661d741e4b105402b3126663e9">data_</a></td></tr>
<tr class="memdesc:a5009d0661d741e4b105402b3126663e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal pointer that backs the reference. <a href="#a5009d0661d741e4b105402b3126663e9">More...</a><br /></td></tr>
<tr class="separator:a5009d0661d741e4b105402b3126663e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a7191cb82e9344bec1b5fd20f45b289f1"><td class="memItemLeft" align="right" valign="top">struct&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#a7191cb82e9344bec1b5fd20f45b289f1">ObjectHash</a></td></tr>
<tr class="separator:a7191cb82e9344bec1b5fd20f45b289f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82aa089816e7ff294eecf5c1bc1165cf"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#a82aa089816e7ff294eecf5c1bc1165cf">MXNetRetValue</a></td></tr>
<tr class="separator:a82aa089816e7ff294eecf5c1bc1165cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0589aedf749aa4d55e73539f5b135a24"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#a0589aedf749aa4d55e73539f5b135a24">MXNetArgsSetter</a></td></tr>
<tr class="separator:a0589aedf749aa4d55e73539f5b135a24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68c32a41efd1aa99afca70837565cced"><td class="memTemplParams" colspan="2">template&lt;typename SubRef , typename BaseRef &gt; </td></tr>
<tr class="memitem:a68c32a41efd1aa99afca70837565cced"><td class="memTemplItemLeft" align="right" valign="top">SubRef&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#a68c32a41efd1aa99afca70837565cced">Downcast</a> (BaseRef ref)</td></tr>
<tr class="memdesc:a68c32a41efd1aa99afca70837565cced"><td class="mdescLeft">&#160;</td><td class="mdescRight">Downcast a base reference type to a more specific type. <a href="#a68c32a41efd1aa99afca70837565cced">More...</a><br /></td></tr>
<tr class="separator:a68c32a41efd1aa99afca70837565cced"><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>Base class of all object reference. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="afb17c6afa35f39c755d92fa2090fe0af"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html#afb17c6afa35f39c755d92fa2090fe0af">mxnet::runtime::ObjectRef::ContainerType</a> = <a class="el" href="classmxnet_1_1runtime_1_1Object.html">Object</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>type indicate the container type. </p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a1eeff522c6cb7503f2f2205bc69c0fce"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::runtime::ObjectRef::ObjectRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>default constructor </p>
</div>
</div>
<a class="anchor" id="a075f794b50f9d9d89d3d31930a1bc38c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::runtime::ObjectRef::ObjectRef </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr</a>&lt; <a class="el" href="classmxnet_1_1runtime_1_1Object.html">Object</a> &gt;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor from existing object ptr. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab779f2a029b3a6172b574a27e311ffee"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ObjectType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const ObjectType * mxnet::runtime::ObjectRef::as </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Try to downcast the internal <a class="el" href="classmxnet_1_1runtime_1_1Object.html" title="base class of all object containers. ">Object</a> to a raw pointer of a corresponding type. </p>
<p>The function will return a nullptr if the cast failed.</p>
<p>if (const Add *add = node_ref.As&lt;Add&gt;()) { // This is an add node } </p><dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">ObjectType</td><td>the target type, must be a subtype of Object/ </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a43bb1383d82a95a065bcb41e41a98f60"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::runtime::ObjectRef::defined </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>whether the expression is null </dd></dl>
</div>
</div>
<a class="anchor" id="ab5adba2e735bd310635cf9dfa1799e9c"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static T mxnet::runtime::ObjectRef::DowncastNoCheck </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html">ObjectRef</a>&#160;</td>
<td class="paramname"><em>ref</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Internal helper function downcast a ref without check. </p>
<dl class="section note"><dt>Note</dt><dd>Only used for internal dev purposes. </dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>The target reference type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The casted result. </dd></dl>
</div>
</div>
<a class="anchor" id="a3245c3898421021340dd854e71337d71"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classmxnet_1_1runtime_1_1Object.html">Object</a>* mxnet::runtime::ObjectRef::get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the internal object pointer </dd></dl>
</div>
</div>
<a class="anchor" id="a325069edef06350393bd31515d355779"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1runtime_1_1Object.html">Object</a>* mxnet::runtime::ObjectRef::get_mutable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>return a mutable internal ptr, can be used by sub-classes. </dd></dl>
</div>
</div>
<a class="anchor" id="a44873861fe3a0ee963314402eb3e1f47"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ObjectType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr</a>&lt;ObjectType&gt; mxnet::runtime::ObjectRef::GetDataPtr </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html">ObjectRef</a> &amp;&#160;</td>
<td class="paramname"><em>ref</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Internal helper function get data_ as <a class="el" href="classmxnet_1_1runtime_1_1ObjectPtr.html" title="A custom smart pointer for Object. ">ObjectPtr</a> of ObjectType. </p>
<dl class="section note"><dt>Note</dt><dd>only used for internal dev purpose. </dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">ObjectType</td><td>The corresponding object type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the corresponding type. </dd></dl>
</div>
</div>
<a class="anchor" id="a2be613b528bf792d25edfbe767a9b4f4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::runtime::ObjectRef::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html">ObjectRef</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Comparator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Another object ref. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the compare result. </dd></dl>
</div>
</div>
<a class="anchor" id="a7c5db5403829f339af3f0b9de7a9ea76"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classmxnet_1_1runtime_1_1Object.html">Object</a>* mxnet::runtime::ObjectRef::operator-&gt; </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the internal object pointer </dd></dl>
</div>
</div>
<a class="anchor" id="add01022d85abd2a785a37cfa5d53f2c2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::runtime::ObjectRef::operator&lt; </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html">ObjectRef</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Comparator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Another object ref by address. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the compare result. </dd></dl>
</div>
</div>
<a class="anchor" id="ab20eea6fad83c353d3736b38c9658a3b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::runtime::ObjectRef::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html">ObjectRef</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Comparator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Another object ref. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the compare result. </dd></dl>
</div>
</div>
<a class="anchor" id="abbdd1b7fd9d82ffd59d3afca8d667a03"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::runtime::ObjectRef::same_as </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html">ObjectRef</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Comparator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Another object ref. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the compare result. </dd></dl>
</div>
</div>
<a class="anchor" id="a2153ea41d9e35f8f89d142ad38a03cc5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::runtime::ObjectRef::unique </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>whether the reference is unique </dd></dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a68c32a41efd1aa99afca70837565cced"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SubRef , typename BaseRef &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">SubRef Downcast </td>
<td>(</td>
<td class="paramtype">BaseRef&#160;</td>
<td class="paramname"><em>ref</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Downcast a base reference type to a more specific type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ref</td><td>The inptut reference </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The corresponding SubRef. </dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">SubRef</td><td>The target specific reference type. </td></tr>
<tr><td class="paramname">BaseRef</td><td>the current reference type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0589aedf749aa4d55e73539f5b135a24"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classmxnet_1_1runtime_1_1MXNetArgsSetter.html">MXNetArgsSetter</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a82aa089816e7ff294eecf5c1bc1165cf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classmxnet_1_1runtime_1_1MXNetRetValue.html">MXNetRetValue</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7191cb82e9344bec1b5fd20f45b289f1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend struct <a class="el" href="structmxnet_1_1runtime_1_1ObjectHash.html">ObjectHash</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a5009d0661d741e4b105402b3126663e9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr</a>&lt;<a class="el" href="classmxnet_1_1runtime_1_1Object.html">Object</a>&gt; mxnet::runtime::ObjectRef::data_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Internal pointer that backs the reference. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/work/mxnet/include/mxnet/runtime/<a class="el" href="object_8h_source.html">object.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 11 2020 03:38:06 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>