Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / 1.9.1 / api / cpp / docs / api / group__dnnl__api__engine.html
blob: eb8b7046e396d26009cecc1904858c1a725f7181 [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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: Dnnl_api_engine</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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></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> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Dnnl_api_engine<div class="ingroups"><a class="el" href="group__dnnl__api.html">Dnnl_api</a></div></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Dnnl_api_engine:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__dnnl__api__engine.png" border="0" alt="" usemap="#group____dnnl____api____engine"/>
<map name="group____dnnl____api____engine" id="group____dnnl____api____engine">
<area shape="rect" id="node2" href="group__dnnl__api.html" title="Dnnl_api" alt="" coords="5,5,84,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="structdnnl__engine.html">dnnl_engine</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An opaque structure to describe an engine. <a href="structdnnl__engine.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:ga1ce7843660e8203ed6e1af9bfd23e14f"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structdnnl__engine.html">dnnl_engine</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a></td></tr>
<tr class="memdesc:ga1ce7843660e8203ed6e1af9bfd23e14f"><td class="mdescLeft">&#160;</td><td class="mdescRight">An engine handle. <a href="#ga1ce7843660e8203ed6e1af9bfd23e14f">More...</a><br /></td></tr>
<tr class="separator:ga1ce7843660e8203ed6e1af9bfd23e14f"><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:ga04b3dd9eba628ea02218a52c4c4363a2"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__engine.html#ga04b3dd9eba628ea02218a52c4c4363a2">dnnl_engine_kind_t</a> { <a class="el" href="group__dnnl__api__engine.html#gga04b3dd9eba628ea02218a52c4c4363a2af14bd66bd4a7130da204c539f7cf08b6">dnnl_any_engine</a>,
<a class="el" href="group__dnnl__api__engine.html#gga04b3dd9eba628ea02218a52c4c4363a2abde7b942413dd36f8285dd360fc0c797">dnnl_cpu</a>,
<a class="el" href="group__dnnl__api__engine.html#gga04b3dd9eba628ea02218a52c4c4363a2a6ab900ae0fc26be67742c0e59a015438">dnnl_gpu</a>
}<tr class="memdesc:ga04b3dd9eba628ea02218a52c4c4363a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Kinds of engines. <a href="group__dnnl__api__engine.html#ga04b3dd9eba628ea02218a52c4c4363a2">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga04b3dd9eba628ea02218a52c4c4363a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gadff5935622df99a2f89acb5cbea09ab5"><td class="memItemLeft" align="right" valign="top">size_t DNNL_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__engine.html#gadff5935622df99a2f89acb5cbea09ab5">dnnl_engine_get_count</a> (<a class="el" href="group__dnnl__api__engine.html#ga04b3dd9eba628ea02218a52c4c4363a2">dnnl_engine_kind_t</a> kind)</td></tr>
<tr class="separator:gadff5935622df99a2f89acb5cbea09ab5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab84f82f3011349cbfe368b61882834fd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__engine.html#gab84f82f3011349cbfe368b61882834fd">dnnl_engine_create</a> (<a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> *engine, <a class="el" href="group__dnnl__api__engine.html#ga04b3dd9eba628ea02218a52c4c4363a2">dnnl_engine_kind_t</a> kind, size_t index)</td></tr>
<tr class="separator:gab84f82f3011349cbfe368b61882834fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8a38bdce17f51616d03310a8e8764c8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__engine.html#ga8a38bdce17f51616d03310a8e8764c8c">dnnl_engine_get_kind</a> (<a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> engine, <a class="el" href="group__dnnl__api__engine.html#ga04b3dd9eba628ea02218a52c4c4363a2">dnnl_engine_kind_t</a> *kind)</td></tr>
<tr class="separator:ga8a38bdce17f51616d03310a8e8764c8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8d6976b3792cf1ef64d01545929b4d8f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__engine.html#ga8d6976b3792cf1ef64d01545929b4d8f">dnnl_engine_destroy</a> (<a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> engine)</td></tr>
<tr class="separator:ga8d6976b3792cf1ef64d01545929b4d8f"><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 id="ga1ce7843660e8203ed6e1af9bfd23e14f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1ce7843660e8203ed6e1af9bfd23e14f">&#9670;&nbsp;</a></span>dnnl_engine_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structdnnl__engine.html">dnnl_engine</a>* <a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An engine handle. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga04b3dd9eba628ea02218a52c4c4363a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga04b3dd9eba628ea02218a52c4c4363a2">&#9670;&nbsp;</a></span>dnnl_engine_kind_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__dnnl__api__engine.html#ga04b3dd9eba628ea02218a52c4c4363a2">dnnl_engine_kind_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Kinds of engines. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga04b3dd9eba628ea02218a52c4c4363a2af14bd66bd4a7130da204c539f7cf08b6"></a>dnnl_any_engine&#160;</td><td class="fielddoc"><p>An unspecified engine. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga04b3dd9eba628ea02218a52c4c4363a2abde7b942413dd36f8285dd360fc0c797"></a>dnnl_cpu&#160;</td><td class="fielddoc"><p>CPU engine. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga04b3dd9eba628ea02218a52c4c4363a2a6ab900ae0fc26be67742c0e59a015438"></a>dnnl_gpu&#160;</td><td class="fielddoc"><p>GPU engine. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gab84f82f3011349cbfe368b61882834fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab84f82f3011349cbfe368b61882834fd">&#9670;&nbsp;</a></span>dnnl_engine_create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_engine_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_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__dnnl__api__engine.html#ga04b3dd9eba628ea02218a52c4c4363a2">dnnl_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 engine.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">engine</td><td>Output engine. </td></tr>
<tr><td class="paramname">kind</td><td>Engine kind. </td></tr>
<tr><td class="paramname">index</td><td>Engine index that should be between 0 and the count of engines of the requested kind. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl>
</div>
</div>
<a id="ga8d6976b3792cf1ef64d01545929b4d8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8d6976b3792cf1ef64d01545929b4d8f">&#9670;&nbsp;</a></span>dnnl_engine_destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_engine_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_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 engine.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">engine</td><td>Engine to destroy. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl>
</div>
</div>
<a id="gadff5935622df99a2f89acb5cbea09ab5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadff5935622df99a2f89acb5cbea09ab5">&#9670;&nbsp;</a></span>dnnl_engine_get_count()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t DNNL_API dnnl_engine_get_count </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga04b3dd9eba628ea02218a52c4c4363a2">dnnl_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 kind.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kind</td><td>Kind of engines to count. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Count of the engines. </dd></dl>
</div>
</div>
<a id="ga8a38bdce17f51616d03310a8e8764c8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8a38bdce17f51616d03310a8e8764c8c">&#9670;&nbsp;</a></span>dnnl_engine_get_kind()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_engine_get_kind </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_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__dnnl__api__engine.html#ga04b3dd9eba628ea02218a52c4c4363a2">dnnl_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 engine.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">engine</td><td>Engine to query. </td></tr>
<tr><td class="paramname">kind</td><td>Output engine kind. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:43 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>