| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: Dnnl_api_stream</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.17 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</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> | |
| <a href="#typedef-members">Typedefs</a> | |
| <a href="#enum-members">Enumerations</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">Dnnl_api_stream<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_stream:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="group__dnnl__api__stream.png" border="0" usemap="#group____dnnl____api____stream" alt=""/></div> |
| <!-- MAP 0 --> |
| </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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__stream.html">dnnl_stream</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </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:ga735eb19cfd205c108c468b5657de4eca"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structdnnl__stream.html">dnnl_stream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a></td></tr> |
| <tr class="memdesc:ga735eb19cfd205c108c468b5657de4eca"><td class="mdescLeft"> </td><td class="mdescRight">An execution stream handle. <a href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">More...</a><br /></td></tr> |
| <tr class="separator:ga735eb19cfd205c108c468b5657de4eca"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaeac91f003af4e2138c84082acc126c36"><td class="memItemLeft" align="right" valign="top">typedef const struct <a class="el" href="structdnnl__stream.html">dnnl_stream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__stream.html#gaeac91f003af4e2138c84082acc126c36">const_dnnl_stream_t</a></td></tr> |
| <tr class="memdesc:gaeac91f003af4e2138c84082acc126c36"><td class="mdescLeft"> </td><td class="mdescRight">A constant execution stream handle. <a href="group__dnnl__api__stream.html#gaeac91f003af4e2138c84082acc126c36">More...</a><br /></td></tr> |
| <tr class="separator:gaeac91f003af4e2138c84082acc126c36"><td class="memSeparator" colspan="2"> </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:ga3d74cfed8fe92b0e4498a1f2bdab5547"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__stream.html#ga3d74cfed8fe92b0e4498a1f2bdab5547">dnnl_stream_flags_t</a> { <a class="el" href="group__dnnl__api__stream.html#gga3d74cfed8fe92b0e4498a1f2bdab5547a4cb57d18d4769548e671aaff38a80478">dnnl_stream_in_order</a> = 0x1U, |
| <a class="el" href="group__dnnl__api__stream.html#gga3d74cfed8fe92b0e4498a1f2bdab5547a8e9e057b28a7898a9b52120b8c7bd356">dnnl_stream_out_of_order</a> = 0x2U, |
| <a class="el" href="group__dnnl__api__stream.html#gga3d74cfed8fe92b0e4498a1f2bdab5547acf05c543bccebd58e6d4e0db7137fb92">dnnl_stream_default_flags</a> = dnnl_stream_in_order |
| }</td></tr> |
| <tr class="memdesc:ga3d74cfed8fe92b0e4498a1f2bdab5547"><td class="mdescLeft"> </td><td class="mdescRight">Stream flags. <a href="group__dnnl__api__stream.html#ga3d74cfed8fe92b0e4498a1f2bdab5547">More...</a><br /></td></tr> |
| <tr class="separator:ga3d74cfed8fe92b0e4498a1f2bdab5547"><td class="memSeparator" colspan="2"> </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:gaefca700bdec59b22c05f248df5bb3354"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__stream.html#gaefca700bdec59b22c05f248df5bb3354">dnnl_stream_create</a> (<a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> *stream, <a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> engine, unsigned flags)</td></tr> |
| <tr class="separator:gaefca700bdec59b22c05f248df5bb3354"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga817016eb87a4d87a889f32b52b71a93b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__stream.html#ga817016eb87a4d87a889f32b52b71a93b">dnnl_stream_get_engine</a> (<a class="el" href="group__dnnl__api__stream.html#gaeac91f003af4e2138c84082acc126c36">const_dnnl_stream_t</a> stream, <a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> *engine)</td></tr> |
| <tr class="separator:ga817016eb87a4d87a889f32b52b71a93b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga6a8175b9384349b1ee73a78a24b5883f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__stream.html#ga6a8175b9384349b1ee73a78a24b5883f">dnnl_stream_wait</a> (<a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> stream)</td></tr> |
| <tr class="separator:ga6a8175b9384349b1ee73a78a24b5883f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gae7fe8b23136cafa62a39301799cd6e44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__stream.html#gae7fe8b23136cafa62a39301799cd6e44">dnnl_stream_destroy</a> (<a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> stream)</td></tr> |
| <tr class="separator:gae7fe8b23136cafa62a39301799cd6e44"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <h2 class="groupheader">Typedef Documentation</h2> |
| <a id="gaeac91f003af4e2138c84082acc126c36"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gaeac91f003af4e2138c84082acc126c36">◆ </a></span>const_dnnl_stream_t</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef const struct <a class="el" href="structdnnl__stream.html">dnnl_stream</a>* <a class="el" href="group__dnnl__api__stream.html#gaeac91f003af4e2138c84082acc126c36">const_dnnl_stream_t</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>A constant execution stream handle. </p> |
| |
| </div> |
| </div> |
| <a id="ga735eb19cfd205c108c468b5657de4eca"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga735eb19cfd205c108c468b5657de4eca">◆ </a></span>dnnl_stream_t</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef struct <a class="el" href="structdnnl__stream.html">dnnl_stream</a>* <a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>An execution stream handle. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Enumeration Type Documentation</h2> |
| <a id="ga3d74cfed8fe92b0e4498a1f2bdab5547"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga3d74cfed8fe92b0e4498a1f2bdab5547">◆ </a></span>dnnl_stream_flags_t</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="group__dnnl__api__stream.html#ga3d74cfed8fe92b0e4498a1f2bdab5547">dnnl_stream_flags_t</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Stream flags. </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga3d74cfed8fe92b0e4498a1f2bdab5547a4cb57d18d4769548e671aaff38a80478"></a>dnnl_stream_in_order </td><td class="fielddoc"></td></tr> |
| <tr><td class="fieldname"><a id="gga3d74cfed8fe92b0e4498a1f2bdab5547a8e9e057b28a7898a9b52120b8c7bd356"></a>dnnl_stream_out_of_order </td><td class="fielddoc"><p>Out-of-order execution. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="gga3d74cfed8fe92b0e4498a1f2bdab5547acf05c543bccebd58e6d4e0db7137fb92"></a>dnnl_stream_default_flags </td><td class="fielddoc"><p>Default stream configuration. </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="gaefca700bdec59b22c05f248df5bb3354"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gaefca700bdec59b22c05f248df5bb3354">◆ </a></span>dnnl_stream_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_stream_create </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> * </td> |
| <td class="paramname"><em>stream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> </td> |
| <td class="paramname"><em>engine</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">unsigned </td> |
| <td class="paramname"><em>flags</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Creates an execution stream.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>Output execution stream. </td></tr> |
| <tr><td class="paramname">engine</td><td>Engine to create the execution stream on. </td></tr> |
| <tr><td class="paramname">flags</td><td>Stream behavior flags (</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__dnnl__api__stream.html#ga3d74cfed8fe92b0e4498a1f2bdab5547" title="Stream flags.">dnnl_stream_flags_t</a>). </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="gae7fe8b23136cafa62a39301799cd6e44"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gae7fe8b23136cafa62a39301799cd6e44">◆ </a></span>dnnl_stream_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_stream_destroy </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> </td> |
| <td class="paramname"><em>stream</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Destroys an execution stream.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>Execution stream 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="ga817016eb87a4d87a889f32b52b71a93b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga817016eb87a4d87a889f32b52b71a93b">◆ </a></span>dnnl_stream_get_engine()</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_stream_get_engine </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__stream.html#gaeac91f003af4e2138c84082acc126c36">const_dnnl_stream_t</a> </td> |
| <td class="paramname"><em>stream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> * </td> |
| <td class="paramname"><em>engine</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Returns the engine of a stream object.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>Stream object. </td></tr> |
| <tr><td class="paramname">engine</td><td>Output engine on which the stream is created. </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="ga6a8175b9384349b1ee73a78a24b5883f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga6a8175b9384349b1ee73a78a24b5883f">◆ </a></span>dnnl_stream_wait()</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_stream_wait </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> </td> |
| <td class="paramname"><em>stream</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Waits for all primitives in the execution stream to finish computations.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>Execution stream. </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 03:47:40 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |