blob: e1eb57b92d8aca2c2d9e9825e7a5d49b7bd9ddd7 [file] [log] [blame]
<!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: mshadow::Stream&lt; Device &gt; Struct Template Reference</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&amp;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&amp;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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemshadow.html">mshadow</a></li><li class="navelem"><a class="el" href="structmshadow_1_1Stream.html">Stream</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structmshadow_1_1Stream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mshadow::Stream&lt; Device &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>computaion stream structure, used for asynchronous computations
<a href="structmshadow_1_1Stream.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="tensor_8h_source.html">tensor.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mshadow::Stream&lt; Device &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structmshadow_1_1Stream__coll__graph.png" border="0" usemap="#mshadow_1_1Stream_3_01Device_01_4_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 0 -->
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab17a2b049aacf5d71d8860262c4a98fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Stream.html#ab17a2b049aacf5d71d8860262c4a98fd">Wait</a> (void)</td></tr>
<tr class="memdesc:ab17a2b049aacf5d71d8860262c4a98fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">wait for all the computations associated with this stream to complete <a href="structmshadow_1_1Stream.html#ab17a2b049aacf5d71d8860262c4a98fd">More...</a><br /></td></tr>
<tr class="separator:ab17a2b049aacf5d71d8860262c4a98fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e5f0ac7f35dc725d6d03623a3cb454b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Stream.html#a7e5f0ac7f35dc725d6d03623a3cb454b">CheckIdle</a> (void)</td></tr>
<tr class="memdesc:a7e5f0ac7f35dc725d6d03623a3cb454b"><td class="mdescLeft">&#160;</td><td class="mdescRight">query whether the the stream is idle <a href="structmshadow_1_1Stream.html#a7e5f0ac7f35dc725d6d03623a3cb454b">More...</a><br /></td></tr>
<tr class="separator:a7e5f0ac7f35dc725d6d03623a3cb454b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20c547a7a44d975f23bad59d4c45f482"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Stream.html#a20c547a7a44d975f23bad59d4c45f482">CreateBlasHandle</a> ()</td></tr>
<tr class="memdesc:a20c547a7a44d975f23bad59d4c45f482"><td class="mdescLeft">&#160;</td><td class="mdescRight">create a blas handle <a href="structmshadow_1_1Stream.html#a20c547a7a44d975f23bad59d4c45f482">More...</a><br /></td></tr>
<tr class="separator:a20c547a7a44d975f23bad59d4c45f482"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Device&gt;<br />
struct mshadow::Stream&lt; Device &gt;</h3>
<p>computaion stream structure, used for asynchronous computations </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a7e5f0ac7f35dc725d6d03623a3cb454b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e5f0ac7f35dc725d6d03623a3cb454b">&#9670;&nbsp;</a></span>CheckIdle()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Device &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>&lt; Device &gt;::CheckIdle </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>query whether the the stream is idle </p>
<dl class="section return"><dt>Returns</dt><dd>true if the stream is idle and all the jobs have been completed </dd></dl>
</div>
</div>
<a id="a20c547a7a44d975f23bad59d4c45f482"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20c547a7a44d975f23bad59d4c45f482">&#9670;&nbsp;</a></span>CreateBlasHandle()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Device &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>&lt; Device &gt;::CreateBlasHandle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>create a blas handle </p>
</div>
</div>
<a id="ab17a2b049aacf5d71d8860262c4a98fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab17a2b049aacf5d71d8860262c4a98fd">&#9670;&nbsp;</a></span>Wait()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Device &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>&lt; Device &gt;::Wait </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>wait for all the computations associated with this stream to complete </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/work/mxnet/3rdparty/mshadow/mshadow/<a class="el" href="tensor_8h_source.html">tensor.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:41 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>