blob: 57376bd2e7ca38488d8305793277bfc61690de93 [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: Common primitive operations</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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Common primitive operations<div class="ingroups"><a class="el" href="group__c__api.html">C API</a> &raquo; <a class="el" href="group__c__api__primitive.html">Primitive operations</a></div></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Common primitive operations:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__c__api__primitive__common.png" border="0" alt="" usemap="#group____c____api____primitive____common"/>
<map name="group____c____api____primitive____common" id="group____c____api____primitive____common">
<area shape="rect" id="node2" href="group__c__api__primitive.html" title="Primitive operations" alt="" coords="5,5,155,32"/>
</map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga93f890fd43ea033a2820f0d7700f785a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__primitive__common.html#ga93f890fd43ea033a2820f0d7700f785a">mkldnn_primitive_desc_iterator_create</a> (<a class="el" href="group__c__api__primitive__desc__iterators.html#gab10071e5bb605ceee088b7e9cdbac9a2">mkldnn_primitive_desc_iterator_t</a> *iterator, <a class="el" href="group__c__api__types__op__descs.html#gac7e49603b052255540a6f6dc072a627c">const_mkldnn_op_desc_t</a> op_desc, <a class="el" href="group__c__api__primitive__attr.html#ga3f3780c1e4efc952e6639a2f083a8b85">const_mkldnn_primitive_attr_t</a> attr, <a class="el" href="group__c__api__engine__types.html#ga40f5f917cdbf2215fa5324e4bf62d523">mkldnn_engine_t</a> engine, <a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a> hint_forward_primitive_desc)</td></tr>
<tr class="separator:ga93f890fd43ea033a2820f0d7700f785a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3887ba1fa83051afac8fac2b93d15ed7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__primitive__common.html#ga3887ba1fa83051afac8fac2b93d15ed7">mkldnn_primitive_desc_iterator_next</a> (<a class="el" href="group__c__api__primitive__desc__iterators.html#gab10071e5bb605ceee088b7e9cdbac9a2">mkldnn_primitive_desc_iterator_t</a> iterator)</td></tr>
<tr class="separator:ga3887ba1fa83051afac8fac2b93d15ed7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae067e25a698f097723ee635350fd18f3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__primitive__descs.html#ga4108b6ee20cf3d2e472504c1aea67497">mkldnn_primitive_desc_t</a> MKLDNN_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__primitive__common.html#gae067e25a698f097723ee635350fd18f3">mkldnn_primitive_desc_iterator_fetch</a> (<a class="el" href="group__c__api__primitive__desc__iterators.html#ga357e481b81862c775dff602049f40386">const_mkldnn_primitive_desc_iterator_t</a> iterator)</td></tr>
<tr class="separator:gae067e25a698f097723ee635350fd18f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8368e2a6339f2df57128b00aae74ce37"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__primitive__common.html#ga8368e2a6339f2df57128b00aae74ce37">mkldnn_primitive_desc_iterator_destroy</a> (<a class="el" href="group__c__api__primitive__desc__iterators.html#gab10071e5bb605ceee088b7e9cdbac9a2">mkldnn_primitive_desc_iterator_t</a> iterator)</td></tr>
<tr class="memdesc:ga8368e2a6339f2df57128b00aae74ce37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes a primitive descriptor <code>iterator</code>. <a href="#ga8368e2a6339f2df57128b00aae74ce37">More...</a><br /></td></tr>
<tr class="separator:ga8368e2a6339f2df57128b00aae74ce37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabca2c29dabdc558792fe39266a9c9843"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__primitive__common.html#gabca2c29dabdc558792fe39266a9c9843">mkldnn_primitive_desc_create</a> (<a class="el" href="group__c__api__primitive__descs.html#ga4108b6ee20cf3d2e472504c1aea67497">mkldnn_primitive_desc_t</a> *primitive_desc, <a class="el" href="group__c__api__types__op__descs.html#gac7e49603b052255540a6f6dc072a627c">const_mkldnn_op_desc_t</a> op_desc, <a class="el" href="group__c__api__primitive__attr.html#ga3f3780c1e4efc952e6639a2f083a8b85">const_mkldnn_primitive_attr_t</a> attr, <a class="el" href="group__c__api__engine__types.html#ga40f5f917cdbf2215fa5324e4bf62d523">mkldnn_engine_t</a> engine, <a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a> hint_forward_primitive_desc)</td></tr>
<tr class="separator:gabca2c29dabdc558792fe39266a9c9843"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0b9555bd267ce2add362ee18cdaadd73"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__primitive__common.html#ga0b9555bd267ce2add362ee18cdaadd73">mkldnn_primitive_desc_clone</a> (<a class="el" href="group__c__api__primitive__descs.html#ga4108b6ee20cf3d2e472504c1aea67497">mkldnn_primitive_desc_t</a> *primitive_desc, <a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a> existing_primitive_desc)</td></tr>
<tr class="memdesc:ga0b9555bd267ce2add362ee18cdaadd73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Makes a copy of a <code>primitive_desc</code>. <a href="#ga0b9555bd267ce2add362ee18cdaadd73">More...</a><br /></td></tr>
<tr class="separator:ga0b9555bd267ce2add362ee18cdaadd73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga86d0f67044d18c77f6c60dfed9db417a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__primitive__common.html#ga86d0f67044d18c77f6c60dfed9db417a">mkldnn_primitive_desc_get_attr</a> (<a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a> primitive_desc, <a class="el" href="group__c__api__primitive__attr.html#ga3f3780c1e4efc952e6639a2f083a8b85">const_mkldnn_primitive_attr_t</a> *attr)</td></tr>
<tr class="separator:ga86d0f67044d18c77f6c60dfed9db417a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacad44a12c7d863fb47dc02a76b4b794a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__primitive__common.html#gacad44a12c7d863fb47dc02a76b4b794a">mkldnn_primitive_desc_destroy</a> (<a class="el" href="group__c__api__primitive__descs.html#ga4108b6ee20cf3d2e472504c1aea67497">mkldnn_primitive_desc_t</a> primitive_desc)</td></tr>
<tr class="memdesc:gacad44a12c7d863fb47dc02a76b4b794a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes a <code>primitive_desc</code>. <a href="#gacad44a12c7d863fb47dc02a76b4b794a">More...</a><br /></td></tr>
<tr class="separator:gacad44a12c7d863fb47dc02a76b4b794a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa0ef4b91ed5cd98a19540a8182228012"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__primitive__common.html#gaa0ef4b91ed5cd98a19540a8182228012">mkldnn_primitive_desc_query</a> (<a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a> primitive_desc, <a class="el" href="group__c__api__types__query.html#ga6eebc661a8a3437b49d9c677f8972fc9">mkldnn_query_t</a> what, int index, void *result)</td></tr>
<tr class="separator:gaa0ef4b91ed5cd98a19540a8182228012"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9e14963d6bdb1aed934ffb059421fcfc"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structmkldnn__memory__desc__t.html">mkldnn_memory_desc_t</a> MKLDNN_API *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__primitive__common.html#ga9e14963d6bdb1aed934ffb059421fcfc">mkldnn_primitive_desc_query_md</a> (<a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a> primitive_desc, <a class="el" href="group__c__api__types__query.html#ga6eebc661a8a3437b49d9c677f8972fc9">mkldnn_query_t</a> what, int index)</td></tr>
<tr class="separator:ga9e14963d6bdb1aed934ffb059421fcfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2a02e9260e117288da772ff472092f13"><td class="memItemLeft" align="right" valign="top">int MKLDNN_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__primitive__common.html#ga2a02e9260e117288da772ff472092f13">mkldnn_primitive_desc_query_s32</a> (<a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a> primitive_desc, <a class="el" href="group__c__api__types__query.html#ga6eebc661a8a3437b49d9c677f8972fc9">mkldnn_query_t</a> what, int index)</td></tr>
<tr class="separator:ga2a02e9260e117288da772ff472092f13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7e9dba49f70cef016d9efcb542035eca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__primitive__common.html#ga7e9dba49f70cef016d9efcb542035eca">mkldnn_primitive_create</a> (<a class="el" href="group__c__api__types__primitive.html#gac7821f6b4a4fa0d58fe5279a1ff2fda3">mkldnn_primitive_t</a> *primitive, <a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a> primitive_desc)</td></tr>
<tr class="memdesc:ga7e9dba49f70cef016d9efcb542035eca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a <code>primitive</code> using a <code>primitive_desc</code> descriptor. <a href="#ga7e9dba49f70cef016d9efcb542035eca">More...</a><br /></td></tr>
<tr class="separator:ga7e9dba49f70cef016d9efcb542035eca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3b410ce7d1cd3fede1ed80394ed3dacf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__primitive__common.html#ga3b410ce7d1cd3fede1ed80394ed3dacf">mkldnn_primitive_execute</a> (<a class="el" href="group__c__api__types__primitive.html#ga5c35758e2445410362c85e0ddb6bbf9f">const_mkldnn_primitive_t</a> primitive, <a class="el" href="group__c__api__types__stream.html#ga45075c5015f9a5ef3b0365af92fa1529">mkldnn_stream_t</a> stream, int nargs, const <a class="el" href="structmkldnn__exec__arg__t.html">mkldnn_exec_arg_t</a> *args)</td></tr>
<tr class="separator:ga3b410ce7d1cd3fede1ed80394ed3dacf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6ff9030a5947b4e3f9e8296c86059935"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__primitive__common.html#ga6ff9030a5947b4e3f9e8296c86059935">mkldnn_primitive_get_primitive_desc</a> (<a class="el" href="group__c__api__types__primitive.html#ga5c35758e2445410362c85e0ddb6bbf9f">const_mkldnn_primitive_t</a> primitive, <a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a> *primitive_desc)</td></tr>
<tr class="separator:ga6ff9030a5947b4e3f9e8296c86059935"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga083d8c44cc398146be7056c7b450ee83"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__primitive__common.html#ga083d8c44cc398146be7056c7b450ee83">mkldnn_primitive_destroy</a> (<a class="el" href="group__c__api__types__primitive.html#gac7821f6b4a4fa0d58fe5279a1ff2fda3">mkldnn_primitive_t</a> primitive)</td></tr>
<tr class="memdesc:ga083d8c44cc398146be7056c7b450ee83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes a <code>primitive</code>. <a href="#ga083d8c44cc398146be7056c7b450ee83">More...</a><br /></td></tr>
<tr class="separator:ga083d8c44cc398146be7056c7b450ee83"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga7e9dba49f70cef016d9efcb542035eca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API mkldnn_primitive_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__types__primitive.html#gac7821f6b4a4fa0d58fe5279a1ff2fda3">mkldnn_primitive_t</a> *&#160;</td>
<td class="paramname"><em>primitive</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a>&#160;</td>
<td class="paramname"><em>primitive_desc</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <code>primitive</code> using a <code>primitive_desc</code> descriptor. </p>
</div>
</div>
<a class="anchor" id="ga0b9555bd267ce2add362ee18cdaadd73"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API mkldnn_primitive_desc_clone </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__descs.html#ga4108b6ee20cf3d2e472504c1aea67497">mkldnn_primitive_desc_t</a> *&#160;</td>
<td class="paramname"><em>primitive_desc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a>&#160;</td>
<td class="paramname"><em>existing_primitive_desc</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes a copy of a <code>primitive_desc</code>. </p>
</div>
</div>
<a class="anchor" id="gabca2c29dabdc558792fe39266a9c9843"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API mkldnn_primitive_desc_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__descs.html#ga4108b6ee20cf3d2e472504c1aea67497">mkldnn_primitive_desc_t</a> *&#160;</td>
<td class="paramname"><em>primitive_desc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__types__op__descs.html#gac7e49603b052255540a6f6dc072a627c">const_mkldnn_op_desc_t</a>&#160;</td>
<td class="paramname"><em>op_desc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__attr.html#ga3f3780c1e4efc952e6639a2f083a8b85">const_mkldnn_primitive_attr_t</a>&#160;</td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__engine__types.html#ga40f5f917cdbf2215fa5324e4bf62d523">mkldnn_engine_t</a>&#160;</td>
<td class="paramname"><em>engine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a>&#160;</td>
<td class="paramname"><em>hint_forward_primitive_desc</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <code>primitive_desc</code> using <code>op_desc</code>, <code>attr</code>, <code>engine</code>, and optionally a hint primitive descriptor from forward propagation. The call is equivalent to creating a primitive descriptor iterator, immediately fetching a primitive descriptor, and then destroying the iterator. </p>
</div>
</div>
<a class="anchor" id="gacad44a12c7d863fb47dc02a76b4b794a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API mkldnn_primitive_desc_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__descs.html#ga4108b6ee20cf3d2e472504c1aea67497">mkldnn_primitive_desc_t</a>&#160;</td>
<td class="paramname"><em>primitive_desc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deletes a <code>primitive_desc</code>. </p>
</div>
</div>
<a class="anchor" id="ga86d0f67044d18c77f6c60dfed9db417a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API mkldnn_primitive_desc_get_attr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a>&#160;</td>
<td class="paramname"><em>primitive_desc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__attr.html#ga3f3780c1e4efc952e6639a2f083a8b85">const_mkldnn_primitive_attr_t</a> *&#160;</td>
<td class="paramname"><em>attr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a constant reference to the attribute of a <code>primitive_desc</code>.</p>
<dl class="section warning"><dt>Warning</dt><dd>The user should not destroy the obtained <code>attr</code>.</dd>
<dd>
The lifetime of an <code>attr</code> is the same as that of a <code>primitive_desc</code>, so it is illegal to use the <code>attr</code> once <code>primitive_desc</code> has been destroyed. </dd></dl>
</div>
</div>
<a class="anchor" id="ga93f890fd43ea033a2820f0d7700f785a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API mkldnn_primitive_desc_iterator_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__desc__iterators.html#gab10071e5bb605ceee088b7e9cdbac9a2">mkldnn_primitive_desc_iterator_t</a> *&#160;</td>
<td class="paramname"><em>iterator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__types__op__descs.html#gac7e49603b052255540a6f6dc072a627c">const_mkldnn_op_desc_t</a>&#160;</td>
<td class="paramname"><em>op_desc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__attr.html#ga3f3780c1e4efc952e6639a2f083a8b85">const_mkldnn_primitive_attr_t</a>&#160;</td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__engine__types.html#ga40f5f917cdbf2215fa5324e4bf62d523">mkldnn_engine_t</a>&#160;</td>
<td class="paramname"><em>engine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a>&#160;</td>
<td class="paramname"><em>hint_forward_primitive_desc</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a primitive descriptor <code>iterator</code> for given <code>op_desc</code>, <code>attr</code>, <code>engine</code>, and optionally a hint primitive descriptor from forward propagation (required for backward propagation). Pass <code>NULL</code> for forward propagation. </p>
</div>
</div>
<a class="anchor" id="ga8368e2a6339f2df57128b00aae74ce37"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API mkldnn_primitive_desc_iterator_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__desc__iterators.html#gab10071e5bb605ceee088b7e9cdbac9a2">mkldnn_primitive_desc_iterator_t</a>&#160;</td>
<td class="paramname"><em>iterator</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deletes a primitive descriptor <code>iterator</code>. </p>
</div>
</div>
<a class="anchor" id="gae067e25a698f097723ee635350fd18f3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__primitive__descs.html#ga4108b6ee20cf3d2e472504c1aea67497">mkldnn_primitive_desc_t</a> MKLDNN_API mkldnn_primitive_desc_iterator_fetch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__desc__iterators.html#ga357e481b81862c775dff602049f40386">const_mkldnn_primitive_desc_iterator_t</a>&#160;</td>
<td class="paramname"><em>iterator</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fetches the current primitive descriptor.</p>
<dl class="section note"><dt>Note</dt><dd>The user should delete the fetched primitive descriptor using <a class="el" href="group__c__api__primitive__common.html#gacad44a12c7d863fb47dc02a76b4b794a" title="Deletes a primitive_desc. ">mkldnn_primitive_desc_destroy()</a> once it is no longer needed. </dd></dl>
</div>
</div>
<a class="anchor" id="ga3887ba1fa83051afac8fac2b93d15ed7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API mkldnn_primitive_desc_iterator_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__desc__iterators.html#gab10071e5bb605ceee088b7e9cdbac9a2">mkldnn_primitive_desc_iterator_t</a>&#160;</td>
<td class="paramname"><em>iterator</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterates over primitive descriptors. Returns <a class="el" href="group__c__api__types__generic.html#gga31866789b66acfb1c28b2f9bdd7bdfdda30c47def85dc1bbf8a9dda24f16c9add" title="Primitive iterator passed over last primitive descriptor. ">mkldnn_iterator_ends</a> if no more primitive descriptors are available. </p>
</div>
</div>
<a class="anchor" id="gaa0ef4b91ed5cd98a19540a8182228012"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API mkldnn_primitive_desc_query </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a>&#160;</td>
<td class="paramname"><em>primitive_desc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__types__query.html#ga6eebc661a8a3437b49d9c677f8972fc9">mkldnn_query_t</a>&#160;</td>
<td class="paramname"><em>what</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>result</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Queries primitive descriptor</p>
<p>One of the most typical use cases is to query a primitive descriptor created with source, weights, and destination formats equal to <a class="el" href="group__c__api__types__generic.html#ggacc2844e341ab1c4f5b7ae1c6068f2a2bab7f14a435b0c6373badb9b3f296e6c1f">mkldnn_format_tag_any</a> about the corresponding memory descriptors (<code>what</code> equals <a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a2bccd0a79be2c331227c353c294c3fbc" title="source memory desc ">mkldnn_query_src_md</a>, <a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a4d1661d6a50277029d02417f6b65435d" title="weights memory descriptor desc ">mkldnn_query_weights_md</a>, and <a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9adccda04151e0c287f0de64b832d33ac4" title="destination memory desc ">mkldnn_query_dst_md</a> respectively) to be able to prepare memory and create reorders if required.</p>
<p>Another quite typical use case is to query an operation primitive descriptor for a workspace (<code>what</code> equals <a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a6f61e139512317e7f5653759e889d55d" title="workspace memory desc ">mkldnn_query_workspace_md</a>). The returned status <a class="el" href="group__c__api__types__generic.html#gga31866789b66acfb1c28b2f9bdd7bdfdda9be03e267991a3e90b4a61a39ef4d353" title="Queried element is not required for given primitive. ">mkldnn_not_required</a> indicates that a workspace is not required.</p>
<dl class="section note"><dt>Note</dt><dd>When querying a memory descriptor for a scratchpad, a workspace, or an optional parameter, the query will return a zero_md if the parameter is not needed.</dd></dl>
<p>A few other possibilities:</p><ul>
<li>query an operation primitive descriptor for the underlying operation descriptor (<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a3e1f5ad4718ad7f41916b4227e0a9964" title="convolution descriptor ">mkldnn_query_convolution_d</a>, <a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a6ea3ff9ae6be79fe71a89bbfc87b4d7e" title="eltwise descriptor ">mkldnn_query_eltwise_d</a>, <a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a7a567d8e61a6e0b1aeb219f5229b13de" title="rnn descriptor ">mkldnn_query_rnn_d</a>, etc.)</li>
<li>query an operation primitive descriptor for the implementation information string (<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9ab92f503404fade1f402bed9c34727d9c" title="implementation name ">mkldnn_query_impl_info_str</a>)</li>
<li>query an operation primitive descriptor for the number of inputs and outputs (<a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9a660e903603b99e5745feba14a7ee2891" title="number of inputs expected ">mkldnn_query_num_of_inputs_s32</a> and <a class="el" href="group__c__api__types__query.html#gga6eebc661a8a3437b49d9c677f8972fc9abd7a52122733cac8b3d1de8eab20f9cf" title="number of outputs expected ">mkldnn_query_num_of_outputs_s32</a> respectively)</li>
</ul>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__c__api__types__query.html#ga6eebc661a8a3437b49d9c677f8972fc9">mkldnn_query_t</a> for more options </dd></dl>
</div>
</div>
<a class="anchor" id="ga9e14963d6bdb1aed934ffb059421fcfc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structmkldnn__memory__desc__t.html">mkldnn_memory_desc_t</a> MKLDNN_API* mkldnn_primitive_desc_query_md </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a>&#160;</td>
<td class="paramname"><em>primitive_desc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__types__query.html#ga6eebc661a8a3437b49d9c677f8972fc9">mkldnn_query_t</a>&#160;</td>
<td class="paramname"><em>what</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>index</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Queries primitive descriptor for memory descriptor</p>
<dl class="section return"><dt>Returns</dt><dd>NULL in case of any error.</dd></dl>
<p>This is just a specialized version of mkldnn_primitive_desc_query used for convenience. </p>
</div>
</div>
<a class="anchor" id="ga2a02e9260e117288da772ff472092f13"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int MKLDNN_API mkldnn_primitive_desc_query_s32 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a>&#160;</td>
<td class="paramname"><em>primitive_desc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__types__query.html#ga6eebc661a8a3437b49d9c677f8972fc9">mkldnn_query_t</a>&#160;</td>
<td class="paramname"><em>what</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>index</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Queries primitive descriptor for signed 32bit int</p>
<dl class="section return"><dt>Returns</dt><dd>0 in case of any error (in particular if the queried entity is not of type int32_t). Note that 0 might also be the actual returned value.</dd></dl>
<p>This is just a specialized version of mkldnn_primitive_desc_query used for convenience. </p>
</div>
</div>
<a class="anchor" id="ga083d8c44cc398146be7056c7b450ee83"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API mkldnn_primitive_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__types__primitive.html#gac7821f6b4a4fa0d58fe5279a1ff2fda3">mkldnn_primitive_t</a>&#160;</td>
<td class="paramname"><em>primitive</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deletes a <code>primitive</code>. </p>
</div>
</div>
<a class="anchor" id="ga3b410ce7d1cd3fede1ed80394ed3dacf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API mkldnn_primitive_execute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__types__primitive.html#ga5c35758e2445410362c85e0ddb6bbf9f">const_mkldnn_primitive_t</a>&#160;</td>
<td class="paramname"><em>primitive</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__types__stream.html#ga45075c5015f9a5ef3b0365af92fa1529">mkldnn_stream_t</a>&#160;</td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>nargs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmkldnn__exec__arg__t.html">mkldnn_exec_arg_t</a> *&#160;</td>
<td class="paramname"><em>args</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Executes a <code>primitive</code> using a <code>stream</code>, and <code>nargs</code> arguments <code>args</code>. </p>
</div>
</div>
<a class="anchor" id="ga6ff9030a5947b4e3f9e8296c86059935"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__c__api__types__generic.html#ga31866789b66acfb1c28b2f9bdd7bdfdd">mkldnn_status_t</a> MKLDNN_API mkldnn_primitive_get_primitive_desc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__types__primitive.html#ga5c35758e2445410362c85e0ddb6bbf9f">const_mkldnn_primitive_t</a>&#160;</td>
<td class="paramname"><em>primitive</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__c__api__primitive__descs.html#gacf18210edd8d1816e216075fab637ce9">const_mkldnn_primitive_desc_t</a> *&#160;</td>
<td class="paramname"><em>primitive_desc</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a reference to the <code>primitive_desc</code> descriptor of given <code>primitive</code>.</p>
<dl class="section warning"><dt>Warning</dt><dd>The returned object must not be destroyed by the user. The <code>const</code> qualifier of the returned object prevents such attempts. </dd></dl>
</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>