blob: 7fa1f47b833f3515a430a0d0da1c1ea7762fb61b [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: nnvm::NodeEntry Struct 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="namespacennvm.html">nnvm</a></li><li class="navelem"><a class="el" href="structnnvm_1_1NodeEntry.html">NodeEntry</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structnnvm_1_1NodeEntry-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">nnvm::NodeEntry Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>an entry that represents output data from a node
<a href="structnnvm_1_1NodeEntry.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2node_8h_source.html">node.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for nnvm::NodeEntry:</div>
<div class="dyncontent">
<div class="center"><img src="structnnvm_1_1NodeEntry__coll__graph.png" border="0" usemap="#nnvm_1_1NodeEntry_coll__map" alt="Collaboration graph"/></div>
<map name="nnvm_1_1NodeEntry_coll__map" id="nnvm_1_1NodeEntry_coll__map">
</map>
</div>
<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:ada672e1520eb93e2475149acacee694b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnnvm_1_1NodeEntry.html#ada672e1520eb93e2475149acacee694b">NodeEntry</a> (<a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">ObjectPtr</a> <a class="el" href="structnnvm_1_1NodeEntry.html#ae438981d6f9d3a890e197d917b9e1a4f">node</a>, uint32_t <a class="el" href="structnnvm_1_1NodeEntry.html#a5f231fbd1854ee182696b023be6ff5f8">index</a>, uint32_t <a class="el" href="structnnvm_1_1NodeEntry.html#afa6a0461be305acd503e0020845664d6">version</a>)</td></tr>
<tr class="separator:ada672e1520eb93e2475149acacee694b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae70bc51a7b4db88d475452f9e3ccb6bb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnnvm_1_1NodeEntry.html#ae70bc51a7b4db88d475452f9e3ccb6bb">NodeEntry</a> (<a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">ObjectPtr</a> <a class="el" href="structnnvm_1_1NodeEntry.html#ae438981d6f9d3a890e197d917b9e1a4f">node</a>)</td></tr>
<tr class="separator:ae70bc51a7b4db88d475452f9e3ccb6bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a842c140893e85b5c53b21179f0be0636"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnnvm_1_1NodeEntry.html#a842c140893e85b5c53b21179f0be0636">NodeEntry</a> ()</td></tr>
<tr class="separator:a842c140893e85b5c53b21179f0be0636"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ae438981d6f9d3a890e197d917b9e1a4f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">ObjectPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnnvm_1_1NodeEntry.html#ae438981d6f9d3a890e197d917b9e1a4f">node</a></td></tr>
<tr class="memdesc:ae438981d6f9d3a890e197d917b9e1a4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">the source node of this data <a href="#ae438981d6f9d3a890e197d917b9e1a4f">More...</a><br /></td></tr>
<tr class="separator:ae438981d6f9d3a890e197d917b9e1a4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f231fbd1854ee182696b023be6ff5f8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnnvm_1_1NodeEntry.html#a5f231fbd1854ee182696b023be6ff5f8">index</a></td></tr>
<tr class="memdesc:a5f231fbd1854ee182696b023be6ff5f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">index of output from the source. <a href="#a5f231fbd1854ee182696b023be6ff5f8">More...</a><br /></td></tr>
<tr class="separator:a5f231fbd1854ee182696b023be6ff5f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa6a0461be305acd503e0020845664d6"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnnvm_1_1NodeEntry.html#afa6a0461be305acd503e0020845664d6">version</a></td></tr>
<tr class="memdesc:afa6a0461be305acd503e0020845664d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">version of input Variable. This field can only be nonzero when this-&gt;node is a Variable node. version is increased by one each time a Variable get composed to a mutation <a class="el" href="classnnvm_1_1Op.html" title="Operator structure. ">Op</a>. This information can be helpful to decide order of operations when sequence of mutation happens. <a href="#afa6a0461be305acd503e0020845664d6">More...</a><br /></td></tr>
<tr class="separator:afa6a0461be305acd503e0020845664d6"><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>an entry that represents output data from a node </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ada672e1520eb93e2475149acacee694b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada672e1520eb93e2475149acacee694b">&#9670;&nbsp;</a></span>NodeEntry() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">nnvm::NodeEntry::NodeEntry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">ObjectPtr</a>&#160;</td>
<td class="paramname"><em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>version</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae70bc51a7b4db88d475452f9e3ccb6bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae70bc51a7b4db88d475452f9e3ccb6bb">&#9670;&nbsp;</a></span>NodeEntry() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">nnvm::NodeEntry::NodeEntry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">ObjectPtr</a>&#160;</td>
<td class="paramname"><em>node</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">
</div>
</div>
<a id="a842c140893e85b5c53b21179f0be0636"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a842c140893e85b5c53b21179f0be0636">&#9670;&nbsp;</a></span>NodeEntry() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">nnvm::NodeEntry::NodeEntry </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>MXNet assumes that a node with a null ptr doesn't have a gradient attached. Don't change this constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a5f231fbd1854ee182696b023be6ff5f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f231fbd1854ee182696b023be6ff5f8">&#9670;&nbsp;</a></span>index</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t nnvm::NodeEntry::index</td>
</tr>
</table>
</div><div class="memdoc">
<p>index of output from the source. </p>
</div>
</div>
<a id="ae438981d6f9d3a890e197d917b9e1a4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae438981d6f9d3a890e197d917b9e1a4f">&#9670;&nbsp;</a></span>node</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">ObjectPtr</a> nnvm::NodeEntry::node</td>
</tr>
</table>
</div><div class="memdoc">
<p>the source node of this data </p>
</div>
</div>
<a id="afa6a0461be305acd503e0020845664d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa6a0461be305acd503e0020845664d6">&#9670;&nbsp;</a></span>version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t nnvm::NodeEntry::version</td>
</tr>
</table>
</div><div class="memdoc">
<p>version of input Variable. This field can only be nonzero when this-&gt;node is a Variable node. version is increased by one each time a Variable get composed to a mutation <a class="el" href="classnnvm_1_1Op.html" title="Operator structure. ">Op</a>. This information can be helpful to decide order of operations when sequence of mutation happens. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/work/mxnet/3rdparty/tvm/nnvm/include/nnvm/<a class="el" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2node_8h_source.html">node.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:44 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>