blob: 4a65e44733f53b5b9c21878cf20777a2a91f8680 [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: nnvm::Node 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>
<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="namespacennvm.html">nnvm</a></li><li class="navelem"><a class="el" href="classnnvm_1_1Node.html">Node</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classnnvm_1_1Node-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">nnvm::Node Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classnnvm_1_1Node.html" title="Node represents an operation in a computation graph.">Node</a> represents an operation in a computation graph.
<a href="classnnvm_1_1Node.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::Node:</div>
<div class="dyncontent">
<div class="center"><img src="classnnvm_1_1Node__coll__graph.png" border="0" usemap="#nnvm_1_1Node_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 0 -->
</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:a8c11333506be8aa6be4ecd689f9a528c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Node.html#a8c11333506be8aa6be4ecd689f9a528c">Node</a> ()=default</td></tr>
<tr class="separator:a8c11333506be8aa6be4ecd689f9a528c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1943fabebfd58b0de3f7aa641c46d529"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Node.html#a1943fabebfd58b0de3f7aa641c46d529">Node</a> (const <a class="el" href="classnnvm_1_1Op.html">Op</a> *<a class="el" href="classnnvm_1_1Node.html#a801418bfe52712d56fb54cf8038882ee">op</a>, const std::string &amp;name)</td></tr>
<tr class="separator:a1943fabebfd58b0de3f7aa641c46d529"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11583c4fd5252e70ea9cec5dd0c232af"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Node.html#a11583c4fd5252e70ea9cec5dd0c232af">~Node</a> ()</td></tr>
<tr class="memdesc:a11583c4fd5252e70ea9cec5dd0c232af"><td class="mdescLeft">&#160;</td><td class="mdescRight">destructor of node <a href="classnnvm_1_1Node.html#a11583c4fd5252e70ea9cec5dd0c232af">More...</a><br /></td></tr>
<tr class="separator:a11583c4fd5252e70ea9cec5dd0c232af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a801418bfe52712d56fb54cf8038882ee"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classnnvm_1_1Op.html">Op</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Node.html#a801418bfe52712d56fb54cf8038882ee">op</a> () const</td></tr>
<tr class="separator:a801418bfe52712d56fb54cf8038882ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fb1b7742cc22d02929fa87a2324e19d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Node.html#a7fb1b7742cc22d02929fa87a2324e19d">is_variable</a> () const</td></tr>
<tr class="memdesc:a7fb1b7742cc22d02929fa87a2324e19d"><td class="mdescLeft">&#160;</td><td class="mdescRight">return whether node is placeholder variable. This is equivalent to op == nullptr <a href="classnnvm_1_1Node.html#a7fb1b7742cc22d02929fa87a2324e19d">More...</a><br /></td></tr>
<tr class="separator:a7fb1b7742cc22d02929fa87a2324e19d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a8614bcda9e60a4a89c8018e8cd3f9f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Node.html#a8a8614bcda9e60a4a89c8018e8cd3f9f">num_outputs</a> () const</td></tr>
<tr class="separator:a8a8614bcda9e60a4a89c8018e8cd3f9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58acc4fd42c8049da953e49ea11c0b63"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Node.html#a58acc4fd42c8049da953e49ea11c0b63">num_inputs</a> () const</td></tr>
<tr class="separator:a58acc4fd42c8049da953e49ea11c0b63"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a34f87ad11156f6f6e612f39fe2f5dd25"><td class="memTemplParams" colspan="2">template&lt;class... Args&gt; </td></tr>
<tr class="memitem:a34f87ad11156f6f6e612f39fe2f5dd25"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">ObjectPtr</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Node.html#a34f87ad11156f6f6e612f39fe2f5dd25">Create</a> (Args &amp;&amp;... args)</td></tr>
<tr class="memdesc:a34f87ad11156f6f6e612f39fe2f5dd25"><td class="mdescLeft">&#160;</td><td class="mdescRight">create a new empty shared_ptr of <a class="el" href="classnnvm_1_1Node.html" title="Node represents an operation in a computation graph.">Node</a>. <a href="classnnvm_1_1Node.html#a34f87ad11156f6f6e612f39fe2f5dd25">More...</a><br /></td></tr>
<tr class="separator:a34f87ad11156f6f6e612f39fe2f5dd25"><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:a9c029a44eadefe48b2e5630e77eb7de1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Node.html#a9c029a44eadefe48b2e5630e77eb7de1">attrs</a></td></tr>
<tr class="memdesc:a9c029a44eadefe48b2e5630e77eb7de1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The attributes in the node. <a href="classnnvm_1_1Node.html#a9c029a44eadefe48b2e5630e77eb7de1">More...</a><br /></td></tr>
<tr class="separator:a9c029a44eadefe48b2e5630e77eb7de1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1be3a2e4759dc6239332cb9657c5c11d"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structnnvm_1_1NodeEntry.html">NodeEntry</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Node.html#a1be3a2e4759dc6239332cb9657c5c11d">inputs</a></td></tr>
<tr class="memdesc:a1be3a2e4759dc6239332cb9657c5c11d"><td class="mdescLeft">&#160;</td><td class="mdescRight">inputs to this node <a href="classnnvm_1_1Node.html#a1be3a2e4759dc6239332cb9657c5c11d">More...</a><br /></td></tr>
<tr class="separator:a1be3a2e4759dc6239332cb9657c5c11d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e6f4bd01bb3bd688ce441144989b438"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">ObjectPtr</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Node.html#a1e6f4bd01bb3bd688ce441144989b438">control_deps</a></td></tr>
<tr class="memdesc:a1e6f4bd01bb3bd688ce441144989b438"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional control flow dependencies Gives operation must be performed before this operation. <a href="classnnvm_1_1Node.html#a1e6f4bd01bb3bd688ce441144989b438">More...</a><br /></td></tr>
<tr class="separator:a1e6f4bd01bb3bd688ce441144989b438"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a4239e82c7a4163edfad83e9533fc1a"><td class="memItemLeft" align="right" valign="top">any&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1Node.html#a7a4239e82c7a4163edfad83e9533fc1a">info</a></td></tr>
<tr class="memdesc:a7a4239e82c7a4163edfad83e9533fc1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">additional fields for this node <a href="classnnvm_1_1Node.html#a7a4239e82c7a4163edfad83e9533fc1a">More...</a><br /></td></tr>
<tr class="separator:a7a4239e82c7a4163edfad83e9533fc1a"><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><a class="el" href="classnnvm_1_1Node.html" title="Node represents an operation in a computation graph.">Node</a> represents an operation in a computation graph. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8c11333506be8aa6be4ecd689f9a528c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c11333506be8aa6be4ecd689f9a528c">&#9670;&nbsp;</a></span>Node() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">nnvm::Node::Node </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">
</div>
</div>
<a id="a1943fabebfd58b0de3f7aa641c46d529"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1943fabebfd58b0de3f7aa641c46d529">&#9670;&nbsp;</a></span>Node() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">nnvm::Node::Node </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classnnvm_1_1Op.html">Op</a> *&#160;</td>
<td class="paramname"><em>op</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</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="a11583c4fd5252e70ea9cec5dd0c232af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11583c4fd5252e70ea9cec5dd0c232af">&#9670;&nbsp;</a></span>~Node()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">nnvm::Node::~Node </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>destructor of node </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a34f87ad11156f6f6e612f39fe2f5dd25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34f87ad11156f6f6e612f39fe2f5dd25">&#9670;&nbsp;</a></span>Create()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">ObjectPtr</a> nnvm::Node::Create </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>create a new empty shared_ptr of <a class="el" href="classnnvm_1_1Node.html" title="Node represents an operation in a computation graph.">Node</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>a created empty node. </dd></dl>
</div>
</div>
<a id="a7fb1b7742cc22d02929fa87a2324e19d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fb1b7742cc22d02929fa87a2324e19d">&#9670;&nbsp;</a></span>is_variable()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool nnvm::Node::is_variable </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>return whether node is placeholder variable. This is equivalent to op == nullptr </p>
<dl class="section return"><dt>Returns</dt><dd>whether node is placeholder input variable </dd></dl>
</div>
</div>
<a id="a58acc4fd42c8049da953e49ea11c0b63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58acc4fd42c8049da953e49ea11c0b63">&#9670;&nbsp;</a></span>num_inputs()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32_t nnvm::Node::num_inputs </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>number of inputs from this node </dd></dl>
</div>
</div>
<a id="a8a8614bcda9e60a4a89c8018e8cd3f9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a8614bcda9e60a4a89c8018e8cd3f9f">&#9670;&nbsp;</a></span>num_outputs()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32_t nnvm::Node::num_outputs </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>number of outputs from this node </dd></dl>
</div>
</div>
<a id="a801418bfe52712d56fb54cf8038882ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a801418bfe52712d56fb54cf8038882ee">&#9670;&nbsp;</a></span>op()</h2>
<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="classnnvm_1_1Op.html">Op</a> * nnvm::Node::op </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>operator in this node </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9c029a44eadefe48b2e5630e77eb7de1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c029a44eadefe48b2e5630e77eb7de1">&#9670;&nbsp;</a></span>attrs</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structnnvm_1_1NodeAttrs.html">NodeAttrs</a> nnvm::Node::attrs</td>
</tr>
</table>
</div><div class="memdoc">
<p>The attributes in the node. </p>
</div>
</div>
<a id="a1e6f4bd01bb3bd688ce441144989b438"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e6f4bd01bb3bd688ce441144989b438">&#9670;&nbsp;</a></span>control_deps</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">ObjectPtr</a>&gt; nnvm::Node::control_deps</td>
</tr>
</table>
</div><div class="memdoc">
<p>Optional control flow dependencies Gives operation must be performed before this operation. </p>
</div>
</div>
<a id="a7a4239e82c7a4163edfad83e9533fc1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a4239e82c7a4163edfad83e9533fc1a">&#9670;&nbsp;</a></span>info</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">any nnvm::Node::info</td>
</tr>
</table>
</div><div class="memdoc">
<p>additional fields for this node </p>
</div>
</div>
<a id="a1be3a2e4759dc6239332cb9657c5c11d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1be3a2e4759dc6239332cb9657c5c11d">&#9670;&nbsp;</a></span>inputs</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="structnnvm_1_1NodeEntry.html">NodeEntry</a>&gt; nnvm::Node::inputs</td>
</tr>
</table>
</div><div class="memdoc">
<p>inputs to this node </p>
</div>
</div>
<hr/>The documentation for this class 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 03:47:41 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>