blob: 11851cc5bf5cecd2f3f8f792e20a0a85d201a3bf [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: Engine 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">Engine operations<div class="ingroups"><a class="el" href="group__c__api.html">C API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Engine operations:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__c__api__engine.png" border="0" alt="" usemap="#group____c____api____engine"/>
<map name="group____c____api____engine" id="group____c____api____engine">
<area shape="rect" id="node1" href="group__c__api.html" title="C API" alt="" coords="5,5,60,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:ga6e53c91f2b5deb3de460df7751e7428b"><td class="memItemLeft" align="right" valign="top">size_t MKLDNN_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__c__api__engine.html#ga6e53c91f2b5deb3de460df7751e7428b">mkldnn_engine_get_count</a> (<a class="el" href="group__c__api__engine__types.html#gaec8e96cbc2f19125c9def11efa98aa7e">mkldnn_engine_kind_t</a> kind)</td></tr>
<tr class="memdesc:ga6e53c91f2b5deb3de460df7751e7428b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of engines of a particular <code>kind</code>. <a href="#ga6e53c91f2b5deb3de460df7751e7428b">More...</a><br /></td></tr>
<tr class="separator:ga6e53c91f2b5deb3de460df7751e7428b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae6368dc7ac5a23b48c1be9669d57d194"><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__engine.html#gae6368dc7ac5a23b48c1be9669d57d194">mkldnn_engine_create</a> (<a class="el" href="group__c__api__engine__types.html#ga40f5f917cdbf2215fa5324e4bf62d523">mkldnn_engine_t</a> *engine, <a class="el" href="group__c__api__engine__types.html#gaec8e96cbc2f19125c9def11efa98aa7e">mkldnn_engine_kind_t</a> kind, size_t index)</td></tr>
<tr class="memdesc:gae6368dc7ac5a23b48c1be9669d57d194"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an <code>engine</code> of particular <code>kind</code> and <code>index</code>. <a href="#gae6368dc7ac5a23b48c1be9669d57d194">More...</a><br /></td></tr>
<tr class="separator:gae6368dc7ac5a23b48c1be9669d57d194"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac600f0eed7d77284ca78b8b34547b862"><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__engine.html#gac600f0eed7d77284ca78b8b34547b862">mkldnn_engine_create_ocl</a> (<a class="el" href="group__c__api__engine__types.html#ga40f5f917cdbf2215fa5324e4bf62d523">mkldnn_engine_t</a> *engine, <a class="el" href="group__c__api__engine__types.html#gaec8e96cbc2f19125c9def11efa98aa7e">mkldnn_engine_kind_t</a> kind, cl_device_id device, cl_context context)</td></tr>
<tr class="separator:gac600f0eed7d77284ca78b8b34547b862"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5b2114bfa8d837ac350e86b8999c9a3a"><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__engine.html#ga5b2114bfa8d837ac350e86b8999c9a3a">mkldnn_engine_get_kind</a> (<a class="el" href="group__c__api__engine__types.html#ga40f5f917cdbf2215fa5324e4bf62d523">mkldnn_engine_t</a> engine, <a class="el" href="group__c__api__engine__types.html#gaec8e96cbc2f19125c9def11efa98aa7e">mkldnn_engine_kind_t</a> *kind)</td></tr>
<tr class="memdesc:ga5b2114bfa8d837ac350e86b8999c9a3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the kind of an <code>engine</code>. <a href="#ga5b2114bfa8d837ac350e86b8999c9a3a">More...</a><br /></td></tr>
<tr class="separator:ga5b2114bfa8d837ac350e86b8999c9a3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab4a35ec3df81eb7c24ab8863b7abe36e"><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__engine.html#gab4a35ec3df81eb7c24ab8863b7abe36e">mkldnn_engine_get_ocl_context</a> (<a class="el" href="group__c__api__engine__types.html#ga40f5f917cdbf2215fa5324e4bf62d523">mkldnn_engine_t</a> engine, cl_context *context)</td></tr>
<tr class="memdesc:gab4a35ec3df81eb7c24ab8863b7abe36e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an OpenCL <code>context</code> associated with an <code>engine</code>. <a href="#gab4a35ec3df81eb7c24ab8863b7abe36e">More...</a><br /></td></tr>
<tr class="separator:gab4a35ec3df81eb7c24ab8863b7abe36e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4e1da74c9a4409c085d00afbde8c3094"><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__engine.html#ga4e1da74c9a4409c085d00afbde8c3094">mkldnn_engine_get_ocl_device</a> (<a class="el" href="group__c__api__engine__types.html#ga40f5f917cdbf2215fa5324e4bf62d523">mkldnn_engine_t</a> engine, cl_device_id *device)</td></tr>
<tr class="memdesc:ga4e1da74c9a4409c085d00afbde8c3094"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an OpenCL <code>device</code> associated with an <code>engine</code>. <a href="#ga4e1da74c9a4409c085d00afbde8c3094">More...</a><br /></td></tr>
<tr class="separator:ga4e1da74c9a4409c085d00afbde8c3094"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa6610c08cc39592b28d04535fb9db2d3"><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__engine.html#gaa6610c08cc39592b28d04535fb9db2d3">mkldnn_engine_destroy</a> (<a class="el" href="group__c__api__engine__types.html#ga40f5f917cdbf2215fa5324e4bf62d523">mkldnn_engine_t</a> engine)</td></tr>
<tr class="memdesc:gaa6610c08cc39592b28d04535fb9db2d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys an <code>engine</code>. <a href="#gaa6610c08cc39592b28d04535fb9db2d3">More...</a><br /></td></tr>
<tr class="separator:gaa6610c08cc39592b28d04535fb9db2d3"><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="gae6368dc7ac5a23b48c1be9669d57d194"></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_engine_create </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__engine__types.html#gaec8e96cbc2f19125c9def11efa98aa7e">mkldnn_engine_kind_t</a>&#160;</td>
<td class="paramname"><em>kind</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#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>Creates an <code>engine</code> of particular <code>kind</code> and <code>index</code>. </p>
</div>
</div>
<a class="anchor" id="gac600f0eed7d77284ca78b8b34547b862"></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_engine_create_ocl </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__engine__types.html#gaec8e96cbc2f19125c9def11efa98aa7e">mkldnn_engine_kind_t</a>&#160;</td>
<td class="paramname"><em>kind</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cl_device_id&#160;</td>
<td class="paramname"><em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cl_context&#160;</td>
<td class="paramname"><em>context</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an <code>engine</code> of particular <code>kind</code> associated with a given OpenCL <code>device</code> and <code>context</code> objects. </p>
</div>
</div>
<a class="anchor" id="gaa6610c08cc39592b28d04535fb9db2d3"></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_engine_destroy </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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys an <code>engine</code>. </p>
</div>
</div>
<a class="anchor" id="ga6e53c91f2b5deb3de460df7751e7428b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t MKLDNN_API mkldnn_engine_get_count </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__c__api__engine__types.html#gaec8e96cbc2f19125c9def11efa98aa7e">mkldnn_engine_kind_t</a>&#160;</td>
<td class="paramname"><em>kind</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of engines of a particular <code>kind</code>. </p>
</div>
</div>
<a class="anchor" id="ga5b2114bfa8d837ac350e86b8999c9a3a"></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_engine_get_kind </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__engine__types.html#gaec8e96cbc2f19125c9def11efa98aa7e">mkldnn_engine_kind_t</a> *&#160;</td>
<td class="paramname"><em>kind</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the kind of an <code>engine</code>. </p>
</div>
</div>
<a class="anchor" id="gab4a35ec3df81eb7c24ab8863b7abe36e"></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_engine_get_ocl_context </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">cl_context *&#160;</td>
<td class="paramname"><em>context</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an OpenCL <code>context</code> associated with an <code>engine</code>. </p>
</div>
</div>
<a class="anchor" id="ga4e1da74c9a4409c085d00afbde8c3094"></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_engine_get_ocl_device </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">cl_device_id *&#160;</td>
<td class="paramname"><em>device</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an OpenCL <code>device</code> associated with an <code>engine</code>. </p>
</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>