blob: 1f30020f47b722ff5e218f9a691d1d06cf1d3a53 [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::OpMap&lt; ValueType &gt; Class Template 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_1OpMap.html">OpMap</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classnnvm_1_1OpMap-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">nnvm::OpMap&lt; ValueType &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A map data structure that takes Op* as key and returns ValueType.
<a href="classnnvm_1_1OpMap.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="op_8h_source.html">op.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for nnvm::OpMap&lt; ValueType &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classnnvm_1_1OpMap__coll__graph.png" border="0" usemap="#nnvm_1_1OpMap_3_01ValueType_01_4_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:a8d2b7f1f25f7905d6d442297d76f4bee"><td class="memItemLeft" align="right" valign="top">const ValueType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1OpMap.html#a8d2b7f1f25f7905d6d442297d76f4bee">operator[]</a> (const <a class="el" href="classnnvm_1_1Op.html">Op</a> *op) const</td></tr>
<tr class="memdesc:a8d2b7f1f25f7905d6d442297d76f4bee"><td class="mdescLeft">&#160;</td><td class="mdescRight">get the corresponding value element at op <a href="classnnvm_1_1OpMap.html#a8d2b7f1f25f7905d6d442297d76f4bee">More...</a><br /></td></tr>
<tr class="separator:a8d2b7f1f25f7905d6d442297d76f4bee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74aecc7ed4873b2a3012e0a9673dd2bc"><td class="memItemLeft" align="right" valign="top">const ValueType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1OpMap.html#a74aecc7ed4873b2a3012e0a9673dd2bc">get</a> (const <a class="el" href="classnnvm_1_1Op.html">Op</a> *op, const ValueType &amp;def_value) const</td></tr>
<tr class="memdesc:a74aecc7ed4873b2a3012e0a9673dd2bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">get the corresponding value element at op with default value. <a href="classnnvm_1_1OpMap.html#a74aecc7ed4873b2a3012e0a9673dd2bc">More...</a><br /></td></tr>
<tr class="separator:a74aecc7ed4873b2a3012e0a9673dd2bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6a63fc055c4cfdb9520c64e08cce073"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1OpMap.html#ac6a63fc055c4cfdb9520c64e08cce073">count</a> (const <a class="el" href="classnnvm_1_1Op.html">Op</a> *op) const</td></tr>
<tr class="memdesc:ac6a63fc055c4cfdb9520c64e08cce073"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the map has op as key. <a href="classnnvm_1_1OpMap.html#ac6a63fc055c4cfdb9520c64e08cce073">More...</a><br /></td></tr>
<tr class="separator:ac6a63fc055c4cfdb9520c64e08cce073"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28dd027285b5dbba7a813307993712b2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1OpMap.html#a28dd027285b5dbba7a813307993712b2">contains</a> (const <a class="el" href="classnnvm_1_1Op.html">Op</a> *op) const</td></tr>
<tr class="memdesc:a28dd027285b5dbba7a813307993712b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the map has op as key. <a href="classnnvm_1_1OpMap.html#a28dd027285b5dbba7a813307993712b2">More...</a><br /></td></tr>
<tr class="separator:a28dd027285b5dbba7a813307993712b2"><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:a2c31e8a3c11caeb061d69db14ebb0e95"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnnvm_1_1OpMap.html#a2c31e8a3c11caeb061d69db14ebb0e95">Op</a></td></tr>
<tr class="memdesc:a2c31e8a3c11caeb061d69db14ebb0e95"><td class="mdescLeft">&#160;</td><td class="mdescRight">operator structure from NNVM <a href="classnnvm_1_1OpMap.html#a2c31e8a3c11caeb061d69db14ebb0e95">More...</a><br /></td></tr>
<tr class="separator:a2c31e8a3c11caeb061d69db14ebb0e95"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename ValueType&gt;<br />
class nnvm::OpMap&lt; ValueType &gt;</h3>
<p>A map data structure that takes Op* as key and returns ValueType. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">ValueType</td><td>The type of the value stored in map. </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a28dd027285b5dbba7a813307993712b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28dd027285b5dbba7a813307993712b2">&#9670;&nbsp;</a></span>contains()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classnnvm_1_1OpMap.html">nnvm::OpMap</a>&lt; ValueType &gt;::contains </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><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>Check if the map has op as key. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">op</td><td>The key to the map </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if op is contained in map, false otherwise. </dd></dl>
</div>
</div>
<a id="ac6a63fc055c4cfdb9520c64e08cce073"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6a63fc055c4cfdb9520c64e08cce073">&#9670;&nbsp;</a></span>count()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classnnvm_1_1OpMap.html">nnvm::OpMap</a>&lt; ValueType &gt;::count </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><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>Check if the map has op as key. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">op</td><td>The key to the map </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if op is contained in map, 0 otherwise. </dd></dl>
</div>
</div>
<a id="a74aecc7ed4873b2a3012e0a9673dd2bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74aecc7ed4873b2a3012e0a9673dd2bc">&#9670;&nbsp;</a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const ValueType &amp; <a class="el" href="classnnvm_1_1OpMap.html">nnvm::OpMap</a>&lt; ValueType &gt;::get </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 ValueType &amp;&#160;</td>
<td class="paramname"><em>def_value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>get the corresponding value element at op with default value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">op</td><td>The key to the map </td></tr>
<tr><td class="paramname">def_value</td><td>The default value when the key does not exist. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the const reference to the content value. </dd></dl>
</div>
</div>
<a id="a8d2b7f1f25f7905d6d442297d76f4bee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d2b7f1f25f7905d6d442297d76f4bee">&#9670;&nbsp;</a></span>operator[]()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const ValueType &amp; <a class="el" href="classnnvm_1_1OpMap.html">nnvm::OpMap</a>&lt; ValueType &gt;::operator[] </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><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>get the corresponding value element at op </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">op</td><td>The key to the map </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the const reference to the content value. </dd></dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a2c31e8a3c11caeb061d69db14ebb0e95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c31e8a3c11caeb061d69db14ebb0e95">&#9670;&nbsp;</a></span>Op</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classnnvm_1_1Op.html">Op</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">
<p>operator structure from NNVM </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="op_8h_source.html">op.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>