| <!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.6"/> |
| <title>mxnet: include/mxnet/engine.h Source File</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/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </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 style="padding-left: 0.5em;"> |
| <div id="projectname">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.6 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a></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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1143c7affb9ebd026cb6818dd282def7.html">mxnet</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">engine.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="engine_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#ifndef MXNET_ENGINE_H_</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor"></span><span class="preprocessor">#define MXNET_ENGINE_H_</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <dmlc/base.h></span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#if DMLC_USE_CXX11</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span><span class="preprocessor">#include <algorithm></span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <functional></span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor"></span><span class="preprocessor">#include <vector></span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "<a class="code" href="base_8h.html">./base.h</a>"</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span>mxnet {</div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// forward declare engine</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">class </span>Engine;</div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> |
| <div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1engine.html"> 24</a></span> <span class="keyword">namespace </span>engine {</div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">struct </span>Var;</div> |
| <div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1engine.html#a9d36c4f33eae8531586dc2edf83ae7cf"> 28</a></span> <span class="keyword">struct </span>Opr;</div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">typedef</span> Var* <a class="code" href="namespacemxnet_1_1engine.html#a9d36c4f33eae8531586dc2edf83ae7cf">VarHandle</a>;</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1engine.html#a2d9b14b658e3f3c4e03ca49cd38ace94"> 32</a></span> <span class="keyword">typedef</span> Opr* <a class="code" href="namespacemxnet_1_1engine.html#a2d9b14b658e3f3c4e03ca49cd38ace94">OprHandle</a>;</div> |
| <div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classmxnet_1_1engine_1_1CallbackOnComplete.html"> 37</a></span> <span class="keyword">class </span><a class="code" href="classmxnet_1_1engine_1_1CallbackOnComplete.html">CallbackOnComplete</a> {</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="comment">// use implicit copy and assign</span></div> |
| <div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classmxnet_1_1engine_1_1CallbackOnComplete.html#a97abc3d705870669f303ee22a1342d4a"> 41</a></span> <span class="comment"></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1engine_1_1CallbackOnComplete.html#a97abc3d705870669f303ee22a1342d4a">operator()</a>()<span class="keyword"> const </span>{</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  (*callback_)(engine_, param_);</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  }</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classmxnet_1_1engine_1_1CallbackOnComplete.html#aa365d0be0a3a369cdc5da59787f93297"> 47</a></span>  <span class="keyword">friend</span> class ::mxnet::Engine;</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  void (*callback_)(<a class="code" href="classmxnet_1_1Engine.html">Engine</a> *, <span class="keywordtype">void</span> *);</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="classmxnet_1_1Engine.html">Engine</a>* engine_;</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span>* param_;</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> };</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> } <span class="comment">// namespace engine</span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#if DMLC_USE_CXX11</span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3b"> 59</a></span> <span class="keyword">enum class</span> <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3b">FnProperty</a> {</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba07fa7a19aa722c635a15e94cb7f50416">kNormal</a>,</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba739f2f416f05f4728c217f09e93958d1">kCopyFromGPU</a>,</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba6cd75f41e0ec8d61b0a2f0e20ef6d1e8">kCopyToGPU</a>,</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3bac41ceb98eeb9b2e208e3e242a7357142">kCPUPrioritized</a>,</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba9f2b960005d2a3a5f35ac32809d84db7">kAsync</a></div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> }; <span class="comment">// enum class FnProperty</span></div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> |
| <div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html"> 75</a></span> <span class="keyword">class </span><a class="code" href="base_8h.html#a91a09948aaaffa1eb64508db79009a05">MXNET_API</a> <a class="code" href="classmxnet_1_1Engine.html">Engine</a> {</div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#a16b757432556f835d27f1b5e1dbe1b06"> 78</a></span>  <span class="keyword">typedef</span> <a class="code" href="classmxnet_1_1engine_1_1CallbackOnComplete.html">engine::CallbackOnComplete</a> <a class="code" href="classmxnet_1_1Engine.html#a16b757432556f835d27f1b5e1dbe1b06">CallbackOnComplete</a>;</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#a07f30ab85fca436e1bbcc72cd4d8bb35"> 80</a></span>  <span class="keyword">typedef</span> std::function<void(RunContext)> <a class="code" href="classmxnet_1_1Engine.html#a07f30ab85fca436e1bbcc72cd4d8bb35">SyncFn</a>;</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#ad41feff70bba0f29fc24f60b5381984c"> 82</a></span>  <span class="keyword">typedef</span> std::function<void(RunContext, CallbackOnComplete)> <a class="code" href="classmxnet_1_1Engine.html#ad41feff70bba0f29fc24f60b5381984c">AsyncFn</a>;</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#aac31510c793a12944c33f9cac6150491"> 84</a></span>  <span class="keyword">typedef</span> <a class="code" href="namespacemxnet_1_1engine.html#a9d36c4f33eae8531586dc2edf83ae7cf">engine::VarHandle</a> <a class="code" href="classmxnet_1_1Engine.html#aac31510c793a12944c33f9cac6150491">VarHandle</a>;</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#a832436e413a075291aa1a631942c3f01"> 86</a></span>  <span class="keyword">typedef</span> <a class="code" href="namespacemxnet_1_1engine.html#a2d9b14b658e3f3c4e03ca49cd38ace94">engine::OprHandle</a> <a class="code" href="classmxnet_1_1Engine.html#a832436e413a075291aa1a631942c3f01">OprHandle</a>;</div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> NotifyShutdown() = 0;</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">virtual</span> <a class="code" href="classmxnet_1_1Engine.html#aac31510c793a12944c33f9cac6150491">VarHandle</a> NewVariable() = 0;</div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">virtual</span> <a class="code" href="classmxnet_1_1Engine.html#a832436e413a075291aa1a631942c3f01">OprHandle</a> NewOperator(<a class="code" href="classmxnet_1_1Engine.html#ad41feff70bba0f29fc24f60b5381984c">AsyncFn</a> fn,</div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  std::vector<VarHandle> <span class="keyword">const</span>& const_vars,</div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  std::vector<VarHandle> <span class="keyword">const</span>& mutable_vars,</div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3b">FnProperty</a> prop = <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba07fa7a19aa722c635a15e94cb7f50416">FnProperty::kNormal</a>,</div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* opr_name = <span class="keyword">nullptr</span>) = 0;</div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> DeleteOperator(<a class="code" href="classmxnet_1_1Engine.html#a832436e413a075291aa1a631942c3f01">OprHandle</a> op) = 0;</div> |
| <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Push(<a class="code" href="classmxnet_1_1Engine.html#a832436e413a075291aa1a631942c3f01">OprHandle</a> op, <a class="code" href="structmxnet_1_1Context.html">Context</a> exec_ctx, <span class="keywordtype">int</span> priority = 0, <span class="keywordtype">bool</span> profiling = <span class="keyword">false</span>) = 0;</div> |
| <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> PushAsync(<a class="code" href="classmxnet_1_1Engine.html#ad41feff70bba0f29fc24f60b5381984c">AsyncFn</a> exec_fun, <a class="code" href="structmxnet_1_1Context.html">Context</a> exec_ctx,</div> |
| <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  std::vector<VarHandle> <span class="keyword">const</span>& const_vars,</div> |
| <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  std::vector<VarHandle> <span class="keyword">const</span>& mutable_vars,</div> |
| <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3b">FnProperty</a> prop = <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba07fa7a19aa722c635a15e94cb7f50416">FnProperty::kNormal</a>,</div> |
| <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keywordtype">int</span> priority = 0,</div> |
| <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* opr_name = <span class="keyword">nullptr</span>) = 0;</div> |
| <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> DeleteVariable(<a class="code" href="classmxnet_1_1Engine.html#a07f30ab85fca436e1bbcc72cd4d8bb35">SyncFn</a> delete_fn,</div> |
| <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <a class="code" href="structmxnet_1_1Context.html">Context</a> exec_ctx,</div> |
| <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <a class="code" href="classmxnet_1_1Engine.html#aac31510c793a12944c33f9cac6150491">VarHandle</a> var) = 0;</div> |
| <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> WaitForVar(<a class="code" href="classmxnet_1_1Engine.html#aac31510c793a12944c33f9cac6150491">VarHandle</a> var) = 0;</div> |
| <div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> WaitForAll() = 0;</div> |
| <div class="line"><a name="l00178"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#aff025321827e15096c02342225f2395b"> 178</a></span>  <span class="keyword">virtual</span> <a class="code" href="classmxnet_1_1Engine.html#aff025321827e15096c02342225f2395b">~Engine</a>() noexcept(false) {}</div> |
| <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keyword">static</span> <a class="code" href="classmxnet_1_1Engine.html">Engine</a>* Get();</div> |
| <div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="keyword">static</span> std::shared_ptr<Engine> _GetSharedRef();</div> |
| <div class="line"><a name="l00204"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#a1c2f38927e4bf7a62e23353b0bd3d619"> 204</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1Engine.html#a1c2f38927e4bf7a62e23353b0bd3d619">PushSync</a>(<a class="code" href="classmxnet_1_1Engine.html#a07f30ab85fca436e1bbcc72cd4d8bb35">SyncFn</a> exec_fn, <a class="code" href="structmxnet_1_1Context.html">Context</a> exec_ctx,</div> |
| <div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  std::vector<VarHandle> <span class="keyword">const</span>& const_vars,</div> |
| <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  std::vector<VarHandle> <span class="keyword">const</span>& mutable_vars,</div> |
| <div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3b">FnProperty</a> prop = <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba07fa7a19aa722c635a15e94cb7f50416">FnProperty::kNormal</a>,</div> |
| <div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  <span class="keywordtype">int</span> priority = 0,</div> |
| <div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* opr_name = <span class="keyword">nullptr</span>) {</div> |
| <div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  this->PushAsync([exec_fn](<a class="code" href="structmxnet_1_1RunContext.html">RunContext</a> ctx, <a class="code" href="classmxnet_1_1engine_1_1CallbackOnComplete.html">CallbackOnComplete</a> on_complete) {</div> |
| <div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  exec_fn(ctx);</div> |
| <div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  on_complete();</div> |
| <div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  }, exec_ctx, const_vars, mutable_vars, prop, priority, opr_name);</div> |
| <div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  }</div> |
| <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> </div> |
| <div class="line"><a name="l00221"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#acf25be815b4200b48ee6e4e169bf95b8"> 221</a></span>  <span class="keyword">inline</span> <a class="code" href="classmxnet_1_1engine_1_1CallbackOnComplete.html">CallbackOnComplete</a> <a class="code" href="classmxnet_1_1Engine.html#acf25be815b4200b48ee6e4e169bf95b8">CreateCallback</a>(</div> |
| <div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <span class="keywordtype">void</span> (*callback)(<a class="code" href="classmxnet_1_1Engine.html">Engine</a> *, <span class="keywordtype">void</span> *), <span class="keywordtype">void</span> *param) {</div> |
| <div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <a class="code" href="classmxnet_1_1engine_1_1CallbackOnComplete.html">CallbackOnComplete</a> ret;</div> |
| <div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  ret.callback_ = callback;</div> |
| <div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  ret.engine_ = <span class="keyword">this</span>;</div> |
| <div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  ret.param_ = param;</div> |
| <div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keywordflow">return</span> ret;</div> |
| <div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  }</div> |
| <div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  <span class="comment">// For each var vector, sort it and remove the duplicated vars.</span></div> |
| <div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <span class="comment">// Also remove vars from read_vars if it also appears in write_vars</span></div> |
| <div class="line"><a name="l00231"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#a9d8ac1987a6844dba9b0463030fb3430"> 231</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1Engine.html#a9d8ac1987a6844dba9b0463030fb3430">DeduplicateVarHandle</a>(std::vector<engine::VarHandle> *read_vars,</div> |
| <div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  std::vector<engine::VarHandle> *write_vars) {</div> |
| <div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  std::sort(write_vars->begin(), write_vars->end());</div> |
| <div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  write_vars->resize(std::unique(write_vars->begin(), write_vars->end()) -</div> |
| <div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  write_vars->begin());</div> |
| <div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  std::sort(read_vars->begin(), read_vars->end());</div> |
| <div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  read_vars->resize(std::unique(read_vars->begin(), read_vars->end()) -</div> |
| <div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  read_vars->begin());</div> |
| <div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <span class="keyword">auto</span> wit = write_vars->begin();</div> |
| <div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="keyword">auto</span> rtop = read_vars->begin();</div> |
| <div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span> rit = read_vars->begin(); rit != read_vars->end(); ++rit) {</div> |
| <div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <span class="keywordflow">while</span> (wit != write_vars->end() && *wit < *rit) ++wit;</div> |
| <div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <span class="keywordflow">if</span> (wit == write_vars->end() || *wit != *rit) {</div> |
| <div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  *rtop = *rit;</div> |
| <div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  ++rtop;</div> |
| <div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  }</div> |
| <div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  }</div> |
| <div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  read_vars->resize(rtop - read_vars->begin());</div> |
| <div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  }</div> |
| <div class="line"><a name="l00250"></a><span class="lineno"> 250</span> }; <span class="comment">// class Engine</span></div> |
| <div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="preprocessor">#endif // DMLC_USE_CXX11</span></div> |
| <div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="preprocessor"></span>} <span class="comment">// namespace mxnet</span></div> |
| <div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="preprocessor">#endif // MXNET_ENGINE_H_</span></div> |
| <div class="ttc" id="classmxnet_1_1Engine_html_a9d8ac1987a6844dba9b0463030fb3430"><div class="ttname"><a href="classmxnet_1_1Engine.html#a9d8ac1987a6844dba9b0463030fb3430">mxnet::Engine::DeduplicateVarHandle</a></div><div class="ttdeci">void DeduplicateVarHandle(std::vector< engine::VarHandle > *read_vars, std::vector< engine::VarHandle > *write_vars)</div><div class="ttdef"><b>Definition:</b> engine.h:231</div></div> |
| <div class="ttc" id="namespacemxnet_html_a998b74220fab2b012cf8a179650e1b3b"><div class="ttname"><a href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3b">mxnet::FnProperty</a></div><div class="ttdeci">FnProperty</div><div class="ttdoc">Function property, used to hint what action is pushed to engine. </div><div class="ttdef"><b>Definition:</b> engine.h:59</div></div> |
| <div class="ttc" id="classmxnet_1_1Engine_html_a07f30ab85fca436e1bbcc72cd4d8bb35"><div class="ttname"><a href="classmxnet_1_1Engine.html#a07f30ab85fca436e1bbcc72cd4d8bb35">mxnet::Engine::SyncFn</a></div><div class="ttdeci">std::function< void(RunContext)> SyncFn</div><div class="ttdoc">Synchronous operation to pass to engine. </div><div class="ttdef"><b>Definition:</b> engine.h:80</div></div> |
| <div class="ttc" id="classmxnet_1_1Engine_html_ad41feff70bba0f29fc24f60b5381984c"><div class="ttname"><a href="classmxnet_1_1Engine.html#ad41feff70bba0f29fc24f60b5381984c">mxnet::Engine::AsyncFn</a></div><div class="ttdeci">std::function< void(RunContext, CallbackOnComplete)> AsyncFn</div><div class="ttdoc">Asynchronous operation to pass to engine. </div><div class="ttdef"><b>Definition:</b> engine.h:82</div></div> |
| <div class="ttc" id="namespacemxnet_html_a998b74220fab2b012cf8a179650e1b3ba9f2b960005d2a3a5f35ac32809d84db7"><div class="ttname"><a href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba9f2b960005d2a3a5f35ac32809d84db7">mxnet::FnProperty::kAsync</a></div><div class="ttdoc">Asynchronous function call. </div></div> |
| <div class="ttc" id="classmxnet_1_1Engine_html_acf25be815b4200b48ee6e4e169bf95b8"><div class="ttname"><a href="classmxnet_1_1Engine.html#acf25be815b4200b48ee6e4e169bf95b8">mxnet::Engine::CreateCallback</a></div><div class="ttdeci">CallbackOnComplete CreateCallback(void(*callback)(Engine *, void *), void *param)</div><div class="ttdoc">factory function to create OnComplete callback. </div><div class="ttdef"><b>Definition:</b> engine.h:221</div></div> |
| <div class="ttc" id="classmxnet_1_1engine_1_1CallbackOnComplete_html_a97abc3d705870669f303ee22a1342d4a"><div class="ttname"><a href="classmxnet_1_1engine_1_1CallbackOnComplete.html#a97abc3d705870669f303ee22a1342d4a">mxnet::engine::CallbackOnComplete::operator()</a></div><div class="ttdeci">void operator()() const </div><div class="ttdoc">involve the callback </div><div class="ttdef"><b>Definition:</b> engine.h:41</div></div> |
| <div class="ttc" id="structmxnet_1_1RunContext_html"><div class="ttname"><a href="structmxnet_1_1RunContext.html">mxnet::RunContext</a></div><div class="ttdoc">execution time context. The information needed in runtime for actual execution. </div><div class="ttdef"><b>Definition:</b> base.h:213</div></div> |
| <div class="ttc" id="namespacemxnet_html_a998b74220fab2b012cf8a179650e1b3ba07fa7a19aa722c635a15e94cb7f50416"><div class="ttname"><a href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba07fa7a19aa722c635a15e94cb7f50416">mxnet::FnProperty::kNormal</a></div><div class="ttdoc">Normal operation. </div></div> |
| <div class="ttc" id="classmxnet_1_1Engine_html_aff025321827e15096c02342225f2395b"><div class="ttname"><a href="classmxnet_1_1Engine.html#aff025321827e15096c02342225f2395b">mxnet::Engine::~Engine</a></div><div class="ttdeci">virtual ~Engine() noexcept(false)</div><div class="ttdoc">virtual destructor </div><div class="ttdef"><b>Definition:</b> engine.h:178</div></div> |
| <div class="ttc" id="base_8h_html_a91a09948aaaffa1eb64508db79009a05"><div class="ttname"><a href="base_8h.html#a91a09948aaaffa1eb64508db79009a05">MXNET_API</a></div><div class="ttdeci">#define MXNET_API</div><div class="ttdoc">define compatible keywords in g++ Used to support g++-4.6 and g++4.7 </div><div class="ttdef"><b>Definition:</b> base.h:66</div></div> |
| <div class="ttc" id="namespacemxnet_html_a998b74220fab2b012cf8a179650e1b3ba739f2f416f05f4728c217f09e93958d1"><div class="ttname"><a href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba739f2f416f05f4728c217f09e93958d1">mxnet::FnProperty::kCopyFromGPU</a></div><div class="ttdoc">Copy operation from GPU to other devices. </div></div> |
| <div class="ttc" id="classmxnet_1_1Engine_html_a832436e413a075291aa1a631942c3f01"><div class="ttname"><a href="classmxnet_1_1Engine.html#a832436e413a075291aa1a631942c3f01">mxnet::Engine::OprHandle</a></div><div class="ttdeci">engine::OprHandle OprHandle</div><div class="ttdoc">Operator pointer. </div><div class="ttdef"><b>Definition:</b> engine.h:86</div></div> |
| <div class="ttc" id="classmxnet_1_1Engine_html_aac31510c793a12944c33f9cac6150491"><div class="ttname"><a href="classmxnet_1_1Engine.html#aac31510c793a12944c33f9cac6150491">mxnet::Engine::VarHandle</a></div><div class="ttdeci">engine::VarHandle VarHandle</div><div class="ttdoc">Variable pointer. </div><div class="ttdef"><b>Definition:</b> engine.h:84</div></div> |
| <div class="ttc" id="namespacemxnet_1_1engine_html_a9d36c4f33eae8531586dc2edf83ae7cf"><div class="ttname"><a href="namespacemxnet_1_1engine.html#a9d36c4f33eae8531586dc2edf83ae7cf">mxnet::engine::VarHandle</a></div><div class="ttdeci">Var * VarHandle</div><div class="ttdoc">Variable pointer type, usually hold by user used to specify dependencies. </div><div class="ttdef"><b>Definition:</b> engine.h:28</div></div> |
| <div class="ttc" id="namespacemxnet_html_a998b74220fab2b012cf8a179650e1b3bac41ceb98eeb9b2e208e3e242a7357142"><div class="ttname"><a href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3bac41ceb98eeb9b2e208e3e242a7357142">mxnet::FnProperty::kCPUPrioritized</a></div><div class="ttdoc">Prioritized sync operation on CPU. </div></div> |
| <div class="ttc" id="classmxnet_1_1Engine_html_a16b757432556f835d27f1b5e1dbe1b06"><div class="ttname"><a href="classmxnet_1_1Engine.html#a16b757432556f835d27f1b5e1dbe1b06">mxnet::Engine::CallbackOnComplete</a></div><div class="ttdeci">engine::CallbackOnComplete CallbackOnComplete</div><div class="ttdoc">callback on complete </div><div class="ttdef"><b>Definition:</b> engine.h:78</div></div> |
| <div class="ttc" id="classmxnet_1_1Engine_html_a1c2f38927e4bf7a62e23353b0bd3d619"><div class="ttname"><a href="classmxnet_1_1Engine.html#a1c2f38927e4bf7a62e23353b0bd3d619">mxnet::Engine::PushSync</a></div><div class="ttdeci">void PushSync(SyncFn exec_fn, Context exec_ctx, std::vector< VarHandle > const &const_vars, std::vector< VarHandle > const &mutable_vars, FnProperty prop=FnProperty::kNormal, int priority=0, const char *opr_name=nullptr)</div><div class="ttdoc">Push an synchronous operation to the engine. </div><div class="ttdef"><b>Definition:</b> engine.h:204</div></div> |
| <div class="ttc" id="classmxnet_1_1Engine_html"><div class="ttname"><a href="classmxnet_1_1Engine.html">mxnet::Engine</a></div><div class="ttdoc">Dependency engine that schedules operations. </div><div class="ttdef"><b>Definition:</b> engine.h:75</div></div> |
| <div class="ttc" id="classmxnet_1_1engine_1_1CallbackOnComplete_html"><div class="ttname"><a href="classmxnet_1_1engine_1_1CallbackOnComplete.html">mxnet::engine::CallbackOnComplete</a></div><div class="ttdoc">OnComplete Callback to the engine, called by AsyncFn when action completes. </div><div class="ttdef"><b>Definition:</b> engine.h:37</div></div> |
| <div class="ttc" id="base_8h_html"><div class="ttname"><a href="base_8h.html">base.h</a></div><div class="ttdoc">configuation of mxnet as well as basic data structure. </div></div> |
| <div class="ttc" id="structmxnet_1_1Context_html"><div class="ttname"><a href="structmxnet_1_1Context.html">mxnet::Context</a></div><div class="ttdoc">Context information about the execution environment. </div><div class="ttdef"><b>Definition:</b> base.h:116</div></div> |
| <div class="ttc" id="namespacemxnet_html_a998b74220fab2b012cf8a179650e1b3ba6cd75f41e0ec8d61b0a2f0e20ef6d1e8"><div class="ttname"><a href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba6cd75f41e0ec8d61b0a2f0e20ef6d1e8">mxnet::FnProperty::kCopyToGPU</a></div><div class="ttdoc">Copy operation from CPU to other devices. </div></div> |
| <div class="ttc" id="namespacemxnet_1_1engine_html_a2d9b14b658e3f3c4e03ca49cd38ace94"><div class="ttname"><a href="namespacemxnet_1_1engine.html#a2d9b14b658e3f3c4e03ca49cd38ace94">mxnet::engine::OprHandle</a></div><div class="ttdeci">Opr * OprHandle</div><div class="ttdoc">Operator pointer type, usually hold by user. </div><div class="ttdef"><b>Definition:</b> engine.h:32</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Sun Aug 6 2017 07:14:31 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.6 |
| </small></address> |
| </body> |
| </html> |
