blob: a322e3b2914ab02b3542c685ff33ebbcd4c418c0 [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.11"/>
<title>mxnet: mkldnn_eltwise_desc_t Struct 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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structmkldnn__eltwise__desc__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mkldnn_eltwise_desc_t Struct Reference<div class="ingroups"><a class="el" href="group__c__api.html">C API</a> &raquo; <a class="el" href="group__c__api__types.html">Types</a> &raquo; <a class="el" href="group__c__api__types__op__descs.html">Operation descriptors</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A descriptor of a element-wise operation.
<a href="structmkldnn__eltwise__desc__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="mkldnn__types_8h_source.html">mkldnn_types.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mkldnn_eltwise_desc_t:</div>
<div class="dyncontent">
<div class="center"><img src="structmkldnn__eltwise__desc__t__coll__graph.png" border="0" usemap="#mkldnn__eltwise__desc__t_coll__map" alt="Collaboration graph"/></div>
<map name="mkldnn__eltwise__desc__t_coll__map" id="mkldnn__eltwise__desc__t_coll__map">
<area shape="rect" id="node2" href="structmkldnn__memory__desc__t.html" title="{mkldnn_memory_desc_t\n|+ ndims\l+ dims\l+ data_type\l+ padded_dims\l+ padded_offsets\l+ offset0\l+ format_kind\l+ format_desc\l|}" alt="" coords="316,292,495,472"/>
<area shape="rect" id="node3" href="structmkldnn__memory__extra__desc__t.html" title="Description of extra information stored in memory. " alt="" coords="5,49,176,185"/>
<area shape="rect" id="node4" href="structmkldnn__rnn__packed__desc__t.html" title="Description of tensor of packed weights for rnn. " alt="" coords="201,13,399,222"/>
<area shape="rect" id="node5" href="structmkldnn__blocking__desc__t.html" title="{mkldnn_blocking_desc_t\n|+ strides\l+ inner_nblks\l+ inner_blks\l+ inner_idxs\l|}" alt="" coords="423,57,601,178"/>
<area shape="rect" id="node6" href="structmkldnn__wino__desc__t.html" title="Description of tensor of weights for winograd 2x3 convolution. " alt="" coords="625,5,778,229"/>
</map>
</div>
<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:a3e7911bcf624d442dd304d6b1689e138"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__types__generic.html#ga4f5c189c2ba9ef6444250299f1f8e973">mkldnn_primitive_kind_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__eltwise__desc__t.html#a3e7911bcf624d442dd304d6b1689e138">primitive_kind</a></td></tr>
<tr class="separator:a3e7911bcf624d442dd304d6b1689e138"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a907b3674ac5ee79b8427398e57c1bf15"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__types__generic.html#ga5b98c8059c2aff8861157bf070c3f520">mkldnn_prop_kind_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__eltwise__desc__t.html#a907b3674ac5ee79b8427398e57c1bf15">prop_kind</a></td></tr>
<tr class="separator:a907b3674ac5ee79b8427398e57c1bf15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cc3a589674fb7c80c4a37a61a01de74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__types__generic.html#gaa27d43cdd1e439cc41a9580d23ce3e97">mkldnn_alg_kind_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__eltwise__desc__t.html#a6cc3a589674fb7c80c4a37a61a01de74">alg_kind</a></td></tr>
<tr class="separator:a6cc3a589674fb7c80c4a37a61a01de74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a100ec7dcbd9cec02eeba8e9a3227998a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmkldnn__memory__desc__t.html">mkldnn_memory_desc_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__eltwise__desc__t.html#a100ec7dcbd9cec02eeba8e9a3227998a">data_desc</a></td></tr>
<tr class="memdesc:a100ec7dcbd9cec02eeba8e9a3227998a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Source and destination memory descriptor. <a href="#a100ec7dcbd9cec02eeba8e9a3227998a">More...</a><br /></td></tr>
<tr class="separator:a100ec7dcbd9cec02eeba8e9a3227998a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5640e3e25cb8449803088ee332fd35a6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmkldnn__memory__desc__t.html">mkldnn_memory_desc_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__eltwise__desc__t.html#a5640e3e25cb8449803088ee332fd35a6">diff_data_desc</a></td></tr>
<tr class="memdesc:a5640e3e25cb8449803088ee332fd35a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Source and destination gradient memory descriptor. <a href="#a5640e3e25cb8449803088ee332fd35a6">More...</a><br /></td></tr>
<tr class="separator:a5640e3e25cb8449803088ee332fd35a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae651978c5c026c832a037d876025192c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__eltwise__desc__t.html#ae651978c5c026c832a037d876025192c">alpha</a></td></tr>
<tr class="separator:ae651978c5c026c832a037d876025192c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee63a41cfaeb845f7d32b67a382dacc2"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__eltwise__desc__t.html#aee63a41cfaeb845f7d32b67a382dacc2">beta</a></td></tr>
<tr class="separator:aee63a41cfaeb845f7d32b67a382dacc2"><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 descriptor of a element-wise operation. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a6cc3a589674fb7c80c4a37a61a01de74"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__types__generic.html#gaa27d43cdd1e439cc41a9580d23ce3e97">mkldnn_alg_kind_t</a> mkldnn_eltwise_desc_t::alg_kind</td>
</tr>
</table>
</div><div class="memdoc">
<p>The kind of eltwise algorithm. Possible values: <a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97a66ead6848424f0b494e813745efb5548" title="Eltwise: ReLU. ">mkldnn_eltwise_relu</a>, <a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97a6b50624e847783bfc94b7cf6badfa16c" title="Eltwise: hyperbolic tangent non-linearity (tanh) ">mkldnn_eltwise_tanh</a>, <a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97a9d438b0d2d277674da5f54990e029015" title="Eltwise: parametric exponential linear unit (elu) ">mkldnn_eltwise_elu</a>, <a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97af4f3e47ddb2105e7c2ddf1bbd8434d02" title="Eltwise: square. ">mkldnn_eltwise_square</a>, <a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97acdc9ab2cd85eae9d8ad1fa11db97543e" title="Eltwise: abs. ">mkldnn_eltwise_abs</a>, <a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97aca916768654a670e8bfdb0cf41b8a1a7" title="Eltwise: square root. ">mkldnn_eltwise_sqrt</a>, <a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97a32f9fc43254ed1896e45cfcb6808d807" title="Eltwise: linear. ">mkldnn_eltwise_linear</a>, <a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97a7e86d17d0b611f2c80d299668d883bad" title="Eltwise: bounded_relu. ">mkldnn_eltwise_bounded_relu</a>, <a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97ac99f9e82b0c4c4583856664870469016" title="Eltwise: soft_relu. ">mkldnn_eltwise_soft_relu</a>, <a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97a4bd7b82c022d4cf43c474e5bf476cb24" title="Eltwise: logistic. ">mkldnn_eltwise_logistic</a> and <a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97a0edb1d73453a748b0b4e5fe705e8311e" title="Eltwise: exponent. ">mkldnn_eltwise_exp</a>. </p>
</div>
</div>
<a class="anchor" id="ae651978c5c026c832a037d876025192c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float mkldnn_eltwise_desc_t::alpha</td>
</tr>
</table>
</div><div class="memdoc">
<p>Algorithm specific parameter. Accordance table:</p><ul>
<li><a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97a66ead6848424f0b494e813745efb5548" title="Eltwise: ReLU. ">mkldnn_eltwise_relu</a>: <code>alpha</code> &ndash; negative slope, <code>beta</code> ignored</li>
<li><a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97a6b50624e847783bfc94b7cf6badfa16c" title="Eltwise: hyperbolic tangent non-linearity (tanh) ">mkldnn_eltwise_tanh</a>: <code>alpha</code> and <code>beta</code> ignored</li>
<li><a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97a9d438b0d2d277674da5f54990e029015" title="Eltwise: parametric exponential linear unit (elu) ">mkldnn_eltwise_elu</a>: <code>alpha</code> &ndash; negative slope, <code>beta</code> ignored</li>
<li><a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97af4f3e47ddb2105e7c2ddf1bbd8434d02" title="Eltwise: square. ">mkldnn_eltwise_square</a>: <code>alpha</code> and <code>beta</code> ignored</li>
<li><a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97acdc9ab2cd85eae9d8ad1fa11db97543e" title="Eltwise: abs. ">mkldnn_eltwise_abs</a>: <code>alpha</code> and <code>beta</code> ignored</li>
<li><a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97aca916768654a670e8bfdb0cf41b8a1a7" title="Eltwise: square root. ">mkldnn_eltwise_sqrt</a>: <code>alpha</code> and <code>beta</code> ignored</li>
<li><a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97a32f9fc43254ed1896e45cfcb6808d807" title="Eltwise: linear. ">mkldnn_eltwise_linear</a>: <code>alpha</code> &ndash; scale, <code>beta</code> &ndash; shift</li>
<li><a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97a7e86d17d0b611f2c80d299668d883bad" title="Eltwise: bounded_relu. ">mkldnn_eltwise_bounded_relu</a>: <code>alpha</code> &ndash; upper bound, <code>beta</code> ignored</li>
<li><a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97ac99f9e82b0c4c4583856664870469016" title="Eltwise: soft_relu. ">mkldnn_eltwise_soft_relu</a>: <code>alpha</code> and <code>beta</code> ignored</li>
<li><a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97a4bd7b82c022d4cf43c474e5bf476cb24" title="Eltwise: logistic. ">mkldnn_eltwise_logistic</a>: <code>alpha</code> and <code>beta</code> ignored</li>
<li><a class="el" href="group__c__api__types__generic.html#ggaa27d43cdd1e439cc41a9580d23ce3e97a0edb1d73453a748b0b4e5fe705e8311e" title="Eltwise: exponent. ">mkldnn_eltwise_exp</a>: <code>alpha</code> and <code>beta</code> ignored </li>
</ul>
</div>
</div>
<a class="anchor" id="aee63a41cfaeb845f7d32b67a382dacc2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float mkldnn_eltwise_desc_t::beta</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a100ec7dcbd9cec02eeba8e9a3227998a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmkldnn__memory__desc__t.html">mkldnn_memory_desc_t</a> mkldnn_eltwise_desc_t::data_desc</td>
</tr>
</table>
</div><div class="memdoc">
<p>Source and destination memory descriptor. </p>
</div>
</div>
<a class="anchor" id="a5640e3e25cb8449803088ee332fd35a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmkldnn__memory__desc__t.html">mkldnn_memory_desc_t</a> mkldnn_eltwise_desc_t::diff_data_desc</td>
</tr>
</table>
</div><div class="memdoc">
<p>Source and destination gradient memory descriptor. </p>
</div>
</div>
<a class="anchor" id="a3e7911bcf624d442dd304d6b1689e138"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__types__generic.html#ga4f5c189c2ba9ef6444250299f1f8e973">mkldnn_primitive_kind_t</a> mkldnn_eltwise_desc_t::primitive_kind</td>
</tr>
</table>
</div><div class="memdoc">
<p>The kind of primitive. Used for self-identifying the primitive descriptor. Must be <a class="el" href="group__c__api__types__generic.html#gga4f5c189c2ba9ef6444250299f1f8e973ae1cbd23f0addc5270d4f8ae63e0ecc7d" title="An element-wise primitive. ">mkldnn_eltwise</a>. </p>
</div>
</div>
<a class="anchor" id="a907b3674ac5ee79b8427398e57c1bf15"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__types__generic.html#ga5b98c8059c2aff8861157bf070c3f520">mkldnn_prop_kind_t</a> mkldnn_eltwise_desc_t::prop_kind</td>
</tr>
</table>
</div><div class="memdoc">
<p>The kind of propagation. Possible values: <a class="el" href="group__c__api__types__generic.html#gga5b98c8059c2aff8861157bf070c3f520a0bb8fb5a8f3ae67cf8d9c8d13667507f">mkldnn_forward_training</a>, <a class="el" href="group__c__api__types__generic.html#gga5b98c8059c2aff8861157bf070c3f520a58a923fb6c4e1214e1505b5fa0b1e3fa">mkldnn_forward_inference</a>, <a class="el" href="group__c__api__types__generic.html#gga5b98c8059c2aff8861157bf070c3f520a4dd1b6040ef9d067a38d8ffa407b763b" title="Backward propagation (with respect to all parameters). ">mkldnn_backward</a>, and <a class="el" href="group__c__api__types__generic.html#gga5b98c8059c2aff8861157bf070c3f520aefa8bd2da7ba52a0a0061cfab6cf3925" title="Backward data propagation. ">mkldnn_backward_data</a>. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/work/mxnet/include/mkldnn/<a class="el" href="mkldnn__types_8h_source.html">mkldnn_types.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Mar 28 2020 00:52:31 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>