Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / api / cpp / docs / api / classmxnet_1_1SyncedGPUAuxStream.html
blob: 3a48092d025a372cb8223c4d5f1f796001c36700 [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: mxnet::SyncedGPUAuxStream Class 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="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html">SyncedGPUAuxStream</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classmxnet_1_1SyncedGPUAuxStream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::SyncedGPUAuxStream Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Provides automatic coordination of an auxilary stream with a primary one. This object, upon construction, prepares an aux stream for use by syncing it with enqueued primary-stream work. Object destruction will sync again so future primary-stream work will wait on enqueued aux-stream work. If MXNET_GPU_WORKER_NSTREAMS == 1, then this defaults simply: the primary stream will equal the aux stream and the syncs will be executed as nops. See ./src/operator/cudnn/cudnn_convolution-inl.h for a usage example.
<a href="classmxnet_1_1SyncedGPUAuxStream.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="include_2mxnet_2base_8h_source.html">base.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::SyncedGPUAuxStream:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1SyncedGPUAuxStream__coll__graph.png" border="0" usemap="#mxnet_1_1SyncedGPUAuxStream_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:aea10f57259cf765e22e48d3b58777f78"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html#aea10f57259cf765e22e48d3b58777f78">SyncedGPUAuxStream</a> (<a class="el" href="classmxnet_1_1GPUAuxStream.html">GPUAuxStream</a> *gpu_aux_stream)</td></tr>
<tr class="memdesc:aea10f57259cf765e22e48d3b58777f78"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor. <a href="classmxnet_1_1SyncedGPUAuxStream.html#aea10f57259cf765e22e48d3b58777f78">More...</a><br /></td></tr>
<tr class="separator:aea10f57259cf765e22e48d3b58777f78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cb6f54e19a02b05d94daf4454a4d032"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html#a5cb6f54e19a02b05d94daf4454a4d032">~SyncedGPUAuxStream</a> ()</td></tr>
<tr class="memdesc:a5cb6f54e19a02b05d94daf4454a4d032"><td class="mdescLeft">&#160;</td><td class="mdescRight">destructor <a href="classmxnet_1_1SyncedGPUAuxStream.html#a5cb6f54e19a02b05d94daf4454a4d032">More...</a><br /></td></tr>
<tr class="separator:a5cb6f54e19a02b05d94daf4454a4d032"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a7033f8d84c6b0a00ec8d6bcd666103"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html#a4a7033f8d84c6b0a00ec8d6bcd666103">SyncedGPUAuxStream</a> (const <a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html">SyncedGPUAuxStream</a> &amp;)=delete</td></tr>
<tr class="memdesc:a4a7033f8d84c6b0a00ec8d6bcd666103"><td class="mdescLeft">&#160;</td><td class="mdescRight">copy constructor deleted to prevent unexpected synchronizations. <a href="classmxnet_1_1SyncedGPUAuxStream.html#a4a7033f8d84c6b0a00ec8d6bcd666103">More...</a><br /></td></tr>
<tr class="separator:a4a7033f8d84c6b0a00ec8d6bcd666103"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94c6f671ba3e70974690002be4fd631a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html#a94c6f671ba3e70974690002be4fd631a">operator=</a> (const <a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html">SyncedGPUAuxStream</a> &amp;)=delete</td></tr>
<tr class="memdesc:a94c6f671ba3e70974690002be4fd631a"><td class="mdescLeft">&#160;</td><td class="mdescRight">copy assignment operator deleted to prevent unexpected synchronizations. <a href="classmxnet_1_1SyncedGPUAuxStream.html#a94c6f671ba3e70974690002be4fd631a">More...</a><br /></td></tr>
<tr class="separator:a94c6f671ba3e70974690002be4fd631a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa54b1969606473a200db555ccb42616c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html#aa54b1969606473a200db555ccb42616c">SyncedGPUAuxStream</a> (<a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html">SyncedGPUAuxStream</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:aa54b1969606473a200db555ccb42616c"><td class="mdescLeft">&#160;</td><td class="mdescRight">move constructor permitted as alternative to copying. <a href="classmxnet_1_1SyncedGPUAuxStream.html#aa54b1969606473a200db555ccb42616c">More...</a><br /></td></tr>
<tr class="separator:aa54b1969606473a200db555ccb42616c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a551d996093e38842ec8ff48469f908d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html">SyncedGPUAuxStream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html#a551d996093e38842ec8ff48469f908d8">operator=</a> (<a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html">SyncedGPUAuxStream</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:a551d996093e38842ec8ff48469f908d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">move assignment operator permitted as alternative to copy assignment. <a href="classmxnet_1_1SyncedGPUAuxStream.html#a551d996093e38842ec8ff48469f908d8">More...</a><br /></td></tr>
<tr class="separator:a551d996093e38842ec8ff48469f908d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0638a0d262d28d7719dfe23b603a6d2f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>&lt; <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a> &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html#a0638a0d262d28d7719dfe23b603a6d2f">GetStream</a> () const</td></tr>
<tr class="memdesc:a0638a0d262d28d7719dfe23b603a6d2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Getter for underlying <a class="el" href="structmshadow_1_1Stream_3_01gpu_01_4.html">mshadow::Stream&lt;gpu&gt;</a>. <a href="classmxnet_1_1SyncedGPUAuxStream.html#a0638a0d262d28d7719dfe23b603a6d2f">More...</a><br /></td></tr>
<tr class="separator:a0638a0d262d28d7719dfe23b603a6d2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides automatic coordination of an auxilary stream with a primary one. This object, upon construction, prepares an aux stream for use by syncing it with enqueued primary-stream work. Object destruction will sync again so future primary-stream work will wait on enqueued aux-stream work. If MXNET_GPU_WORKER_NSTREAMS == 1, then this defaults simply: the primary stream will equal the aux stream and the syncs will be executed as nops. See ./src/operator/cudnn/cudnn_convolution-inl.h for a usage example. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aea10f57259cf765e22e48d3b58777f78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea10f57259cf765e22e48d3b58777f78">&#9670;&nbsp;</a></span>SyncedGPUAuxStream() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::SyncedGPUAuxStream::SyncedGPUAuxStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1GPUAuxStream.html">GPUAuxStream</a> *&#160;</td>
<td class="paramname"><em>gpu_aux_stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">gpu_aux_stream</td><td>auxilary gpu stream that is managed by this RAII object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5cb6f54e19a02b05d94daf4454a4d032"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5cb6f54e19a02b05d94daf4454a4d032">&#9670;&nbsp;</a></span>~SyncedGPUAuxStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::SyncedGPUAuxStream::~SyncedGPUAuxStream </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>destructor </p>
</div>
</div>
<a id="a4a7033f8d84c6b0a00ec8d6bcd666103"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a7033f8d84c6b0a00ec8d6bcd666103">&#9670;&nbsp;</a></span>SyncedGPUAuxStream() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::SyncedGPUAuxStream::SyncedGPUAuxStream </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html">SyncedGPUAuxStream</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>copy constructor deleted to prevent unexpected synchronizations. </p>
</div>
</div>
<a id="aa54b1969606473a200db555ccb42616c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa54b1969606473a200db555ccb42616c">&#9670;&nbsp;</a></span>SyncedGPUAuxStream() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::SyncedGPUAuxStream::SyncedGPUAuxStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html">SyncedGPUAuxStream</a> &amp;&amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>move constructor permitted as alternative to copying. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0638a0d262d28d7719dfe23b603a6d2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0638a0d262d28d7719dfe23b603a6d2f">&#9670;&nbsp;</a></span>GetStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>&lt;<a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a>&gt;* mxnet::SyncedGPUAuxStream::GetStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Getter for underlying <a class="el" href="structmshadow_1_1Stream_3_01gpu_01_4.html">mshadow::Stream&lt;gpu&gt;</a>. </p>
</div>
</div>
<a id="a94c6f671ba3e70974690002be4fd631a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94c6f671ba3e70974690002be4fd631a">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void mxnet::SyncedGPUAuxStream::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html">SyncedGPUAuxStream</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>copy assignment operator deleted to prevent unexpected synchronizations. </p>
</div>
</div>
<a id="a551d996093e38842ec8ff48469f908d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a551d996093e38842ec8ff48469f908d8">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html">SyncedGPUAuxStream</a>&amp; mxnet::SyncedGPUAuxStream::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1SyncedGPUAuxStream.html">SyncedGPUAuxStream</a> &amp;&amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>move assignment operator permitted as alternative to copy assignment. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/work/mxnet/include/mxnet/<a class="el" href="include_2mxnet_2base_8h_source.html">base.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>