| <!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.11" name="generator"/> |
| <title>mxnet: mxnet::Resource 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/searchdata.js" type="text/javascript"></script> |
| <script src="search/search.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { init_search(); }); |
| </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 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.11 --> |
| <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()"> |
| </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_1Resource.html">Resource</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="structmxnet_1_1Resource-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::Resource Struct Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <p>Resources used by mxnet operations. A resource is something special other than <a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a>, but will still participate. |
| <a href="structmxnet_1_1Resource.html#details">More...</a></p> |
| <p><code>#include <<a class="el" href="resource_8h_source.html">resource.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::Resource:</div> |
| <div class="dyncontent"> |
| <div class="center"><img alt="Collaboration graph" border="0" src="structmxnet_1_1Resource__coll__graph.png" usemap="#mxnet_1_1Resource_coll__map"/></div> |
| <map id="mxnet_1_1Resource_coll__map" name="mxnet_1_1Resource_coll__map"> |
| <area alt="" coords="17,5,197,97" href="structmxnet_1_1ResourceRequest.html" id="node2" shape="rect" title="The resources that can be requested by Operator. "/> |
| </map> |
| </div> |
| <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:a76a2cc8f2a94b67b3533a048a80396aa"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#a76a2cc8f2a94b67b3533a048a80396aa">Resource</a> ()</td></tr> |
| <tr class="memdesc:a76a2cc8f2a94b67b3533a048a80396aa"><td class="mdescLeft"> </td><td class="mdescRight">default constructor <a href="#a76a2cc8f2a94b67b3533a048a80396aa">More...</a><br/></td></tr> |
| <tr class="separator:a76a2cc8f2a94b67b3533a048a80396aa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a86039963ae5d682ffc287aefd520f6f9"><td class="memTemplParams" colspan="2">template<typename xpu , typename DType > </td></tr> |
| <tr class="memitem:a86039963ae5d682ffc287aefd520f6f9"><td align="right" class="memTemplItemLeft" valign="top">mshadow::Random< xpu, DType > * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#a86039963ae5d682ffc287aefd520f6f9">get_random</a> (mshadow::Stream< xpu > *stream) const </td></tr> |
| <tr class="memdesc:a86039963ae5d682ffc287aefd520f6f9"><td class="mdescLeft"> </td><td class="mdescRight">Get random number generator. <a href="#a86039963ae5d682ffc287aefd520f6f9">More...</a><br/></td></tr> |
| <tr class="separator:a86039963ae5d682ffc287aefd520f6f9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af181352be1fbf440eb43540c7d9d61fb"><td class="memTemplParams" colspan="2">template<typename xpu , typename DType > </td></tr> |
| <tr class="memitem:af181352be1fbf440eb43540c7d9d61fb"><td align="right" class="memTemplItemLeft" valign="top"><a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator.html">common::random::RandGenerator</a>< xpu, DType > * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#af181352be1fbf440eb43540c7d9d61fb">get_parallel_random</a> () const </td></tr> |
| <tr class="memdesc:af181352be1fbf440eb43540c7d9d61fb"><td class="mdescLeft"> </td><td class="mdescRight">Get parallel random number generator. <a href="#af181352be1fbf440eb43540c7d9d61fb">More...</a><br/></td></tr> |
| <tr class="separator:af181352be1fbf440eb43540c7d9d61fb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab2be3ebdd3c5f5fa181ac4f6cdd69508"><td class="memTemplParams" colspan="2">template<typename xpu , int ndim> </td></tr> |
| <tr class="memitem:ab2be3ebdd3c5f5fa181ac4f6cdd69508"><td align="right" class="memTemplItemLeft" valign="top">mshadow::Tensor< xpu, ndim, <a class="el" href="namespacemxnet.html#a4421326e33f2a848cb2fa3e70ab24ff4">real_t</a> > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#ab2be3ebdd3c5f5fa181ac4f6cdd69508">get_space</a> (mshadow::Shape< ndim > shape, mshadow::Stream< xpu > *stream) const </td></tr> |
| <tr class="memdesc:ab2be3ebdd3c5f5fa181ac4f6cdd69508"><td class="mdescLeft"> </td><td class="mdescRight">Get space requested as mshadow Tensor. The caller can request arbitrary size. <a href="#ab2be3ebdd3c5f5fa181ac4f6cdd69508">More...</a><br/></td></tr> |
| <tr class="separator:ab2be3ebdd3c5f5fa181ac4f6cdd69508"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a92724193fad2a6c5e2a63687e63e3d80"><td class="memTemplParams" colspan="2">template<int ndim> </td></tr> |
| <tr class="memitem:a92724193fad2a6c5e2a63687e63e3d80"><td align="right" class="memTemplItemLeft" valign="top">mshadow::Tensor< <a class="el" href="namespacemxnet.html#a850af9d76d9d4beaeb5234c1434973e3">cpu</a>, ndim, <a class="el" href="namespacemxnet.html#a4421326e33f2a848cb2fa3e70ab24ff4">real_t</a> > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#a92724193fad2a6c5e2a63687e63e3d80">get_host_space</a> (mshadow::Shape< ndim > shape) const </td></tr> |
| <tr class="memdesc:a92724193fad2a6c5e2a63687e63e3d80"><td class="mdescLeft"> </td><td class="mdescRight">Get cpu space requested as mshadow Tensor. The caller can request arbitrary size. <a href="#a92724193fad2a6c5e2a63687e63e3d80">More...</a><br/></td></tr> |
| <tr class="separator:a92724193fad2a6c5e2a63687e63e3d80"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a84e66895d72f9e99ae994de86539a77e"><td class="memTemplParams" colspan="2">template<typename xpu , int ndim, typename DType > </td></tr> |
| <tr class="memitem:a84e66895d72f9e99ae994de86539a77e"><td align="right" class="memTemplItemLeft" valign="top">mshadow::Tensor< xpu, ndim, DType > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#a84e66895d72f9e99ae994de86539a77e">get_space_typed</a> (mshadow::Shape< ndim > shape, mshadow::Stream< xpu > *stream) const </td></tr> |
| <tr class="memdesc:a84e66895d72f9e99ae994de86539a77e"><td class="mdescLeft"> </td><td class="mdescRight">Get space requested as mshadow Tensor in specified type. The caller can request arbitrary size. <a href="#a84e66895d72f9e99ae994de86539a77e">More...</a><br/></td></tr> |
| <tr class="separator:a84e66895d72f9e99ae994de86539a77e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7c6dff75a9e05a7394b02c84b79a14b2"><td class="memTemplParams" colspan="2">template<int ndim, typename DType > </td></tr> |
| <tr class="memitem:a7c6dff75a9e05a7394b02c84b79a14b2"><td align="right" class="memTemplItemLeft" valign="top">mshadow::Tensor< <a class="el" href="namespacemxnet.html#a850af9d76d9d4beaeb5234c1434973e3">cpu</a>, ndim, DType > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#a7c6dff75a9e05a7394b02c84b79a14b2">get_host_space_typed</a> (mshadow::Shape< ndim > shape) const </td></tr> |
| <tr class="memdesc:a7c6dff75a9e05a7394b02c84b79a14b2"><td class="mdescLeft"> </td><td class="mdescRight">Get CPU space as mshadow Tensor in specified type. The caller can request arbitrary size. <a href="#a7c6dff75a9e05a7394b02c84b79a14b2">More...</a><br/></td></tr> |
| <tr class="separator:a7c6dff75a9e05a7394b02c84b79a14b2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af57d32e959227f49d54d6eb6a5c62875"><td align="right" class="memItemLeft" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#af57d32e959227f49d54d6eb6a5c62875">get_space_internal</a> (size_t size) const </td></tr> |
| <tr class="memdesc:af57d32e959227f49d54d6eb6a5c62875"><td class="mdescLeft"> </td><td class="mdescRight">internal function to get space from resources. <a href="#af57d32e959227f49d54d6eb6a5c62875">More...</a><br/></td></tr> |
| <tr class="separator:af57d32e959227f49d54d6eb6a5c62875"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af6e0224f60b5e9afd3c883972863537f"><td align="right" class="memItemLeft" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#af6e0224f60b5e9afd3c883972863537f">get_host_space_internal</a> (size_t size) const </td></tr> |
| <tr class="memdesc:af6e0224f60b5e9afd3c883972863537f"><td class="mdescLeft"> </td><td class="mdescRight">internal function to get cpu space from resources. <a href="#af6e0224f60b5e9afd3c883972863537f">More...</a><br/></td></tr> |
| <tr class="separator:af6e0224f60b5e9afd3c883972863537f"><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:ae841e25cf5ee4aed895ace7fa080edc4"><td align="right" class="memItemLeft" valign="top"><a class="el" href="structmxnet_1_1ResourceRequest.html">ResourceRequest</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#ae841e25cf5ee4aed895ace7fa080edc4">req</a></td></tr> |
| <tr class="memdesc:ae841e25cf5ee4aed895ace7fa080edc4"><td class="mdescLeft"> </td><td class="mdescRight">The original request. <a href="#ae841e25cf5ee4aed895ace7fa080edc4">More...</a><br/></td></tr> |
| <tr class="separator:ae841e25cf5ee4aed895ace7fa080edc4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5a8048bdda73fefa3af322aaaba50eb8"><td align="right" class="memItemLeft" valign="top"><a class="el" href="namespacemxnet_1_1engine.html#a9d36c4f33eae8531586dc2edf83ae7cf">engine::VarHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#a5a8048bdda73fefa3af322aaaba50eb8">var</a></td></tr> |
| <tr class="memdesc:a5a8048bdda73fefa3af322aaaba50eb8"><td class="mdescLeft"> </td><td class="mdescRight">engine variable <a href="#a5a8048bdda73fefa3af322aaaba50eb8">More...</a><br/></td></tr> |
| <tr class="separator:a5a8048bdda73fefa3af322aaaba50eb8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa1fc8578c0fa849afe7da29c1cf1308b"><td align="right" class="memItemLeft" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#aa1fc8578c0fa849afe7da29c1cf1308b">id</a></td></tr> |
| <tr class="memdesc:aa1fc8578c0fa849afe7da29c1cf1308b"><td class="mdescLeft"> </td><td class="mdescRight">identifier of id information, used for debug purpose <a href="#aa1fc8578c0fa849afe7da29c1cf1308b">More...</a><br/></td></tr> |
| <tr class="separator:aa1fc8578c0fa849afe7da29c1cf1308b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7e9576783b7e9023375ffebd76a11806"><td align="right" class="memItemLeft" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#a7e9576783b7e9023375ffebd76a11806">ptr_</a></td></tr> |
| <tr class="memdesc:a7e9576783b7e9023375ffebd76a11806"><td class="mdescLeft"> </td><td class="mdescRight">pointer to the resource, do not use directly, access using member functions <a href="#a7e9576783b7e9023375ffebd76a11806">More...</a><br/></td></tr> |
| <tr class="separator:a7e9576783b7e9023375ffebd76a11806"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Resources used by mxnet operations. A resource is something special other than <a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a>, but will still participate. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a76a2cc8f2a94b67b3533a048a80396aa"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mxnet::Resource::Resource </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> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a92724193fad2a6c5e2a63687e63e3d80"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<int ndim> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mshadow::Tensor<<a class="el" href="namespacemxnet.html#a850af9d76d9d4beaeb5234c1434973e3">cpu</a>, ndim, <a class="el" href="namespacemxnet.html#a4421326e33f2a848cb2fa3e70ab24ff4">real_t</a>> mxnet::Resource::get_host_space </td> |
| <td>(</td> |
| <td class="paramtype">mshadow::Shape< ndim > </td> |
| <td class="paramname"><em>shape</em></td><td>)</td> |
| <td> const</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>Get cpu space requested as mshadow Tensor. The caller can request arbitrary size. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">shape</td><td>the Shape of returning tensor. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the mshadow tensor requested. </dd></dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">ndim</td><td>the number of dimension of the tensor requested. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <a class="anchor" id="af6e0224f60b5e9afd3c883972863537f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void* mxnet::Resource::get_host_space_internal </td> |
| <td>(</td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>size</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>internal function to get cpu space from resources. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">size</td><td>The size of space. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The allocated space </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="a7c6dff75a9e05a7394b02c84b79a14b2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<int ndim, typename DType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mshadow::Tensor<<a class="el" href="namespacemxnet.html#a850af9d76d9d4beaeb5234c1434973e3">cpu</a>, ndim, DType> mxnet::Resource::get_host_space_typed </td> |
| <td>(</td> |
| <td class="paramtype">mshadow::Shape< ndim > </td> |
| <td class="paramname"><em>shape</em></td><td>)</td> |
| <td> const</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>Get CPU space as mshadow Tensor in specified type. The caller can request arbitrary size. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">shape</td><td>the Shape of returning tensor </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the mshadow tensor requested </dd></dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">ndim</td><td>the number of dimnesion of tensor requested </td></tr> |
| <tr><td class="paramname">DType</td><td>request data type </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <a class="anchor" id="af181352be1fbf440eb43540c7d9d61fb"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename xpu , typename DType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator.html">common::random::RandGenerator</a><xpu, DType>* mxnet::Resource::get_parallel_random </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</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>Get parallel random number generator. </p> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">xpu</td><td>the device type of random number generator. </td></tr> |
| <tr><td class="paramname">DType</td><td>the return type. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the parallel random number generator. for gpu, it is allocated on global memory. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="a86039963ae5d682ffc287aefd520f6f9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename xpu , typename DType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mshadow::Random<xpu, DType>* mxnet::Resource::get_random </td> |
| <td>(</td> |
| <td class="paramtype">mshadow::Stream< xpu > * </td> |
| <td class="paramname"><em>stream</em></td><td>)</td> |
| <td> const</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>Get random number generator. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>The stream to use in the random number generator. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the mshadow random number generator requested. </dd></dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">xpu</td><td>the device type of random number generator. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <a class="anchor" id="ab2be3ebdd3c5f5fa181ac4f6cdd69508"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename xpu , int ndim> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mshadow::Tensor<xpu, ndim, <a class="el" href="namespacemxnet.html#a4421326e33f2a848cb2fa3e70ab24ff4">real_t</a>> mxnet::Resource::get_space </td> |
| <td>(</td> |
| <td class="paramtype">mshadow::Shape< ndim > </td> |
| <td class="paramname"><em>shape</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">mshadow::Stream< xpu > * </td> |
| <td class="paramname"><em>stream</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</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>Get space requested as mshadow Tensor. The caller can request arbitrary size. </p> |
| <p>This space can be shared with other calls to this->get_space. So the caller need to serialize the calls when using the conflicted space. The old space can get freed, however, this will incur a synchronization, when running on device, so the launched kernels that depend on the temp space can finish correctly.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">shape</td><td>the Shape of returning tensor. </td></tr> |
| <tr><td class="paramname">stream</td><td>the stream of retruning tensor. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the mshadow tensor requested. </dd></dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">xpu</td><td>the device type of random number generator. </td></tr> |
| <tr><td class="paramname">ndim</td><td>the number of dimension of the tensor requested. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <a class="anchor" id="af57d32e959227f49d54d6eb6a5c62875"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void* mxnet::Resource::get_space_internal </td> |
| <td>(</td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>size</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>internal function to get space from resources. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">size</td><td>The size of the space. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The allocated space. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="a84e66895d72f9e99ae994de86539a77e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename xpu , int ndim, typename DType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mshadow::Tensor<xpu, ndim, DType> mxnet::Resource::get_space_typed </td> |
| <td>(</td> |
| <td class="paramtype">mshadow::Shape< ndim > </td> |
| <td class="paramname"><em>shape</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">mshadow::Stream< xpu > * </td> |
| <td class="paramname"><em>stream</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</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>Get space requested as mshadow Tensor in specified type. The caller can request arbitrary size. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">shape</td><td>the Shape of returning tensor. </td></tr> |
| <tr><td class="paramname">stream</td><td>the stream of retruning tensor. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the mshadow tensor requested. </dd></dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">xpu</td><td>the device type of random number generator. </td></tr> |
| <tr><td class="paramname">ndim</td><td>the number of dimension of the tensor requested. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="aa1fc8578c0fa849afe7da29c1cf1308b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int32_t mxnet::Resource::id</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>identifier of id information, used for debug purpose </p> |
| </div> |
| </div> |
| <a class="anchor" id="a7e9576783b7e9023375ffebd76a11806"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void* mxnet::Resource::ptr_</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>pointer to the resource, do not use directly, access using member functions </p> |
| </div> |
| </div> |
| <a class="anchor" id="ae841e25cf5ee4aed895ace7fa080edc4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="structmxnet_1_1ResourceRequest.html">ResourceRequest</a> mxnet::Resource::req</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>The original request. </p> |
| </div> |
| </div> |
| <a class="anchor" id="a5a8048bdda73fefa3af322aaaba50eb8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacemxnet_1_1engine.html#a9d36c4f33eae8531586dc2edf83ae7cf">engine::VarHandle</a> mxnet::Resource::var</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>engine variable </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 Thu Sep 19 2019 12:37:33 for mxnet by <a href="http://www.doxygen.org/index.html"> |
| <img alt="doxygen" class="footer" src="doxygen.png"/> |
| </a> 1.8.11 |
| </small></address> |
| </body> |
| </html> |
