blob: 64e2d8830946f8dc34ebe67fd4eba96284e31812 [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 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/resource.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&#160;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&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</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">resource.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="resource_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>&#160;</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#ifndef MXNET_RESOURCE_H_</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define MXNET_RESOURCE_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;dmlc/logging.h&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="base_8h.html">./base.h</a>&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="engine_8h.html">./engine.h</a>&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">namespace </span>mxnet {</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="structmxnet_1_1ResourceRequest.html"> 18</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structmxnet_1_1ResourceRequest.html">ResourceRequest</a> {</div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630"> 20</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630">Type</a> {</div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630adfccd3e369be7104e7300557f620f6b9"> 22</a></span>&#160; <a class="code" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630adfccd3e369be7104e7300557f620f6b9">kRandom</a>,</div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630aae5d4509a9b382744ea13d2daa8aa3f3"> 24</a></span>&#160; <a class="code" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630aae5d4509a9b382744ea13d2daa8aa3f3">kTempSpace</a></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; };</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structmxnet_1_1ResourceRequest.html#ad67cb809ea1e0db24629ffbd3db00a63"> 27</a></span>&#160; <a class="code" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630">Type</a> <a class="code" href="structmxnet_1_1ResourceRequest.html#ad67cb809ea1e0db24629ffbd3db00a63">type</a>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="structmxnet_1_1ResourceRequest.html#a0191250c5891ba487f354df4caf3604d"> 29</a></span>&#160; <a class="code" href="structmxnet_1_1ResourceRequest.html#a0191250c5891ba487f354df4caf3604d">ResourceRequest</a>() {}</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structmxnet_1_1ResourceRequest.html#aa01dd9fd716dfbb68c2ee01f5a11aea5"> 34</a></span>&#160; <a class="code" href="structmxnet_1_1ResourceRequest.html#aa01dd9fd716dfbb68c2ee01f5a11aea5">ResourceRequest</a>(<a class="code" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630">Type</a> <a class="code" href="structmxnet_1_1ResourceRequest.html#ad67cb809ea1e0db24629ffbd3db00a63">type</a>) <span class="comment">// NOLINT(*)</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; : type(type) {}</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;};</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structmxnet_1_1Resource.html"> 44</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structmxnet_1_1Resource.html">Resource</a> {</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structmxnet_1_1Resource.html#ae841e25cf5ee4aed895ace7fa080edc4"> 46</a></span>&#160; <a class="code" href="structmxnet_1_1ResourceRequest.html">ResourceRequest</a> <a class="code" href="structmxnet_1_1Resource.html#ae841e25cf5ee4aed895ace7fa080edc4">req</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structmxnet_1_1Resource.html#a5a8048bdda73fefa3af322aaaba50eb8"> 48</a></span>&#160; <a class="code" href="namespacemxnet_1_1engine.html#a9d36c4f33eae8531586dc2edf83ae7cf">engine::VarHandle</a> <a class="code" href="structmxnet_1_1Resource.html#a5a8048bdda73fefa3af322aaaba50eb8">var</a>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structmxnet_1_1Resource.html#aa1fc8578c0fa849afe7da29c1cf1308b"> 50</a></span>&#160; int32_t <a class="code" href="structmxnet_1_1Resource.html#aa1fc8578c0fa849afe7da29c1cf1308b">id</a>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structmxnet_1_1Resource.html#a7e9576783b7e9023375ffebd76a11806"> 55</a></span>&#160; <span class="keywordtype">void</span> *<a class="code" href="structmxnet_1_1Resource.html#a7e9576783b7e9023375ffebd76a11806">ptr_</a>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structmxnet_1_1Resource.html#a76a2cc8f2a94b67b3533a048a80396aa"> 57</a></span>&#160; <a class="code" href="structmxnet_1_1Resource.html#a76a2cc8f2a94b67b3533a048a80396aa">Resource</a>() : <a class="code" href="structmxnet_1_1Resource.html#aa1fc8578c0fa849afe7da29c1cf1308b">id</a>(0) {}</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> xpu, <span class="keyword">typename</span> DType&gt;</div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="structmxnet_1_1Resource.html#a86039963ae5d682ffc287aefd520f6f9"> 65</a></span>&#160; <span class="keyword">inline</span> mshadow::Random&lt;xpu, DType&gt;* <a class="code" href="structmxnet_1_1Resource.html#a86039963ae5d682ffc287aefd520f6f9">get_random</a>(</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; mshadow::Stream&lt;xpu&gt; *stream)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; CHECK_EQ(<a class="code" href="structmxnet_1_1Resource.html#ae841e25cf5ee4aed895ace7fa080edc4">req</a>.<a class="code" href="structmxnet_1_1ResourceRequest.html#ad67cb809ea1e0db24629ffbd3db00a63">type</a>, <a class="code" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630adfccd3e369be7104e7300557f620f6b9">ResourceRequest::kRandom</a>);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; mshadow::Random&lt;xpu, DType&gt; *ret =</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">static_cast&lt;</span>mshadow::Random&lt;xpu, DType&gt;*<span class="keyword">&gt;</span>(<a class="code" href="structmxnet_1_1Resource.html#a7e9576783b7e9023375ffebd76a11806">ptr_</a>);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; ret-&gt;set_stream(stream);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordflow">return</span> ret;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; }</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> xpu, <span class="keywordtype">int</span> ndim&gt;</div>
<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="structmxnet_1_1Resource.html#ab2be3ebdd3c5f5fa181ac4f6cdd69508"> 90</a></span>&#160; <span class="keyword">inline</span> mshadow::Tensor&lt;xpu, ndim, real_t&gt; <a class="code" href="structmxnet_1_1Resource.html#ab2be3ebdd3c5f5fa181ac4f6cdd69508">get_space</a>(</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; mshadow::Shape&lt;ndim&gt; shape, mshadow::Stream&lt;xpu&gt; *stream)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordflow">return</span> get_space_typed&lt;xpu, ndim, real_t&gt;(shape, stream);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; }</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keyword">template</span>&lt;<span class="keywordtype">int</span> ndim&gt;</div>
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="structmxnet_1_1Resource.html#a92724193fad2a6c5e2a63687e63e3d80"> 103</a></span>&#160; <span class="keyword">inline</span> mshadow::Tensor&lt;cpu, ndim, real_t&gt; <a class="code" href="structmxnet_1_1Resource.html#a92724193fad2a6c5e2a63687e63e3d80">get_host_space</a>(</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; mshadow::Shape&lt;ndim&gt; shape)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordflow">return</span> get_host_space_typed&lt;cpu, ndim, real_t&gt;(shape);</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; }</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> xpu, <span class="keywordtype">int</span> ndim, <span class="keyword">typename</span> DType&gt;</div>
<div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="structmxnet_1_1Resource.html#a84e66895d72f9e99ae994de86539a77e"> 118</a></span>&#160; <span class="keyword">inline</span> mshadow::Tensor&lt;xpu, ndim, DType&gt; <a class="code" href="structmxnet_1_1Resource.html#a84e66895d72f9e99ae994de86539a77e">get_space_typed</a>(</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; mshadow::Shape&lt;ndim&gt; shape, mshadow::Stream&lt;xpu&gt; *stream)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; CHECK_EQ(<a class="code" href="structmxnet_1_1Resource.html#ae841e25cf5ee4aed895ace7fa080edc4">req</a>.<a class="code" href="structmxnet_1_1ResourceRequest.html#ad67cb809ea1e0db24629ffbd3db00a63">type</a>, <a class="code" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630aae5d4509a9b382744ea13d2daa8aa3f3">ResourceRequest::kTempSpace</a>);</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keywordflow">return</span> mshadow::Tensor&lt;xpu, ndim, DType&gt;(</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keyword">reinterpret_cast&lt;</span>DType*<span class="keyword">&gt;</span>(<a class="code" href="structmxnet_1_1Resource.html#af57d32e959227f49d54d6eb6a5c62875">get_space_internal</a>(shape.Size() * <span class="keyword">sizeof</span>(DType))),</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; shape, shape[ndim - 1], stream);</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; }</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keyword">template</span>&lt;<span class="keywordtype">int</span> ndim, <span class="keyword">typename</span> DType&gt;</div>
<div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="structmxnet_1_1Resource.html#a7c6dff75a9e05a7394b02c84b79a14b2"> 135</a></span>&#160; <span class="keyword">inline</span> mshadow::Tensor&lt;cpu, ndim, DType&gt; <a class="code" href="structmxnet_1_1Resource.html#a7c6dff75a9e05a7394b02c84b79a14b2">get_host_space_typed</a>(</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; mshadow::Shape&lt;ndim&gt; shape)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keywordflow">return</span> mshadow::Tensor&lt;cpu, ndim, DType&gt;(</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keyword">reinterpret_cast&lt;</span>DType*<span class="keyword">&gt;</span>(<a class="code" href="structmxnet_1_1Resource.html#af6e0224f60b5e9afd3c883972863537f">get_host_space_internal</a>(shape.Size() * <span class="keyword">sizeof</span>(DType))),</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; shape, shape[ndim - 1], NULL);</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; }</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <span class="keywordtype">void</span>* <a class="code" href="structmxnet_1_1Resource.html#af57d32e959227f49d54d6eb6a5c62875">get_space_internal</a>(<span class="keywordtype">size_t</span> size) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; <span class="keywordtype">void</span> *<a class="code" href="structmxnet_1_1Resource.html#af6e0224f60b5e9afd3c883972863537f">get_host_space_internal</a>(<span class="keywordtype">size_t</span> size) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;};</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;</div>
<div class="line"><a name="l00156"></a><span class="lineno"><a class="line" href="classmxnet_1_1ResourceManager.html"> 156</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmxnet_1_1ResourceManager.html">ResourceManager</a> {</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="keyword">virtual</span> <a class="code" href="structmxnet_1_1Resource.html">Resource</a> <a class="code" href="classmxnet_1_1ResourceManager.html#a276e4e3ae229a118e50a03955f3f1a08">Request</a>(<a class="code" href="structmxnet_1_1Context.html">Context</a> ctx, <span class="keyword">const</span> <a class="code" href="structmxnet_1_1ResourceRequest.html">ResourceRequest</a> &amp;req) = 0;</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1ResourceManager.html#a7aa335bc9231a8eb7cd04de22e033603">SeedRandom</a>(uint32_t seed) = 0;</div>
<div class="line"><a name="l00173"></a><span class="lineno"><a class="line" href="classmxnet_1_1ResourceManager.html#a2b53c0843ddbaf7ccb9e06f448b20cac"> 173</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classmxnet_1_1ResourceManager.html#a2b53c0843ddbaf7ccb9e06f448b20cac">~ResourceManager</a>() DMLC_THROW_EXCEPTION {}</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; <span class="keyword">static</span> <a class="code" href="classmxnet_1_1ResourceManager.html">ResourceManager</a> *<a class="code" href="classmxnet_1_1ResourceManager.html#a5712bb055045ba9fb45dd3cdb812abb8">Get</a>();</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160;};</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;} <span class="comment">// namespace mxnet</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;<span class="preprocessor">#endif // MXNET_RESOURCE_H_</span></div>
<div class="ttc" id="engine_8h_html"><div class="ttname"><a href="engine_8h.html">engine.h</a></div><div class="ttdoc">Engine that schedules all the operations according to dependency. </div></div>
<div class="ttc" id="classmxnet_1_1ResourceManager_html_a276e4e3ae229a118e50a03955f3f1a08"><div class="ttname"><a href="classmxnet_1_1ResourceManager.html#a276e4e3ae229a118e50a03955f3f1a08">mxnet::ResourceManager::Request</a></div><div class="ttdeci">virtual Resource Request(Context ctx, const ResourceRequest &amp;req)=0</div><div class="ttdoc">Get resource of requested type. </div></div>
<div class="ttc" id="structmxnet_1_1Resource_html_a5a8048bdda73fefa3af322aaaba50eb8"><div class="ttname"><a href="structmxnet_1_1Resource.html#a5a8048bdda73fefa3af322aaaba50eb8">mxnet::Resource::var</a></div><div class="ttdeci">engine::VarHandle var</div><div class="ttdoc">engine variable </div><div class="ttdef"><b>Definition:</b> resource.h:48</div></div>
<div class="ttc" id="structmxnet_1_1Resource_html_aa1fc8578c0fa849afe7da29c1cf1308b"><div class="ttname"><a href="structmxnet_1_1Resource.html#aa1fc8578c0fa849afe7da29c1cf1308b">mxnet::Resource::id</a></div><div class="ttdeci">int32_t id</div><div class="ttdoc">identifier of id information, used for debug purpose </div><div class="ttdef"><b>Definition:</b> resource.h:50</div></div>
<div class="ttc" id="structmxnet_1_1ResourceRequest_html"><div class="ttname"><a href="structmxnet_1_1ResourceRequest.html">mxnet::ResourceRequest</a></div><div class="ttdoc">The resources that can be requested by Operator. </div><div class="ttdef"><b>Definition:</b> resource.h:18</div></div>
<div class="ttc" id="structmxnet_1_1ResourceRequest_html_aa01dd9fd716dfbb68c2ee01f5a11aea5"><div class="ttname"><a href="structmxnet_1_1ResourceRequest.html#aa01dd9fd716dfbb68c2ee01f5a11aea5">mxnet::ResourceRequest::ResourceRequest</a></div><div class="ttdeci">ResourceRequest(Type type)</div><div class="ttdoc">constructor, allow implicit conversion </div><div class="ttdef"><b>Definition:</b> resource.h:34</div></div>
<div class="ttc" id="structmxnet_1_1Resource_html_ae841e25cf5ee4aed895ace7fa080edc4"><div class="ttname"><a href="structmxnet_1_1Resource.html#ae841e25cf5ee4aed895ace7fa080edc4">mxnet::Resource::req</a></div><div class="ttdeci">ResourceRequest req</div><div class="ttdoc">The original request. </div><div class="ttdef"><b>Definition:</b> resource.h:46</div></div>
<div class="ttc" id="structmxnet_1_1ResourceRequest_html_ad67cb809ea1e0db24629ffbd3db00a63"><div class="ttname"><a href="structmxnet_1_1ResourceRequest.html#ad67cb809ea1e0db24629ffbd3db00a63">mxnet::ResourceRequest::type</a></div><div class="ttdeci">Type type</div><div class="ttdoc">type of resources </div><div class="ttdef"><b>Definition:</b> resource.h:27</div></div>
<div class="ttc" id="structmxnet_1_1ResourceRequest_html_aba2ee7560afb89ebdd00c7c735149630aae5d4509a9b382744ea13d2daa8aa3f3"><div class="ttname"><a href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630aae5d4509a9b382744ea13d2daa8aa3f3">mxnet::ResourceRequest::kTempSpace</a></div><div class="ttdoc">A dynamic temp space that can be arbitrary size. </div><div class="ttdef"><b>Definition:</b> resource.h:24</div></div>
<div class="ttc" id="structmxnet_1_1Resource_html_a7c6dff75a9e05a7394b02c84b79a14b2"><div class="ttname"><a href="structmxnet_1_1Resource.html#a7c6dff75a9e05a7394b02c84b79a14b2">mxnet::Resource::get_host_space_typed</a></div><div class="ttdeci">mshadow::Tensor&lt; cpu, ndim, DType &gt; get_host_space_typed(mshadow::Shape&lt; ndim &gt; shape) const </div><div class="ttdoc">Get CPU space as mshadow Tensor in specified type. The caller can request arbitrary size...</div><div class="ttdef"><b>Definition:</b> resource.h:135</div></div>
<div class="ttc" id="classmxnet_1_1ResourceManager_html"><div class="ttname"><a href="classmxnet_1_1ResourceManager.html">mxnet::ResourceManager</a></div><div class="ttdoc">Global resource manager. </div><div class="ttdef"><b>Definition:</b> resource.h:156</div></div>
<div class="ttc" id="structmxnet_1_1Resource_html"><div class="ttname"><a href="structmxnet_1_1Resource.html">mxnet::Resource</a></div><div class="ttdoc">Resources used by mxnet operations. A resource is something special other than NDArray, but will still participate. </div><div class="ttdef"><b>Definition:</b> resource.h:44</div></div>
<div class="ttc" id="structmxnet_1_1Resource_html_a86039963ae5d682ffc287aefd520f6f9"><div class="ttname"><a href="structmxnet_1_1Resource.html#a86039963ae5d682ffc287aefd520f6f9">mxnet::Resource::get_random</a></div><div class="ttdeci">mshadow::Random&lt; xpu, DType &gt; * get_random(mshadow::Stream&lt; xpu &gt; *stream) const </div><div class="ttdoc">Get random number generator. </div><div class="ttdef"><b>Definition:</b> resource.h:65</div></div>
<div class="ttc" id="structmxnet_1_1Resource_html_a84e66895d72f9e99ae994de86539a77e"><div class="ttname"><a href="structmxnet_1_1Resource.html#a84e66895d72f9e99ae994de86539a77e">mxnet::Resource::get_space_typed</a></div><div class="ttdeci">mshadow::Tensor&lt; xpu, ndim, DType &gt; get_space_typed(mshadow::Shape&lt; ndim &gt; shape, mshadow::Stream&lt; xpu &gt; *stream) const </div><div class="ttdoc">Get space requested as mshadow Tensor in specified type. The caller can request arbitrary size...</div><div class="ttdef"><b>Definition:</b> resource.h:118</div></div>
<div class="ttc" id="structmxnet_1_1Resource_html_ab2be3ebdd3c5f5fa181ac4f6cdd69508"><div class="ttname"><a href="structmxnet_1_1Resource.html#ab2be3ebdd3c5f5fa181ac4f6cdd69508">mxnet::Resource::get_space</a></div><div class="ttdeci">mshadow::Tensor&lt; xpu, ndim, real_t &gt; get_space(mshadow::Shape&lt; ndim &gt; shape, mshadow::Stream&lt; xpu &gt; *stream) const </div><div class="ttdoc">Get space requested as mshadow Tensor. The caller can request arbitrary size. </div><div class="ttdef"><b>Definition:</b> resource.h:90</div></div>
<div class="ttc" id="structmxnet_1_1ResourceRequest_html_a0191250c5891ba487f354df4caf3604d"><div class="ttname"><a href="structmxnet_1_1ResourceRequest.html#a0191250c5891ba487f354df4caf3604d">mxnet::ResourceRequest::ResourceRequest</a></div><div class="ttdeci">ResourceRequest()</div><div class="ttdoc">default constructor </div><div class="ttdef"><b>Definition:</b> resource.h:29</div></div>
<div class="ttc" id="classmxnet_1_1ResourceManager_html_a2b53c0843ddbaf7ccb9e06f448b20cac"><div class="ttname"><a href="classmxnet_1_1ResourceManager.html#a2b53c0843ddbaf7ccb9e06f448b20cac">mxnet::ResourceManager::~ResourceManager</a></div><div class="ttdeci">virtual ~ResourceManager() DMLC_THROW_EXCEPTION</div><div class="ttdoc">virtual destructor </div><div class="ttdef"><b>Definition:</b> resource.h:173</div></div>
<div class="ttc" id="structmxnet_1_1ResourceRequest_html_aba2ee7560afb89ebdd00c7c735149630"><div class="ttname"><a href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630">mxnet::ResourceRequest::Type</a></div><div class="ttdeci">Type</div><div class="ttdoc">Resource type, indicating what the pointer type is. </div><div class="ttdef"><b>Definition:</b> resource.h:20</div></div>
<div class="ttc" id="structmxnet_1_1Resource_html_a76a2cc8f2a94b67b3533a048a80396aa"><div class="ttname"><a href="structmxnet_1_1Resource.html#a76a2cc8f2a94b67b3533a048a80396aa">mxnet::Resource::Resource</a></div><div class="ttdeci">Resource()</div><div class="ttdoc">default constructor </div><div class="ttdef"><b>Definition:</b> resource.h:57</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="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_1Resource_html_a92724193fad2a6c5e2a63687e63e3d80"><div class="ttname"><a href="structmxnet_1_1Resource.html#a92724193fad2a6c5e2a63687e63e3d80">mxnet::Resource::get_host_space</a></div><div class="ttdeci">mshadow::Tensor&lt; cpu, ndim, real_t &gt; get_host_space(mshadow::Shape&lt; ndim &gt; shape) const </div><div class="ttdoc">Get cpu space requested as mshadow Tensor. The caller can request arbitrary size. ...</div><div class="ttdef"><b>Definition:</b> resource.h:103</div></div>
<div class="ttc" id="structmxnet_1_1ResourceRequest_html_aba2ee7560afb89ebdd00c7c735149630adfccd3e369be7104e7300557f620f6b9"><div class="ttname"><a href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630adfccd3e369be7104e7300557f620f6b9">mxnet::ResourceRequest::kRandom</a></div><div class="ttdoc">mshadow::Random&lt;xpu&gt; object </div><div class="ttdef"><b>Definition:</b> resource.h:22</div></div>
<div class="ttc" id="structmxnet_1_1Resource_html_a7e9576783b7e9023375ffebd76a11806"><div class="ttname"><a href="structmxnet_1_1Resource.html#a7e9576783b7e9023375ffebd76a11806">mxnet::Resource::ptr_</a></div><div class="ttdeci">void * ptr_</div><div class="ttdoc">pointer to the resource, do not use directly, access using member functions </div><div class="ttdef"><b>Definition:</b> resource.h:55</div></div>
<div class="ttc" id="structmxnet_1_1Resource_html_af57d32e959227f49d54d6eb6a5c62875"><div class="ttname"><a href="structmxnet_1_1Resource.html#af57d32e959227f49d54d6eb6a5c62875">mxnet::Resource::get_space_internal</a></div><div class="ttdeci">void * get_space_internal(size_t size) const </div><div class="ttdoc">internal function to get space from resources. </div></div>
<div class="ttc" id="classmxnet_1_1ResourceManager_html_a7aa335bc9231a8eb7cd04de22e033603"><div class="ttname"><a href="classmxnet_1_1ResourceManager.html#a7aa335bc9231a8eb7cd04de22e033603">mxnet::ResourceManager::SeedRandom</a></div><div class="ttdeci">virtual void SeedRandom(uint32_t seed)=0</div><div class="ttdoc">Seed all the allocated random numbers. </div></div>
<div class="ttc" id="structmxnet_1_1Resource_html_af6e0224f60b5e9afd3c883972863537f"><div class="ttname"><a href="structmxnet_1_1Resource.html#af6e0224f60b5e9afd3c883972863537f">mxnet::Resource::get_host_space_internal</a></div><div class="ttdeci">void * get_host_space_internal(size_t size) const </div><div class="ttdoc">internal function to get cpu space from resources. </div></div>
<div class="ttc" id="classmxnet_1_1ResourceManager_html_a5712bb055045ba9fb45dd3cdb812abb8"><div class="ttname"><a href="classmxnet_1_1ResourceManager.html#a5712bb055045ba9fb45dd3cdb812abb8">mxnet::ResourceManager::Get</a></div><div class="ttdeci">static ResourceManager * Get()</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><!-- 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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>