| <!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: mxnet::GPUAuxStream 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.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> |
| <!-- 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_1GPUAuxStream.html">GPUAuxStream</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classmxnet_1_1GPUAuxStream-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::GPUAuxStream Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Holds an auxiliary mshadow gpu stream that can be synced with a primary stream. |
| <a href="classmxnet_1_1GPUAuxStream.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="include_2mxnet_2base_8h_source.html">base.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::GPUAuxStream:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1GPUAuxStream__coll__graph.png" border="0" usemap="#mxnet_1_1GPUAuxStream_coll__map" alt="Collaboration graph"/></div> |
| <map name="mxnet_1_1GPUAuxStream_coll__map" id="mxnet_1_1GPUAuxStream_coll__map"> |
| </map> |
| </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:aaf171cedf3d88ab52b94df5fdaa391bf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1GPUAuxStream.html#aaf171cedf3d88ab52b94df5fdaa391bf">GPUAuxStream</a> (<a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>< <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a> > *primary_stream)</td></tr> |
| <tr class="memdesc:aaf171cedf3d88ab52b94df5fdaa391bf"><td class="mdescLeft"> </td><td class="mdescRight">constructor. <a href="#aaf171cedf3d88ab52b94df5fdaa391bf">More...</a><br /></td></tr> |
| <tr class="separator:aaf171cedf3d88ab52b94df5fdaa391bf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af47783e8d21ce90a42e1f4fc74b01119"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1GPUAuxStream.html#af47783e8d21ce90a42e1f4fc74b01119">~GPUAuxStream</a> ()</td></tr> |
| <tr class="memdesc:af47783e8d21ce90a42e1f4fc74b01119"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="#af47783e8d21ce90a42e1f4fc74b01119">More...</a><br /></td></tr> |
| <tr class="separator:af47783e8d21ce90a42e1f4fc74b01119"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2add80e8e23386df1646434630f405f4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1GPUAuxStream.html#a2add80e8e23386df1646434630f405f4">PreAuxStreamUseSync</a> ()</td></tr> |
| <tr class="memdesc:a2add80e8e23386df1646434630f405f4"><td class="mdescLeft"> </td><td class="mdescRight">Makes future aux stream work wait on the completion of existing primary stream work. <a href="#a2add80e8e23386df1646434630f405f4">More...</a><br /></td></tr> |
| <tr class="separator:a2add80e8e23386df1646434630f405f4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3f103abfadfb2f6d637430b2d92cce7b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1GPUAuxStream.html#a3f103abfadfb2f6d637430b2d92cce7b">PostAuxStreamUseSync</a> ()</td></tr> |
| <tr class="memdesc:a3f103abfadfb2f6d637430b2d92cce7b"><td class="mdescLeft"> </td><td class="mdescRight">Makes future primary stream work wait on the completion of existing aux stream work. <a href="#a3f103abfadfb2f6d637430b2d92cce7b">More...</a><br /></td></tr> |
| <tr class="separator:a3f103abfadfb2f6d637430b2d92cce7b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adb9e0d791fdc2370b946e95007385bb0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>< <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a> > * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1GPUAuxStream.html#adb9e0d791fdc2370b946e95007385bb0">GetStream</a> ()</td></tr> |
| <tr class="memdesc:adb9e0d791fdc2370b946e95007385bb0"><td class="mdescLeft"> </td><td class="mdescRight">Getter for created auxiliary stream. <a href="#adb9e0d791fdc2370b946e95007385bb0">More...</a><br /></td></tr> |
| <tr class="separator:adb9e0d791fdc2370b946e95007385bb0"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a6976536b11894e584f72678213aba993"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1GPUAuxStream.html#a6976536b11894e584f72678213aba993">StreamSync</a> (<a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>< <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a> > *s1, <a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>< <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a> > *s2, cudaEvent_t event)</td></tr> |
| <tr class="memdesc:a6976536b11894e584f72678213aba993"><td class="mdescLeft"> </td><td class="mdescRight">Make future work enqueued to <code>s2</code> wait on completion of current work enqueued to <code>s1</code>. <a href="#a6976536b11894e584f72678213aba993">More...</a><br /></td></tr> |
| <tr class="separator:a6976536b11894e584f72678213aba993"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Holds an auxiliary mshadow gpu stream that can be synced with a primary stream. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="aaf171cedf3d88ab52b94df5fdaa391bf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaf171cedf3d88ab52b94df5fdaa391bf">◆ </a></span>GPUAuxStream()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mxnet::GPUAuxStream::GPUAuxStream </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>< <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a> > * </td> |
| <td class="paramname"><em>primary_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">primary_stream</td><td>gpu stream that is synced with the created auxiliary stream. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="af47783e8d21ce90a42e1f4fc74b01119"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af47783e8d21ce90a42e1f4fc74b01119">◆ </a></span>~GPUAuxStream()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mxnet::GPUAuxStream::~GPUAuxStream </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> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="adb9e0d791fdc2370b946e95007385bb0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adb9e0d791fdc2370b946e95007385bb0">◆ </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><<a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a>>* mxnet::GPUAuxStream::GetStream </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>Getter for created auxiliary stream. </p> |
| |
| </div> |
| </div> |
| <a id="a3f103abfadfb2f6d637430b2d92cce7b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3f103abfadfb2f6d637430b2d92cce7b">◆ </a></span>PostAuxStreamUseSync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mxnet::GPUAuxStream::PostAuxStreamUseSync </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>Makes future primary stream work wait on the completion of existing aux stream work. </p> |
| |
| </div> |
| </div> |
| <a id="a2add80e8e23386df1646434630f405f4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2add80e8e23386df1646434630f405f4">◆ </a></span>PreAuxStreamUseSync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mxnet::GPUAuxStream::PreAuxStreamUseSync </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>Makes future aux stream work wait on the completion of existing primary stream work. </p> |
| |
| </div> |
| </div> |
| <a id="a6976536b11894e584f72678213aba993"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6976536b11894e584f72678213aba993">◆ </a></span>StreamSync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static void mxnet::GPUAuxStream::StreamSync </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>< <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a> > * </td> |
| <td class="paramname"><em>s1</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>< <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a> > * </td> |
| <td class="paramname"><em>s2</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">cudaEvent_t </td> |
| <td class="paramname"><em>event</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Make future work enqueued to <code>s2</code> wait on completion of current work enqueued to <code>s1</code>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">s1</td><td>stream with work that must be completed before future s2 work can begin. </td></tr> |
| <tr><td class="paramname">s2</td><td>stream whose future work is made to wait on the completion of existing s1 work. </td></tr> |
| <tr><td class="paramname">event</td><td>used to pass s1 state to s2. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </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 00:58:44 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
