blob: 8f489a31c436f8a897b1cbe66fc3bad2a082c91b [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: mxnet::ResourceRequest Struct Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class 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="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="structmxnet_1_1ResourceRequest.html">ResourceRequest</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structmxnet_1_1ResourceRequest-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::ResourceRequest Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The resources that can be requested by <a class="el" href="classmxnet_1_1Operator.html" title="Operator interface. Operator defines basic operation unit of optimized computation graph in mxnet...">Operator</a>.
<a href="structmxnet_1_1ResourceRequest.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="resource_8h_source.html">resource.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::ResourceRequest:</div>
<div class="dyncontent">
<div class="center"><img alt="Collaboration graph" border="0" src="structmxnet_1_1ResourceRequest__coll__graph.png" usemap="#mxnet_1_1ResourceRequest_coll__map"/></div>
<map id="mxnet_1_1ResourceRequest_coll__map" name="mxnet_1_1ResourceRequest_coll__map">
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aba2ee7560afb89ebdd00c7c735149630"><td align="right" class="memItemLeft" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630">Type</a> { <a class="el" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630adfccd3e369be7104e7300557f620f6b9">kRandom</a>,
<a class="el" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630aae5d4509a9b382744ea13d2daa8aa3f3">kTempSpace</a>,
<a class="el" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630a96b66c1afe93ea0fc12a7f3fbacf61df">kParallelRandom</a>
}</td></tr>
<tr class="memdesc:aba2ee7560afb89ebdd00c7c735149630"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structmxnet_1_1Resource.html" title="Resources used by mxnet operations. A resource is something special other than NDArray, but will still participate. ">Resource</a> type, indicating what the pointer type is. <a href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630">More...</a><br/></td></tr>
<tr class="separator:aba2ee7560afb89ebdd00c7c735149630"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0191250c5891ba487f354df4caf3604d"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1ResourceRequest.html#a0191250c5891ba487f354df4caf3604d">ResourceRequest</a> ()</td></tr>
<tr class="memdesc:a0191250c5891ba487f354df4caf3604d"><td class="mdescLeft"> </td><td class="mdescRight">default constructor <a href="#a0191250c5891ba487f354df4caf3604d">More...</a><br/></td></tr>
<tr class="separator:a0191250c5891ba487f354df4caf3604d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa01dd9fd716dfbb68c2ee01f5a11aea5"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1ResourceRequest.html#aa01dd9fd716dfbb68c2ee01f5a11aea5">ResourceRequest</a> (<a class="el" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630">Type</a> <a class="el" href="structmxnet_1_1ResourceRequest.html#ad67cb809ea1e0db24629ffbd3db00a63">type</a>)</td></tr>
<tr class="memdesc:aa01dd9fd716dfbb68c2ee01f5a11aea5"><td class="mdescLeft"> </td><td class="mdescRight">constructor, allow implicit conversion <a href="#aa01dd9fd716dfbb68c2ee01f5a11aea5">More...</a><br/></td></tr>
<tr class="separator:aa01dd9fd716dfbb68c2ee01f5a11aea5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ad67cb809ea1e0db24629ffbd3db00a63"><td align="right" class="memItemLeft" valign="top"><a class="el" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1ResourceRequest.html#ad67cb809ea1e0db24629ffbd3db00a63">type</a></td></tr>
<tr class="memdesc:ad67cb809ea1e0db24629ffbd3db00a63"><td class="mdescLeft"> </td><td class="mdescRight">type of resources <a href="#ad67cb809ea1e0db24629ffbd3db00a63">More...</a><br/></td></tr>
<tr class="separator:ad67cb809ea1e0db24629ffbd3db00a63"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The resources that can be requested by <a class="el" href="classmxnet_1_1Operator.html" title="Operator interface. Operator defines basic operation unit of optimized computation graph in mxnet...">Operator</a>. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="aba2ee7560afb89ebdd00c7c735149630"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630">mxnet::ResourceRequest::Type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structmxnet_1_1Resource.html" title="Resources used by mxnet operations. A resource is something special other than NDArray, but will still participate. ">Resource</a> type, indicating what the pointer type is. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="aba2ee7560afb89ebdd00c7c735149630adfccd3e369be7104e7300557f620f6b9"></a>kRandom</em> </td><td class="fielddoc">
<p>mshadow::Random&lt;xpu&gt; object </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aba2ee7560afb89ebdd00c7c735149630aae5d4509a9b382744ea13d2daa8aa3f3"></a>kTempSpace</em> </td><td class="fielddoc">
<p>A dynamic temp space that can be arbitrary size. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aba2ee7560afb89ebdd00c7c735149630a96b66c1afe93ea0fc12a7f3fbacf61df"></a>kParallelRandom</em> </td><td class="fielddoc">
<p>common::RandGenerator&lt;xpu&gt; object, which can be used in GPU kernel functions </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a0191250c5891ba487f354df4caf3604d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::ResourceRequest::ResourceRequest </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>default constructor </p>
</div>
</div>
<a class="anchor" id="aa01dd9fd716dfbb68c2ee01f5a11aea5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::ResourceRequest::ResourceRequest </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630">Type</a> </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>constructor, allow implicit conversion </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>type of resources </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ad67cb809ea1e0db24629ffbd3db00a63"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630">Type</a> mxnet::ResourceRequest::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>type of resources </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/mxnet/<a class="el" href="resource_8h_source.html">resource.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jan 26 2018 01:41:23 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>