blob: 4293696273ce50ca377a352b7f27d652c78fffce [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: mxnet::Imperative::DCInfo 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="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="classmxnet_1_1Imperative.html">Imperative</a></li><li class="navelem"><a class="el" href="classmxnet_1_1Imperative_1_1DCInfo.html">DCInfo</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="#friends">Friends</a> &#124;
<a href="classmxnet_1_1Imperative_1_1DCInfo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::Imperative::DCInfo Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classmxnet_1_1Imperative_1_1DCInfo.html" title="DCInfo datastructure to enable deferred computation.">DCInfo</a> datastructure to enable deferred computation.
<a href="classmxnet_1_1Imperative_1_1DCInfo.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="imperative_8h_source.html">imperative.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::Imperative::DCInfo:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1Imperative_1_1DCInfo__coll__graph.png" border="0" usemap="#mxnet_1_1Imperative_1_1DCInfo_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:a7cfad0dc028cbb5e69e90ae39d2f9e70"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1DCInfo.html#a7cfad0dc028cbb5e69e90ae39d2f9e70">DCInfo</a> (const std::vector&lt; <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * &gt; &amp;inputs, const std::vector&lt; <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * &gt; &amp;outputs)</td></tr>
<tr class="separator:a7cfad0dc028cbb5e69e90ae39d2f9e70"><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:ae3ed1478b682bfc9eafa1510c78bfeaf"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1DCInfo.html#ae3ed1478b682bfc9eafa1510c78bfeaf">Compute</a> (const <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> &amp;arr)</td></tr>
<tr class="memdesc:ae3ed1478b682bfc9eafa1510c78bfeaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the outputs of the associated operator. <a href="classmxnet_1_1Imperative_1_1DCInfo.html#ae3ed1478b682bfc9eafa1510c78bfeaf">More...</a><br /></td></tr>
<tr class="separator:ae3ed1478b682bfc9eafa1510c78bfeaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24d719b5ff052a18df938ba9ea9cc350"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmxnet_1_1Imperative_1_1DCInfo.html">DCInfo</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1DCInfo.html#a24d719b5ff052a18df938ba9ea9cc350">Get</a> (const <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">nnvm::ObjectPtr</a> &amp;node)</td></tr>
<tr class="separator:a24d719b5ff052a18df938ba9ea9cc350"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63550f72a12eb4d58f6d073f8b235b01"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1DCInfo.html#a63550f72a12eb4d58f6d073f8b235b01">IsNone</a> (const <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> &amp;arr)</td></tr>
<tr class="separator:a63550f72a12eb4d58f6d073f8b235b01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf2994fe8c5825e250fc5f156ac3138a"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1DCInfo.html#adf2994fe8c5825e250fc5f156ac3138a">IsComputed</a> (const <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> &amp;arr)</td></tr>
<tr class="separator:adf2994fe8c5825e250fc5f156ac3138a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e1237c58b927977500747dbd6639ced"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmxnet_1_1Imperative_1_1DCInfo.html">DCInfo</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1DCInfo.html#a7e1237c58b927977500747dbd6639ced">Create</a> (const <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">nnvm::ObjectPtr</a> &amp;node, const std::vector&lt; <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * &gt; &amp;inputs, const std::vector&lt; <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * &gt; &amp;outputs)</td></tr>
<tr class="separator:a7e1237c58b927977500747dbd6639ced"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a684fdd36b93a9e196f0072a79c7560db"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1DCInfo.html#a684fdd36b93a9e196f0072a79c7560db">Clear</a> (const <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">nnvm::ObjectPtr</a> &amp;node)</td></tr>
<tr class="separator:a684fdd36b93a9e196f0072a79c7560db"><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:add286ab9a359eb017008c9a3ff53701f"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Imperative_1_1DCInfo.html#add286ab9a359eb017008c9a3ff53701f">Imperative</a></td></tr>
<tr class="separator:add286ab9a359eb017008c9a3ff53701f"><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="classmxnet_1_1Imperative_1_1DCInfo.html" title="DCInfo datastructure to enable deferred computation.">DCInfo</a> datastructure to enable deferred computation. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7cfad0dc028cbb5e69e90ae39d2f9e70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7cfad0dc028cbb5e69e90ae39d2f9e70">&#9670;&nbsp;</a></span>DCInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::Imperative::DCInfo::DCInfo </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * &gt; &amp;&#160;</td>
<td class="paramname"><em>inputs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * &gt; &amp;&#160;</td>
<td class="paramname"><em>outputs</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">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a684fdd36b93a9e196f0072a79c7560db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a684fdd36b93a9e196f0072a79c7560db">&#9670;&nbsp;</a></span>Clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void mxnet::Imperative::DCInfo::Clear </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">nnvm::ObjectPtr</a> &amp;&#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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae3ed1478b682bfc9eafa1510c78bfeaf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3ed1478b682bfc9eafa1510c78bfeaf">&#9670;&nbsp;</a></span>Compute()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void mxnet::Imperative::DCInfo::Compute </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> &amp;&#160;</td>
<td class="paramname"><em>arr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute the outputs of the associated operator. </p>
</div>
</div>
<a id="a7e1237c58b927977500747dbd6639ced"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e1237c58b927977500747dbd6639ced">&#9670;&nbsp;</a></span>Create()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classmxnet_1_1Imperative_1_1DCInfo.html">DCInfo</a>&amp; mxnet::Imperative::DCInfo::Create </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">nnvm::ObjectPtr</a> &amp;&#160;</td>
<td class="paramname"><em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * &gt; &amp;&#160;</td>
<td class="paramname"><em>inputs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> * &gt; &amp;&#160;</td>
<td class="paramname"><em>outputs</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a24d719b5ff052a18df938ba9ea9cc350"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24d719b5ff052a18df938ba9ea9cc350">&#9670;&nbsp;</a></span>Get()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classmxnet_1_1Imperative_1_1DCInfo.html">DCInfo</a>&amp; mxnet::Imperative::DCInfo::Get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacennvm.html#a573897937ff3b88f0014feabb8e44a92">nnvm::ObjectPtr</a> &amp;&#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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="adf2994fe8c5825e250fc5f156ac3138a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf2994fe8c5825e250fc5f156ac3138a">&#9670;&nbsp;</a></span>IsComputed()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool mxnet::Imperative::DCInfo::IsComputed </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> &amp;&#160;</td>
<td class="paramname"><em>arr</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">
</div>
</div>
<a id="a63550f72a12eb4d58f6d073f8b235b01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63550f72a12eb4d58f6d073f8b235b01">&#9670;&nbsp;</a></span>IsNone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool mxnet::Imperative::DCInfo::IsNone </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> &amp;&#160;</td>
<td class="paramname"><em>arr</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">
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="add286ab9a359eb017008c9a3ff53701f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add286ab9a359eb017008c9a3ff53701f">&#9670;&nbsp;</a></span>Imperative</h2>
<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_1Imperative.html">Imperative</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>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/work/mxnet/include/mxnet/<a class="el" href="imperative_8h_source.html">imperative.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>