blob: 6032eacb64444ef8e84ebb7ac9a0f27d61abaca2 [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: Operation descriptors</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 class="current"><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><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><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">Operation descriptors<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></div></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Operation descriptors:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__c__api__types__op__descs.png" border="0" alt="" usemap="#group____c____api____types____op____descs"/>
<map name="group____c____api____types____op____descs" id="group____c____api____types____op____descs">
<area shape="rect" id="node2" href="group__c__api__types.html" title="Types" alt="" coords="5,5,63,32"/>
</map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__convolution__desc__t.html">mkldnn_convolution_desc_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A descriptor of a convolution operation. <a href="structmkldnn__convolution__desc__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__shuffle__desc__t.html">mkldnn_shuffle_desc_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A descriptor of a shuffle operation. <a href="structmkldnn__shuffle__desc__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__eltwise__desc__t.html">mkldnn_eltwise_desc_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A descriptor of a element-wise operation. <a href="structmkldnn__eltwise__desc__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__softmax__desc__t.html">mkldnn_softmax_desc_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A descriptor of a Softmax operation. <a href="structmkldnn__softmax__desc__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__pooling__desc__t.html">mkldnn_pooling_desc_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A descriptor of a pooling operation. <a href="structmkldnn__pooling__desc__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__lrn__desc__t.html">mkldnn_lrn_desc_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A descriptor of a Local Response Normalization (LRN) operation. <a href="structmkldnn__lrn__desc__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__batch__normalization__desc__t.html">mkldnn_batch_normalization_desc_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A descriptor of a Batch Normalization operation. <a href="structmkldnn__batch__normalization__desc__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__inner__product__desc__t.html">mkldnn_inner_product_desc_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A descriptor of an inner product operation. <a href="structmkldnn__inner__product__desc__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmkldnn__rnn__desc__t.html">mkldnn_rnn_desc_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A descriptor for an RNN operation. <a href="structmkldnn__rnn__desc__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga6ed0f70ed4c6398c24a62b49cf8d538c"><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__types__op__descs.html#ga6ed0f70ed4c6398c24a62b49cf8d538c">mkldnn_op_desc_t</a></td></tr>
<tr class="memdesc:ga6ed0f70ed4c6398c24a62b49cf8d538c"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pointer to any of the operation descriptors. <a href="#ga6ed0f70ed4c6398c24a62b49cf8d538c">More...</a><br /></td></tr>
<tr class="separator:ga6ed0f70ed4c6398c24a62b49cf8d538c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac7e49603b052255540a6f6dc072a627c"><td class="memItemLeft" align="right" valign="top">typedef const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__types__op__descs.html#gac7e49603b052255540a6f6dc072a627c">const_mkldnn_op_desc_t</a></td></tr>
<tr class="memdesc:gac7e49603b052255540a6f6dc072a627c"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pointer to any of the operation descriptors (constant variant). <a href="#gac7e49603b052255540a6f6dc072a627c">More...</a><br /></td></tr>
<tr class="separator:gac7e49603b052255540a6f6dc072a627c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga22892e72c09157377e6d0358273025a3"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structmkldnn__convolution__desc__t.html">mkldnn_convolution_desc_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__types__op__descs.html#ga22892e72c09157377e6d0358273025a3">mkldnn_deconvolution_desc_t</a></td></tr>
<tr class="memdesc:ga22892e72c09157377e6d0358273025a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">A descriptor of a deconvolution operation. <a href="#ga22892e72c09157377e6d0358273025a3">More...</a><br /></td></tr>
<tr class="separator:ga22892e72c09157377e6d0358273025a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gaee216bdaa31e58c0529d1e8314763d6d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__types__op__descs.html#gaee216bdaa31e58c0529d1e8314763d6d">mkldnn_rnn_flags_t</a> { <a class="el" href="group__c__api__types__op__descs.html#ggaee216bdaa31e58c0529d1e8314763d6da7e69d2e0ccebe8ef3d3616dd603ba57f">mkldnn_rnn_flags_undef</a> = 0x0
}<tr class="memdesc:gaee216bdaa31e58c0529d1e8314763d6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags for RNN cell. <a href="group__c__api__types__op__descs.html#gaee216bdaa31e58c0529d1e8314763d6d">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:gaee216bdaa31e58c0529d1e8314763d6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3cb09316c36bd985698e0eea542cb424"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__types__op__descs.html#ga3cb09316c36bd985698e0eea542cb424">mkldnn_rnn_direction_t</a> { <br />
&#160;&#160;<a class="el" href="group__c__api__types__op__descs.html#gga3cb09316c36bd985698e0eea542cb424a704a37978225c8c03f673e34fb3dc89f">mkldnn_unidirectional_left2right</a>,
<a class="el" href="group__c__api__types__op__descs.html#gga3cb09316c36bd985698e0eea542cb424a594d74774460029d0635daaf4a7bace7">mkldnn_unidirectional_right2left</a>,
<a class="el" href="group__c__api__types__op__descs.html#gga3cb09316c36bd985698e0eea542cb424a29eacee8606bd282bc82396590c29590">mkldnn_bidirectional_concat</a>,
<a class="el" href="group__c__api__types__op__descs.html#gga3cb09316c36bd985698e0eea542cb424a41da7196bf8914d34a35ce7c1122e9bc">mkldnn_bidirectional_sum</a>,
<br />
&#160;&#160;<a class="el" href="group__c__api__types__op__descs.html#gga3cb09316c36bd985698e0eea542cb424a8f20ac563a5da76af44afced57b477e1">mkldnn_unidirectional</a> = mkldnn_unidirectional_left2right
<br />
}<tr class="memdesc:ga3cb09316c36bd985698e0eea542cb424"><td class="mdescLeft">&#160;</td><td class="mdescRight">A direction of RNN primitive execution. <a href="group__c__api__types__op__descs.html#ga3cb09316c36bd985698e0eea542cb424">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga3cb09316c36bd985698e0eea542cb424"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gac7e49603b052255540a6f6dc072a627c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef const void* <a class="el" href="group__c__api__types__op__descs.html#gac7e49603b052255540a6f6dc072a627c">const_mkldnn_op_desc_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A pointer to any of the operation descriptors (constant variant). </p>
</div>
</div>
<a class="anchor" id="ga22892e72c09157377e6d0358273025a3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structmkldnn__convolution__desc__t.html">mkldnn_convolution_desc_t</a> <a class="el" href="group__c__api__types__op__descs.html#ga22892e72c09157377e6d0358273025a3">mkldnn_deconvolution_desc_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A descriptor of a deconvolution operation. </p>
</div>
</div>
<a class="anchor" id="ga6ed0f70ed4c6398c24a62b49cf8d538c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="group__c__api__types__op__descs.html#ga6ed0f70ed4c6398c24a62b49cf8d538c">mkldnn_op_desc_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A pointer to any of the operation descriptors. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga3cb09316c36bd985698e0eea542cb424"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__c__api__types__op__descs.html#ga3cb09316c36bd985698e0eea542cb424">mkldnn_rnn_direction_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A direction of RNN primitive execution. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga3cb09316c36bd985698e0eea542cb424a704a37978225c8c03f673e34fb3dc89f"></a>mkldnn_unidirectional_left2right&#160;</td><td class="fielddoc">
<p>Unidirectional execution of RNN primitive from left to right. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga3cb09316c36bd985698e0eea542cb424a594d74774460029d0635daaf4a7bace7"></a>mkldnn_unidirectional_right2left&#160;</td><td class="fielddoc">
<p>Unidirectional execution of RNN primitive from right to left. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga3cb09316c36bd985698e0eea542cb424a29eacee8606bd282bc82396590c29590"></a>mkldnn_bidirectional_concat&#160;</td><td class="fielddoc">
<p>Bidirectional execution of RNN primitive with concatenation of the results. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga3cb09316c36bd985698e0eea542cb424a41da7196bf8914d34a35ce7c1122e9bc"></a>mkldnn_bidirectional_sum&#160;</td><td class="fielddoc">
<p>Bidirectional execution of RNN primitive with summation of the results. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga3cb09316c36bd985698e0eea542cb424a8f20ac563a5da76af44afced57b477e1"></a>mkldnn_unidirectional&#160;</td><td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="gaee216bdaa31e58c0529d1e8314763d6d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__c__api__types__op__descs.html#gaee216bdaa31e58c0529d1e8314763d6d">mkldnn_rnn_flags_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags for RNN cell. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggaee216bdaa31e58c0529d1e8314763d6da7e69d2e0ccebe8ef3d3616dd603ba57f"></a>mkldnn_rnn_flags_undef&#160;</td><td class="fielddoc">
</td></tr>
</table>
</div>
</div>
</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>