blob: e807fd12450a753e22bf1ea40418601a5b5ecf3f [file] [log] [blame]
<!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 content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/>
<meta content="IE=9" http-equiv="X-UA-Compatible"/>
<meta content="Doxygen 1.8.6" name="generator"/>
<title>mxnet: include/mxnet/engine.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script src="jquery.js" type="text/javascript"></script>
<script src="dynsections.js" type="text/javascript"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script src="search/search.js" type="text/javascript"></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 cellpadding="0" cellspacing="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 class="tabs" id="navrow1">
<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 class="MSearchBoxInactive" id="MSearchBox">
<span class="left">
<img alt="" id="MSearchSelect" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()" src="search/mag_sel.png"/>
<input accesskey="S" id="MSearchField" onblur="searchBox.OnSearchFieldFocus(false)" onfocus="searchBox.OnSearchFieldFocus(true)" onkeyup="searchBox.OnSearchFieldChange(event)" type="text" value="Search"/>
</span><span class="right">
<a href="javascript:searchBox.CloseResultsWindow()" id="MSearchClose"><img alt="" border="0" id="MSearchCloseImg" src="search/close.png"/></a>
</span>
</div>
</li>
</ul>
</div>
<div class="tabs2" id="navrow2">
<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" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()">
<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 frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)">
</iframe>
</div>
<div class="navpath" id="nav-path">
<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> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * under the License.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef MXNET_ENGINE_H_</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span><span class="preprocessor">#define MXNET_ENGINE_H_</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include &lt;dmlc/base.h&gt;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#if DMLC_USE_CXX11</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span><span class="preprocessor">#include &lt;algorithm&gt;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include &lt;functional&gt;</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "<a class="code" href="base_8h.html">./base.h</a>"</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">namespace </span>mxnet {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// forward declare engine</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">class </span>Engine;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1engine.html"> 43</a></span> <span class="keyword">namespace </span>engine {</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">struct </span>Var;</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1engine.html#a9d36c4f33eae8531586dc2edf83ae7cf"> 47</a></span> <span class="keyword">struct </span>Opr;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">typedef</span> Var* <a class="code" href="namespacemxnet_1_1engine.html#a9d36c4f33eae8531586dc2edf83ae7cf">VarHandle</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1engine.html#a2d9b14b658e3f3c4e03ca49cd38ace94"> 51</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="l00056"></a><span class="lineno"><a class="line" href="classmxnet_1_1engine_1_1CallbackOnComplete.html"> 56</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="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// use implicit copy and assign</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classmxnet_1_1engine_1_1CallbackOnComplete.html#a97abc3d705870669f303ee22a1342d4a"> 60</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="l00061"></a><span class="lineno"> 61</span>  (*callback_)(engine_, param_);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classmxnet_1_1engine_1_1CallbackOnComplete.html#aa365d0be0a3a369cdc5da59787f93297"> 66</a></span>  <span class="keyword">friend</span> class ::mxnet::Engine;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  void (*callback_)(<a class="code" href="classmxnet_1_1Engine.html">Engine</a> *, <span class="keywordtype">void</span> *);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="classmxnet_1_1Engine.html">Engine</a>* engine_;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span>* param_;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> };</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> } <span class="comment">// namespace engine</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#if DMLC_USE_CXX11</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3b"> 78</a></span> <span class="keyword">enum class</span> <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3b">FnProperty</a> {</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba07fa7a19aa722c635a15e94cb7f50416">kNormal</a>,</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba739f2f416f05f4728c217f09e93958d1">kCopyFromGPU</a>,</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba6cd75f41e0ec8d61b0a2f0e20ef6d1e8">kCopyToGPU</a>,</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3bac41ceb98eeb9b2e208e3e242a7357142">kCPUPrioritized</a>,</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3ba9f2b960005d2a3a5f35ac32809d84db7">kAsync</a>,</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <a class="code" href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3bac41fda8552e9d327ad3b06b1bafa663a">kDeleteVar</a></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> }; <span class="comment">// enum class FnProperty</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html"> 96</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="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#a16b757432556f835d27f1b5e1dbe1b06"> 99</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="l00101"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#a07f30ab85fca436e1bbcc72cd4d8bb35"> 101</a></span>  <span class="keyword">typedef</span> std::function&lt;void(RunContext)&gt; <a class="code" href="classmxnet_1_1Engine.html#a07f30ab85fca436e1bbcc72cd4d8bb35">SyncFn</a>;</div>
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#ad41feff70bba0f29fc24f60b5381984c"> 103</a></span>  <span class="keyword">typedef</span> std::function&lt;void(RunContext, CallbackOnComplete)&gt; <a class="code" href="classmxnet_1_1Engine.html#ad41feff70bba0f29fc24f60b5381984c">AsyncFn</a>;</div>
<div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#aac31510c793a12944c33f9cac6150491"> 105</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="l00107"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#a832436e413a075291aa1a631942c3f01"> 107</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="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> NotifyShutdown() = 0;</div>
<div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#a30f8947a7a1ad86b4c2cdb5b15b6d1e1"> 119</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1Engine.html#a30f8947a7a1ad86b4c2cdb5b15b6d1e1">Stop</a>() {</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  LOG(FATAL) &lt;&lt; <span class="stringliteral">"Engine cannot be stopped"</span>;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div>
<div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#a136a1d60db77a0846faa8462d0fb6237"> 125</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1Engine.html#a136a1d60db77a0846faa8462d0fb6237">Start</a>() {</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  LOG(FATAL) &lt;&lt; <span class="stringliteral">"Engine cannot be restarted"</span>;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  }</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keyword">virtual</span> <a class="code" href="namespacemxnet_1_1engine.html#a9d36c4f33eae8531586dc2edf83ae7cf">VarHandle</a> NewVariable() = 0;</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keyword">virtual</span> <a class="code" href="namespacemxnet_1_1engine.html#a2d9b14b658e3f3c4e03ca49cd38ace94">OprHandle</a> NewOperator(AsyncFn fn,</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  std::vector&lt;VarHandle&gt; <span class="keyword">const</span>&amp; const_vars,</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  std::vector&lt;VarHandle&gt; <span class="keyword">const</span>&amp; mutable_vars,</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</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="l00150"></a><span class="lineno"> 150</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="l00158"></a><span class="lineno"> 158</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> DeleteOperator(<a class="code" href="namespacemxnet_1_1engine.html#a2d9b14b658e3f3c4e03ca49cd38ace94">OprHandle</a> op) = 0;</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Push(<a class="code" href="namespacemxnet_1_1engine.html#a2d9b14b658e3f3c4e03ca49cd38ace94">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="l00180"></a><span class="lineno"> 180</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> PushAsync(AsyncFn exec_fun, <a class="code" href="structmxnet_1_1Context.html">Context</a> exec_ctx,</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  std::vector&lt;VarHandle&gt; <span class="keyword">const</span>&amp; const_vars,</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  std::vector&lt;VarHandle&gt; <span class="keyword">const</span>&amp; mutable_vars,</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</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="l00184"></a><span class="lineno"> 184</span>  <span class="keywordtype">int</span> priority = 0,</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</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="l00197"></a><span class="lineno"> 197</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> DeleteVariable(SyncFn delete_fn,</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <a class="code" href="structmxnet_1_1Context.html">Context</a> exec_ctx,</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <a class="code" href="namespacemxnet_1_1engine.html#a9d36c4f33eae8531586dc2edf83ae7cf">VarHandle</a> var) = 0;</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> WaitForVar(<a class="code" href="namespacemxnet_1_1engine.html#a9d36c4f33eae8531586dc2edf83ae7cf">VarHandle</a> var) = 0;</div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> WaitForAll() = 0;</div>
<div class="line"><a name="l00211"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#aff025321827e15096c02342225f2395b"> 211</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="l00215"></a><span class="lineno"> 215</span>  <span class="keyword">static</span> <a class="code" href="classmxnet_1_1Engine.html">Engine</a>* Get();</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  <span class="keyword">static</span> std::shared_ptr&lt;Engine&gt; _GetSharedRef();</div>
<div class="line"><a name="l00237"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#ac4c1d74e906699cf074a34dfdc968d8c"> 237</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1Engine.html#ac4c1d74e906699cf074a34dfdc968d8c">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="l00238"></a><span class="lineno"> 238</span>  std::vector&lt;VarHandle&gt; <span class="keyword">const</span>&amp; const_vars,</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  std::vector&lt;VarHandle&gt; <span class="keyword">const</span>&amp; mutable_vars,</div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</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="l00241"></a><span class="lineno"> 241</span>  <span class="keywordtype">int</span> priority = 0,</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* opr_name = <span class="keyword">nullptr</span>) {</div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  this-&gt;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="l00244"></a><span class="lineno"> 244</span>  exec_fn(ctx);</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  on_complete();</div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  }, exec_ctx, const_vars, mutable_vars, prop, priority, opr_name);</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> </div>
<div class="line"><a name="l00254"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#acf25be815b4200b48ee6e4e169bf95b8"> 254</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="l00255"></a><span class="lineno"> 255</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="l00256"></a><span class="lineno"> 256</span>  <a class="code" href="classmxnet_1_1engine_1_1CallbackOnComplete.html">CallbackOnComplete</a> ret;</div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  ret.callback_ = callback;</div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  ret.engine_ = <span class="keyword">this</span>;</div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  ret.param_ = param;</div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  <span class="keywordflow">return</span> ret;</div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  }</div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <span class="comment">// For each var vector, sort it and remove the duplicated vars.</span></div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <span class="comment">// Also remove vars from read_vars if it also appears in write_vars</span></div>
<div class="line"><a name="l00264"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#a9d8ac1987a6844dba9b0463030fb3430"> 264</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&lt;engine::VarHandle&gt; *read_vars,</div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  std::vector&lt;engine::VarHandle&gt; *write_vars) {</div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  std::sort(write_vars-&gt;begin(), write_vars-&gt;end());</div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  write_vars-&gt;resize(std::unique(write_vars-&gt;begin(), write_vars-&gt;end()) -</div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  write_vars-&gt;begin());</div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  std::sort(read_vars-&gt;begin(), read_vars-&gt;end());</div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  read_vars-&gt;resize(std::unique(read_vars-&gt;begin(), read_vars-&gt;end()) -</div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  read_vars-&gt;begin());</div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  <span class="keyword">auto</span> wit = write_vars-&gt;begin();</div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  <span class="keyword">auto</span> rtop = read_vars-&gt;begin();</div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span> rit = read_vars-&gt;begin(); rit != read_vars-&gt;end(); ++rit) {</div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  <span class="keywordflow">while</span> (wit != write_vars-&gt;end() &amp;&amp; *wit &lt; *rit) ++wit;</div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  <span class="keywordflow">if</span> (wit == write_vars-&gt;end() || *wit != *rit) {</div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  *rtop = *rit;</div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  ++rtop;</div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  }</div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  }</div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  read_vars-&gt;resize(rtop - read_vars-&gt;begin());</div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  }</div>
<div class="line"><a name="l00284"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#a78baf44fa0dfed3285d6b9b65845825c"> 284</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classmxnet_1_1Engine.html#a78baf44fa0dfed3285d6b9b65845825c">bulk_size</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  }</div>
<div class="line"><a name="l00288"></a><span class="lineno"><a class="line" href="classmxnet_1_1Engine.html#ac33a02d6827b43c27c04371d8ef04ef4"> 288</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classmxnet_1_1Engine.html#ac33a02d6827b43c27c04371d8ef04ef4">set_bulk_size</a>(<span class="keywordtype">int</span>) {</div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  }</div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> }; <span class="comment">// class Engine</span></div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="preprocessor">#endif // DMLC_USE_CXX11</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="preprocessor"></span>} <span class="comment">// namespace mxnet</span></div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</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&lt; engine::VarHandle &gt; *read_vars, std::vector&lt; engine::VarHandle &gt; *write_vars)</div><div class="ttdef"><b>Definition:</b> engine.h:264</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:78</div></div>
<div class="ttc" id="classmxnet_1_1Engine_html_a30f8947a7a1ad86b4c2cdb5b15b6d1e1"><div class="ttname"><a href="classmxnet_1_1Engine.html#a30f8947a7a1ad86b4c2cdb5b15b6d1e1">mxnet::Engine::Stop</a></div><div class="ttdeci">virtual void Stop()</div><div class="ttdoc">Stop all workers in the engine. </div><div class="ttdef"><b>Definition:</b> engine.h:119</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&lt; void(RunContext)&gt; SyncFn</div><div class="ttdoc">Synchronous operation to pass to engine. </div><div class="ttdef"><b>Definition:</b> engine.h:101</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&lt; void(RunContext, CallbackOnComplete)&gt; AsyncFn</div><div class="ttdoc">Asynchronous operation to pass to engine. </div><div class="ttdef"><b>Definition:</b> engine.h:103</div></div>
<div class="ttc" id="classmxnet_1_1Engine_html_a78baf44fa0dfed3285d6b9b65845825c"><div class="ttname"><a href="classmxnet_1_1Engine.html#a78baf44fa0dfed3285d6b9b65845825c">mxnet::Engine::bulk_size</a></div><div class="ttdeci">virtual int bulk_size() const </div><div class="ttdoc">query current limit for bulk size </div><div class="ttdef"><b>Definition:</b> engine.h:284</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:254</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:60</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:253</div></div>
<div class="ttc" id="namespacemxnet_html_a998b74220fab2b012cf8a179650e1b3bac41fda8552e9d327ad3b06b1bafa663a"><div class="ttname"><a href="namespacemxnet.html#a998b74220fab2b012cf8a179650e1b3bac41fda8552e9d327ad3b06b1bafa663a">mxnet::FnProperty::kDeleteVar</a></div><div class="ttdoc">Delete variable call. </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:211</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:92</div></div>
<div class="ttc" id="classmxnet_1_1Engine_html_a136a1d60db77a0846faa8462d0fb6237"><div class="ttname"><a href="classmxnet_1_1Engine.html#a136a1d60db77a0846faa8462d0fb6237">mxnet::Engine::Start</a></div><div class="ttdeci">virtual void Start()</div><div class="ttdoc">Restart all workers in the engine. </div><div class="ttdef"><b>Definition:</b> engine.h:125</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_ac33a02d6827b43c27c04371d8ef04ef4"><div class="ttname"><a href="classmxnet_1_1Engine.html#ac33a02d6827b43c27c04371d8ef04ef4">mxnet::Engine::set_bulk_size</a></div><div class="ttdeci">virtual int set_bulk_size(int)</div><div class="ttdoc">set maximum limit for bulk size </div><div class="ttdef"><b>Definition:</b> engine.h:288</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:107</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:105</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:47</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:99</div></div>
<div class="ttc" id="classmxnet_1_1Engine_html_ac4c1d74e906699cf074a34dfdc968d8c"><div class="ttname"><a href="classmxnet_1_1Engine.html#ac4c1d74e906699cf074a34dfdc968d8c">mxnet::Engine::PushSync</a></div><div class="ttdeci">virtual void PushSync(SyncFn exec_fn, Context exec_ctx, std::vector&lt; VarHandle &gt; const &amp;const_vars, std::vector&lt; VarHandle &gt; const &amp;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:237</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:96</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:56</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:142</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:51</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Dec 4 2017 01:09:29 for mxnet by  <a href="http://www.doxygen.org/index.html">
<img alt="doxygen" class="footer" src="doxygen.png"/>
</a> 1.8.6
</small></address>
</body>
</html>