blob: 8df344297aa5613b0f3ab976fad2a0b03743d725 [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: mshadow::expr::MaskExp&lt; IndexExp, SrcExp, DType &gt; Struct 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.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="namespacemshadow.html">mshadow</a></li><li class="navelem"><a class="el" href="namespacemshadow_1_1expr.html">expr</a></li><li class="navelem"><a class="el" href="structmshadow_1_1expr_1_1MaskExp.html">MaskExp</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="structmshadow_1_1expr_1_1MaskExp-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mshadow::expr::MaskExp&lt; IndexExp, SrcExp, DType &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Broadcast a mask and do element-wise multiplication.
<a href="structmshadow_1_1expr_1_1MaskExp.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="mask_8h_source.html">mask.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mshadow::expr::MaskExp&lt; IndexExp, SrcExp, DType &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structmshadow_1_1expr_1_1MaskExp__inherit__graph.png" border="0" usemap="#mshadow_1_1expr_1_1MaskExp_3_01IndexExp_00_01SrcExp_00_01DType_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="mshadow_1_1expr_1_1MaskExp_3_01IndexExp_00_01SrcExp_00_01DType_01_4_inherit__map" id="mshadow_1_1expr_1_1MaskExp_3_01IndexExp_00_01SrcExp_00_01DType_01_4_inherit__map">
<area shape="rect" id="node2" href="structmshadow_1_1expr_1_1Exp.html" title="{mshadow::expr::Exp\l\&lt; MaskExp\&lt; IndexExp,\l SrcExp, DType \&gt;, DType,\l type::kChainer \&gt;\n||+ self()\l+ ptrself()\l}" alt="" coords="19,5,204,141"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for mshadow::expr::MaskExp&lt; IndexExp, SrcExp, DType &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structmshadow_1_1expr_1_1MaskExp__coll__graph.png" border="0" usemap="#mshadow_1_1expr_1_1MaskExp_3_01IndexExp_00_01SrcExp_00_01DType_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="mshadow_1_1expr_1_1MaskExp_3_01IndexExp_00_01SrcExp_00_01DType_01_4_coll__map" id="mshadow_1_1expr_1_1MaskExp_3_01IndexExp_00_01SrcExp_00_01DType_01_4_coll__map">
<area shape="rect" id="node2" href="structmshadow_1_1expr_1_1Exp.html" title="{mshadow::expr::Exp\l\&lt; MaskExp\&lt; IndexExp,\l SrcExp, DType \&gt;, DType,\l type::kChainer \&gt;\n||+ self()\l+ ptrself()\l}" alt="" coords="19,5,204,141"/>
</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:ac8379075a4bc7852652adaa1b1ee0b66"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1expr_1_1MaskExp.html#ac8379075a4bc7852652adaa1b1ee0b66">MaskExp</a> (const IndexExp &amp;index, const SrcExp &amp;src)</td></tr>
<tr class="separator:ac8379075a4bc7852652adaa1b1ee0b66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structmshadow_1_1expr_1_1Exp"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structmshadow_1_1expr_1_1Exp')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structmshadow_1_1expr_1_1Exp.html">mshadow::expr::Exp&lt; MaskExp&lt; IndexExp, SrcExp, DType &gt;, DType, type::kChainer &gt;</a></td></tr>
<tr class="memitem:adb7e4afd0baed78d66cff87de0a6621f inherit pub_methods_structmshadow_1_1expr_1_1Exp"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structmshadow_1_1expr_1_1MaskExp.html">MaskExp</a>&lt; IndexExp, SrcExp, DType &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1expr_1_1Exp.html#adb7e4afd0baed78d66cff87de0a6621f">self</a> (void) const</td></tr>
<tr class="separator:adb7e4afd0baed78d66cff87de0a6621f inherit pub_methods_structmshadow_1_1expr_1_1Exp"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6f23b53ba2fc3c2b594cf2ddfba5b22 inherit pub_methods_structmshadow_1_1expr_1_1Exp"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmshadow_1_1expr_1_1MaskExp.html">MaskExp</a>&lt; IndexExp, SrcExp, DType &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1expr_1_1Exp.html#ad6f23b53ba2fc3c2b594cf2ddfba5b22">ptrself</a> (void)</td></tr>
<tr class="separator:ad6f23b53ba2fc3c2b594cf2ddfba5b22 inherit pub_methods_structmshadow_1_1expr_1_1Exp"><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:af50eeecb9a62e5ab9f0053ff2d7511ad"><td class="memItemLeft" align="right" valign="top">const IndexExp &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1expr_1_1MaskExp.html#af50eeecb9a62e5ab9f0053ff2d7511ad">index_</a></td></tr>
<tr class="memdesc:af50eeecb9a62e5ab9f0053ff2d7511ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">index oprand <a href="#af50eeecb9a62e5ab9f0053ff2d7511ad">More...</a><br /></td></tr>
<tr class="separator:af50eeecb9a62e5ab9f0053ff2d7511ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af37a8682bdc3194ef1bb20603dc3f730"><td class="memItemLeft" align="right" valign="top">const SrcExp &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1expr_1_1MaskExp.html#af37a8682bdc3194ef1bb20603dc3f730">src_</a></td></tr>
<tr class="memdesc:af37a8682bdc3194ef1bb20603dc3f730"><td class="mdescLeft">&#160;</td><td class="mdescRight">matrix oprand <a href="#af37a8682bdc3194ef1bb20603dc3f730">More...</a><br /></td></tr>
<tr class="separator:af37a8682bdc3194ef1bb20603dc3f730"><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 IndexExp, typename SrcExp, typename DType&gt;<br />
struct mshadow::expr::MaskExp&lt; IndexExp, SrcExp, DType &gt;</h3>
<p>Broadcast a mask and do element-wise multiplication. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">IndexExp</td><td>type of index expression </td></tr>
<tr><td class="paramname">SrcExp</td><td>type of src expression </td></tr>
<tr><td class="paramname">DType</td><td>data type </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac8379075a4bc7852652adaa1b1ee0b66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8379075a4bc7852652adaa1b1ee0b66">&#9670;&nbsp;</a></span>MaskExp()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename IndexExp, typename SrcExp, typename DType&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmshadow_1_1expr_1_1MaskExp.html">mshadow::expr::MaskExp</a>&lt; IndexExp, SrcExp, DType &gt;::<a class="el" href="structmshadow_1_1expr_1_1MaskExp.html">MaskExp</a> </td>
<td>(</td>
<td class="paramtype">const IndexExp &amp;&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const SrcExp &amp;&#160;</td>
<td class="paramname"><em>src</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">
<p>constructor </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af50eeecb9a62e5ab9f0053ff2d7511ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af50eeecb9a62e5ab9f0053ff2d7511ad">&#9670;&nbsp;</a></span>index_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename IndexExp, typename SrcExp, typename DType&gt; </div>
<table class="memname">
<tr>
<td class="memname">const IndexExp&amp; <a class="el" href="structmshadow_1_1expr_1_1MaskExp.html">mshadow::expr::MaskExp</a>&lt; IndexExp, SrcExp, DType &gt;::index_</td>
</tr>
</table>
</div><div class="memdoc">
<p>index oprand </p>
</div>
</div>
<a id="af37a8682bdc3194ef1bb20603dc3f730"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af37a8682bdc3194ef1bb20603dc3f730">&#9670;&nbsp;</a></span>src_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename IndexExp, typename SrcExp, typename DType&gt; </div>
<table class="memname">
<tr>
<td class="memname">const SrcExp&amp; <a class="el" href="structmshadow_1_1expr_1_1MaskExp.html">mshadow::expr::MaskExp</a>&lt; IndexExp, SrcExp, DType &gt;::src_</td>
</tr>
</table>
</div><div class="memdoc">
<p>matrix oprand </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/work/mxnet/3rdparty/mshadow/mshadow/extension/<a class="el" href="mask_8h_source.html">mask.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:43 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>