blob: fd7120e7da4a5f064111f0d1a0879533653e5a17 [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::cpp::Operator 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="namespacemxnet_1_1cpp.html">cpp</a></li><li class="navelem"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classmxnet_1_1cpp_1_1Operator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::cpp::Operator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classmxnet_1_1cpp_1_1Operator.html" title="Operator interface.">Operator</a> interface.
<a href="classmxnet_1_1cpp_1_1Operator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="cpp-package_2include_2mxnet-cpp_2operator_8h_source.html">operator.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::cpp::Operator:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1cpp_1_1Operator__coll__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1Operator_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:ae6321f03d02b6d076d4154d353b1c4a5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#ae6321f03d02b6d076d4154d353b1c4a5">Operator</a> (const std::string &amp;operator_name)</td></tr>
<tr class="memdesc:ae6321f03d02b6d076d4154d353b1c4a5"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html" title="Operator interface.">Operator</a> constructor. <a href="classmxnet_1_1cpp_1_1Operator.html#ae6321f03d02b6d076d4154d353b1c4a5">More...</a><br /></td></tr>
<tr class="separator:ae6321f03d02b6d076d4154d353b1c4a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0057800586b01402bd99ae62e5614ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#ae0057800586b01402bd99ae62e5614ef">operator=</a> (const <a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;rhs)</td></tr>
<tr class="separator:ae0057800586b01402bd99ae62e5614ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72e6940d1b4be12bbbba0bccc00ef739"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a72e6940d1b4be12bbbba0bccc00ef739"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#a72e6940d1b4be12bbbba0bccc00ef739">SetParam</a> (const std::string &amp;name, const T &amp;value)</td></tr>
<tr class="memdesc:a72e6940d1b4be12bbbba0bccc00ef739"><td class="mdescLeft">&#160;</td><td class="mdescRight">set config parameters <a href="classmxnet_1_1cpp_1_1Operator.html#a72e6940d1b4be12bbbba0bccc00ef739">More...</a><br /></td></tr>
<tr class="separator:a72e6940d1b4be12bbbba0bccc00ef739"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a280201370ff22876cb38afbe47861f42"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a280201370ff22876cb38afbe47861f42"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#a280201370ff22876cb38afbe47861f42">SetParam</a> (int pos, const T &amp;value)</td></tr>
<tr class="memdesc:a280201370ff22876cb38afbe47861f42"><td class="mdescLeft">&#160;</td><td class="mdescRight">set config parameters from positional inputs <a href="classmxnet_1_1cpp_1_1Operator.html#a280201370ff22876cb38afbe47861f42">More...</a><br /></td></tr>
<tr class="separator:a280201370ff22876cb38afbe47861f42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb1cbbf2fba12676de09dcb64f486464"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#afb1cbbf2fba12676de09dcb64f486464">SetInput</a> (const std::string &amp;name, const <a class="el" href="classmxnet_1_1cpp_1_1Symbol.html">Symbol</a> &amp;symbol)</td></tr>
<tr class="memdesc:afb1cbbf2fba12676de09dcb64f486464"><td class="mdescLeft">&#160;</td><td class="mdescRight">add an input symbol <a href="classmxnet_1_1cpp_1_1Operator.html#afb1cbbf2fba12676de09dcb64f486464">More...</a><br /></td></tr>
<tr class="separator:afb1cbbf2fba12676de09dcb64f486464"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33b42e657f9a15ab4004b3b8226d71c6"><td class="memTemplParams" colspan="2">template&lt;int N = 0&gt; </td></tr>
<tr class="memitem:a33b42e657f9a15ab4004b3b8226d71c6"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#a33b42e657f9a15ab4004b3b8226d71c6">PushInput</a> (const <a class="el" href="classmxnet_1_1cpp_1_1Symbol.html">Symbol</a> &amp;symbol)</td></tr>
<tr class="memdesc:a33b42e657f9a15ab4004b3b8226d71c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">add an input symbol <a href="classmxnet_1_1cpp_1_1Operator.html#a33b42e657f9a15ab4004b3b8226d71c6">More...</a><br /></td></tr>
<tr class="separator:a33b42e657f9a15ab4004b3b8226d71c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3c8a454dd7e27358d29f94f17713f18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#ac3c8a454dd7e27358d29f94f17713f18">operator()</a> ()</td></tr>
<tr class="memdesc:ac3c8a454dd7e27358d29f94f17713f18"><td class="mdescLeft">&#160;</td><td class="mdescRight">add input symbols <a href="classmxnet_1_1cpp_1_1Operator.html#ac3c8a454dd7e27358d29f94f17713f18">More...</a><br /></td></tr>
<tr class="separator:ac3c8a454dd7e27358d29f94f17713f18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a453b9eee13ca4e8acd3408de03aeafbe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#a453b9eee13ca4e8acd3408de03aeafbe">operator()</a> (const <a class="el" href="classmxnet_1_1cpp_1_1Symbol.html">Symbol</a> &amp;symbol)</td></tr>
<tr class="memdesc:a453b9eee13ca4e8acd3408de03aeafbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">add input symbols <a href="classmxnet_1_1cpp_1_1Operator.html#a453b9eee13ca4e8acd3408de03aeafbe">More...</a><br /></td></tr>
<tr class="separator:a453b9eee13ca4e8acd3408de03aeafbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6911a78584ab48e8f2e808552e678992"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#a6911a78584ab48e8f2e808552e678992">operator()</a> (const std::vector&lt; <a class="el" href="classmxnet_1_1cpp_1_1Symbol.html">Symbol</a> &gt; &amp;symbols)</td></tr>
<tr class="memdesc:a6911a78584ab48e8f2e808552e678992"><td class="mdescLeft">&#160;</td><td class="mdescRight">add a list of input symbols <a href="classmxnet_1_1cpp_1_1Operator.html#a6911a78584ab48e8f2e808552e678992">More...</a><br /></td></tr>
<tr class="separator:a6911a78584ab48e8f2e808552e678992"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52943207a5d771a32f7e1a861e34d0e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Symbol.html">Symbol</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#a52943207a5d771a32f7e1a861e34d0e3">CreateSymbol</a> (const std::string &amp;name=&quot;&quot;)</td></tr>
<tr class="memdesc:a52943207a5d771a32f7e1a861e34d0e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">create a <a class="el" href="classmxnet_1_1cpp_1_1Symbol.html" title="Symbol interface.">Symbol</a> from the current operator <a href="classmxnet_1_1cpp_1_1Operator.html#a52943207a5d771a32f7e1a861e34d0e3">More...</a><br /></td></tr>
<tr class="separator:a52943207a5d771a32f7e1a861e34d0e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1669adefc7e65c1c159a3a604d833474"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#a1669adefc7e65c1c159a3a604d833474">SetInput</a> (const std::string &amp;name, const <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> &amp;ndarray)</td></tr>
<tr class="memdesc:a1669adefc7e65c1c159a3a604d833474"><td class="mdescLeft">&#160;</td><td class="mdescRight">add an input ndarray <a href="classmxnet_1_1cpp_1_1Operator.html#a1669adefc7e65c1c159a3a604d833474">More...</a><br /></td></tr>
<tr class="separator:a1669adefc7e65c1c159a3a604d833474"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf21af976feee8c84632c6810632acdb"><td class="memTemplParams" colspan="2">template&lt;int N = 0&gt; </td></tr>
<tr class="memitem:acf21af976feee8c84632c6810632acdb"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#acf21af976feee8c84632c6810632acdb">PushInput</a> (const <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> &amp;ndarray)</td></tr>
<tr class="memdesc:acf21af976feee8c84632c6810632acdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">add an input ndarray <a href="classmxnet_1_1cpp_1_1Operator.html#acf21af976feee8c84632c6810632acdb">More...</a><br /></td></tr>
<tr class="separator:acf21af976feee8c84632c6810632acdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a537e8d915b101757819a7a01da956a6b"><td class="memTemplParams" colspan="2">template&lt;class T , class... Args, int N = 0&gt; </td></tr>
<tr class="memitem:a537e8d915b101757819a7a01da956a6b"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#a537e8d915b101757819a7a01da956a6b">PushInput</a> (const T &amp;t, Args... args)</td></tr>
<tr class="memdesc:a537e8d915b101757819a7a01da956a6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">add positional inputs <a href="classmxnet_1_1cpp_1_1Operator.html#a537e8d915b101757819a7a01da956a6b">More...</a><br /></td></tr>
<tr class="separator:a537e8d915b101757819a7a01da956a6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc7e1d919209cf861991bd41a0bc803f"><td class="memTemplParams" colspan="2">template&lt;class T , int N = 0&gt; </td></tr>
<tr class="memitem:afc7e1d919209cf861991bd41a0bc803f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#afc7e1d919209cf861991bd41a0bc803f">PushInput</a> (const T &amp;t)</td></tr>
<tr class="memdesc:afc7e1d919209cf861991bd41a0bc803f"><td class="mdescLeft">&#160;</td><td class="mdescRight">add the last positional input <a href="classmxnet_1_1cpp_1_1Operator.html#afc7e1d919209cf861991bd41a0bc803f">More...</a><br /></td></tr>
<tr class="separator:afc7e1d919209cf861991bd41a0bc803f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3116bcf3f735d37cd31a7916a5907b96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#a3116bcf3f735d37cd31a7916a5907b96">operator()</a> (const <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> &amp;ndarray)</td></tr>
<tr class="memdesc:a3116bcf3f735d37cd31a7916a5907b96"><td class="mdescLeft">&#160;</td><td class="mdescRight">add input ndarrays <a href="classmxnet_1_1cpp_1_1Operator.html#a3116bcf3f735d37cd31a7916a5907b96">More...</a><br /></td></tr>
<tr class="separator:a3116bcf3f735d37cd31a7916a5907b96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a899126f9fb43626fa8a11d36add58038"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#a899126f9fb43626fa8a11d36add58038">operator()</a> (const std::vector&lt; <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> &gt; &amp;ndarrays)</td></tr>
<tr class="memdesc:a899126f9fb43626fa8a11d36add58038"><td class="mdescLeft">&#160;</td><td class="mdescRight">add a list of input ndarrays <a href="classmxnet_1_1cpp_1_1Operator.html#a899126f9fb43626fa8a11d36add58038">More...</a><br /></td></tr>
<tr class="separator:a899126f9fb43626fa8a11d36add58038"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acfe0ed742dffdd849165081f444387f3"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:acfe0ed742dffdd849165081f444387f3"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#acfe0ed742dffdd849165081f444387f3">operator()</a> (Args... args)</td></tr>
<tr class="memdesc:acfe0ed742dffdd849165081f444387f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">add input ndarrays <a href="classmxnet_1_1cpp_1_1Operator.html#acfe0ed742dffdd849165081f444387f3">More...</a><br /></td></tr>
<tr class="separator:acfe0ed742dffdd849165081f444387f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb488664e59eff22f62f28660fde54d1"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#abb488664e59eff22f62f28660fde54d1">Invoke</a> ()</td></tr>
<tr class="separator:abb488664e59eff22f62f28660fde54d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63438fea690f898dc1e3d058281a181a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#a63438fea690f898dc1e3d058281a181a">Invoke</a> (<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> &amp;output)</td></tr>
<tr class="separator:a63438fea690f898dc1e3d058281a181a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85c1b1e99bb50bbbe0bd70e102b586d3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html#a85c1b1e99bb50bbbe0bd70e102b586d3">Invoke</a> (std::vector&lt; <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> &gt; &amp;outputs)</td></tr>
<tr class="separator:a85c1b1e99bb50bbbe0bd70e102b586d3"><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_1cpp_1_1Operator.html" title="Operator interface.">Operator</a> interface. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae6321f03d02b6d076d4154d353b1c4a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6321f03d02b6d076d4154d353b1c4a5">&#9670;&nbsp;</a></span>Operator()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::cpp::Operator::Operator </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>operator_name</em></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">
<p><a class="el" href="classmxnet_1_1cpp_1_1Operator.html" title="Operator interface.">Operator</a> constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">operator_name</td><td>type of the operator </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a52943207a5d771a32f7e1a861e34d0e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52943207a5d771a32f7e1a861e34d0e3">&#9670;&nbsp;</a></span>CreateSymbol()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Symbol.html">Symbol</a> mxnet::cpp::Operator::CreateSymbol </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em> = <code>&quot;&quot;</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>create a <a class="el" href="classmxnet_1_1cpp_1_1Symbol.html" title="Symbol interface.">Symbol</a> from the current operator </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>the name of the operator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the operator <a class="el" href="classmxnet_1_1cpp_1_1Symbol.html" title="Symbol interface.">Symbol</a> </dd></dl>
</div>
</div>
<a id="abb488664e59eff22f62f28660fde54d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb488664e59eff22f62f28660fde54d1">&#9670;&nbsp;</a></span>Invoke() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a>&gt; mxnet::cpp::Operator::Invoke </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a63438fea690f898dc1e3d058281a181a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63438fea690f898dc1e3d058281a181a">&#9670;&nbsp;</a></span>Invoke() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mxnet::cpp::Operator::Invoke </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> &amp;&#160;</td>
<td class="paramname"><em>output</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a85c1b1e99bb50bbbe0bd70e102b586d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85c1b1e99bb50bbbe0bd70e102b586d3">&#9670;&nbsp;</a></span>Invoke() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mxnet::cpp::Operator::Invoke </td>
<td>(</td>
<td class="paramtype">std::vector&lt; <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>outputs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac3c8a454dd7e27358d29f94f17713f18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3c8a454dd7e27358d29f94f17713f18">&#9670;&nbsp;</a></span>operator()() <span class="overload">[1/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a>&amp; mxnet::cpp::Operator::operator() </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>add input symbols </p>
<dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl>
</div>
</div>
<a id="acfe0ed742dffdd849165081f444387f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acfe0ed742dffdd849165081f444387f3">&#9670;&nbsp;</a></span>operator()() <span class="overload">[2/6]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a>&amp; mxnet::cpp::Operator::operator() </td>
<td>(</td>
<td class="paramtype">Args...&#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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>add input ndarrays </p>
<dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl>
</div>
</div>
<a id="a3116bcf3f735d37cd31a7916a5907b96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3116bcf3f735d37cd31a7916a5907b96">&#9670;&nbsp;</a></span>operator()() <span class="overload">[3/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a>&amp; mxnet::cpp::Operator::operator() </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> &amp;&#160;</td>
<td class="paramname"><em>ndarray</em></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>add input ndarrays </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ndarray</td><td>the input ndarray </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl>
</div>
</div>
<a id="a899126f9fb43626fa8a11d36add58038"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a899126f9fb43626fa8a11d36add58038">&#9670;&nbsp;</a></span>operator()() <span class="overload">[4/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a>&amp; mxnet::cpp::Operator::operator() </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>ndarrays</em></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>add a list of input ndarrays </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ndarrays</td><td>the vector of the input ndarrays </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl>
</div>
</div>
<a id="a6911a78584ab48e8f2e808552e678992"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6911a78584ab48e8f2e808552e678992">&#9670;&nbsp;</a></span>operator()() <span class="overload">[5/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a>&amp; mxnet::cpp::Operator::operator() </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; <a class="el" href="classmxnet_1_1cpp_1_1Symbol.html">Symbol</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>symbols</em></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>add a list of input symbols </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbols</td><td>the vector of the input symbols </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl>
</div>
</div>
<a id="a453b9eee13ca4e8acd3408de03aeafbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a453b9eee13ca4e8acd3408de03aeafbe">&#9670;&nbsp;</a></span>operator()() <span class="overload">[6/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a>&amp; mxnet::cpp::Operator::operator() </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1cpp_1_1Symbol.html">Symbol</a> &amp;&#160;</td>
<td class="paramname"><em>symbol</em></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>add input symbols </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>the input symbol </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl>
</div>
</div>
<a id="ae0057800586b01402bd99ae62e5614ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0057800586b01402bd99ae62e5614ef">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a>&amp; mxnet::cpp::Operator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acf21af976feee8c84632c6810632acdb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf21af976feee8c84632c6810632acdb">&#9670;&nbsp;</a></span>PushInput() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int N = 0&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a>&amp; mxnet::cpp::Operator::PushInput </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> &amp;&#160;</td>
<td class="paramname"><em>ndarray</em></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>add an input ndarray </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ndarray</td><td>the input ndarray </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a33b42e657f9a15ab4004b3b8226d71c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33b42e657f9a15ab4004b3b8226d71c6">&#9670;&nbsp;</a></span>PushInput() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int N = 0&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void mxnet::cpp::Operator::PushInput </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1cpp_1_1Symbol.html">Symbol</a> &amp;&#160;</td>
<td class="paramname"><em>symbol</em></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>add an input symbol </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>the input symbol </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afc7e1d919209cf861991bd41a0bc803f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc7e1d919209cf861991bd41a0bc803f">&#9670;&nbsp;</a></span>PushInput() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , int N = 0&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a>&amp; mxnet::cpp::Operator::PushInput </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>t</em></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>add the last positional input </p>
</div>
</div>
<a id="a537e8d915b101757819a7a01da956a6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a537e8d915b101757819a7a01da956a6b">&#9670;&nbsp;</a></span>PushInput() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class... Args, int N = 0&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a>&amp; mxnet::cpp::Operator::PushInput </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Args...&#160;</td>
<td class="paramname"><em>args</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>add positional inputs </p>
</div>
</div>
<a id="a1669adefc7e65c1c159a3a604d833474"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1669adefc7e65c1c159a3a604d833474">&#9670;&nbsp;</a></span>SetInput() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a>&amp; mxnet::cpp::Operator::SetInput </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> &amp;&#160;</td>
<td class="paramname"><em>ndarray</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>add an input ndarray </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>name of the input ndarray </td></tr>
<tr><td class="paramname">ndarray</td><td>the input ndarray </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl>
</div>
</div>
<a id="afb1cbbf2fba12676de09dcb64f486464"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb1cbbf2fba12676de09dcb64f486464">&#9670;&nbsp;</a></span>SetInput() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a>&amp; mxnet::cpp::Operator::SetInput </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1cpp_1_1Symbol.html">Symbol</a> &amp;&#160;</td>
<td class="paramname"><em>symbol</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>add an input symbol </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>name of the input symbol </td></tr>
<tr><td class="paramname">symbol</td><td>the input symbol </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl>
</div>
</div>
<a id="a72e6940d1b4be12bbbba0bccc00ef739"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72e6940d1b4be12bbbba0bccc00ef739">&#9670;&nbsp;</a></span>SetParam() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a>&amp; mxnet::cpp::Operator::SetParam </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>value</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>set config parameters </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>name of the config parameter </td></tr>
<tr><td class="paramname">value</td><td>value of the config parameter </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl>
</div>
</div>
<a id="a280201370ff22876cb38afbe47861f42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a280201370ff22876cb38afbe47861f42">&#9670;&nbsp;</a></span>SetParam() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Operator.html">Operator</a>&amp; mxnet::cpp::Operator::SetParam </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>value</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>set config parameters from positional inputs </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pos</td><td>the position of parameter </td></tr>
<tr><td class="paramname">value</td><td>value of the config parameter </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/work/mxnet/cpp-package/include/mxnet-cpp/<a class="el" href="cpp-package_2include_2mxnet-cpp_2operator_8h_source.html">operator.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>