Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / api / cpp / docs / api / structmxnet_1_1ResourceRequest.html
blob: f2f995c1c63e715ea8e82c4c213c5e13a20efccf [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: mxnet::ResourceRequest Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="structmxnet_1_1ResourceRequest.html">ResourceRequest</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<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 src="structmxnet_1_1ResourceRequest__coll__graph.png" border="0" usemap="#mxnet_1_1ResourceRequest_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 0 -->
</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 class="memItemLeft" align="right" valign="top">enum &#160;</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">&#160;</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,...">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">&#160;</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 class="memItemLeft" align="right" valign="top">&#160;</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">&#160;</td><td class="mdescRight">default constructor <a href="structmxnet_1_1ResourceRequest.html#a0191250c5891ba487f354df4caf3604d">More...</a><br /></td></tr>
<tr class="separator:a0191250c5891ba487f354df4caf3604d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa01dd9fd716dfbb68c2ee01f5a11aea5"><td class="memItemLeft" align="right" valign="top">&#160;</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">&#160;</td><td class="mdescRight">constructor, allow implicit conversion <a href="structmxnet_1_1ResourceRequest.html#aa01dd9fd716dfbb68c2ee01f5a11aea5">More...</a><br /></td></tr>
<tr class="separator:aa01dd9fd716dfbb68c2ee01f5a11aea5"><td class="memSeparator" colspan="2">&#160;</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 class="memItemLeft" align="right" valign="top"><a class="el" href="structmxnet_1_1ResourceRequest.html#aba2ee7560afb89ebdd00c7c735149630">Type</a>&#160;</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">&#160;</td><td class="mdescRight">type of resources <a href="structmxnet_1_1ResourceRequest.html#ad67cb809ea1e0db24629ffbd3db00a63">More...</a><br /></td></tr>
<tr class="separator:ad67cb809ea1e0db24629ffbd3db00a63"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="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 id="aba2ee7560afb89ebdd00c7c735149630"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba2ee7560afb89ebdd00c7c735149630">&#9670;&nbsp;</a></span>Type</h2>
<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,...">Resource</a> type, indicating what the pointer type is. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aba2ee7560afb89ebdd00c7c735149630adfccd3e369be7104e7300557f620f6b9"></a>kRandom&#160;</td><td class="fielddoc"><p>mshadow::Random&lt;xpu&gt; object </p>
</td></tr>
<tr><td class="fieldname"><a id="aba2ee7560afb89ebdd00c7c735149630aae5d4509a9b382744ea13d2daa8aa3f3"></a>kTempSpace&#160;</td><td class="fielddoc"><p>A dynamic temp space that can be arbitrary size. </p>
</td></tr>
<tr><td class="fieldname"><a id="aba2ee7560afb89ebdd00c7c735149630a96b66c1afe93ea0fc12a7f3fbacf61df"></a>kParallelRandom&#160;</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 id="a0191250c5891ba487f354df4caf3604d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0191250c5891ba487f354df4caf3604d">&#9670;&nbsp;</a></span>ResourceRequest() <span class="overload">[1/2]</span></h2>
<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 id="aa01dd9fd716dfbb68c2ee01f5a11aea5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa01dd9fd716dfbb68c2ee01f5a11aea5">&#9670;&nbsp;</a></span>ResourceRequest() <span class="overload">[2/2]</span></h2>
<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>&#160;</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 id="ad67cb809ea1e0db24629ffbd3db00a63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad67cb809ea1e0db24629ffbd3db00a63">&#9670;&nbsp;</a></span>type</h2>
<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>/work/mxnet/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 Thu Jan 5 2023 03:47:41 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>