| <!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.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: mxnet::Resource 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.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </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_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 src="structmxnet_1_1Resource__coll__graph.png" border="0" usemap="#mxnet_1_1Resource_coll__map" alt="Collaboration graph"/></div> |
| <map name="mxnet_1_1Resource_coll__map" id="mxnet_1_1Resource_coll__map"> |
| <area shape="rect" id="node2" href="structmxnet_1_1ResourceRequest.html" title="The resources that can be requested by Operator. " alt="" coords="17,5,199,97"/> |
| </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 class="memItemLeft" align="right" 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:a18ed29b378bdfad93358c275967afe60"><td class="memTemplParams" colspan="2">template<typename xpu , typename DType > </td></tr> |
| <tr class="memitem:a18ed29b378bdfad93358c275967afe60"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmshadow_1_1Random.html">mshadow::Random</a>< xpu, DType > * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#a18ed29b378bdfad93358c275967afe60">get_random</a> (<a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>< xpu > *stream) const</td></tr> |
| <tr class="memdesc:a18ed29b378bdfad93358c275967afe60"><td class="mdescLeft"> </td><td class="mdescRight">Get random number generator. <a href="#a18ed29b378bdfad93358c275967afe60">More...</a><br /></td></tr> |
| <tr class="separator:a18ed29b378bdfad93358c275967afe60"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a01d3688ee499b78722a72789fbe08f3b"><td class="memTemplParams" colspan="2">template<typename xpu , typename DType > </td></tr> |
| <tr class="memitem:a01d3688ee499b78722a72789fbe08f3b"><td class="memTemplItemLeft" align="right" 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#a01d3688ee499b78722a72789fbe08f3b">get_parallel_random</a> () const</td></tr> |
| <tr class="memdesc:a01d3688ee499b78722a72789fbe08f3b"><td class="mdescLeft"> </td><td class="mdescRight">Get parallel random number generator. <a href="#a01d3688ee499b78722a72789fbe08f3b">More...</a><br /></td></tr> |
| <tr class="separator:a01d3688ee499b78722a72789fbe08f3b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3c3ced58b1ed0e4fdb0f8e62c6c4a362"><td class="memTemplParams" colspan="2">template<typename xpu , int ndim> </td></tr> |
| <tr class="memitem:a3c3ced58b1ed0e4fdb0f8e62c6c4a362"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structmshadow_1_1Tensor.html">mshadow::Tensor</a>< 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#a3c3ced58b1ed0e4fdb0f8e62c6c4a362">get_space</a> (<a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>< ndim > shape, <a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>< xpu > *stream) const</td></tr> |
| <tr class="memdesc:a3c3ced58b1ed0e4fdb0f8e62c6c4a362"><td class="mdescLeft"> </td><td class="mdescRight">Get space requested as mshadow Tensor. The caller can request arbitrary size. <a href="#a3c3ced58b1ed0e4fdb0f8e62c6c4a362">More...</a><br /></td></tr> |
| <tr class="separator:a3c3ced58b1ed0e4fdb0f8e62c6c4a362"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a71ac977a7b8dd6abbee947df43c85ec1"><td class="memTemplParams" colspan="2">template<int ndim> </td></tr> |
| <tr class="memitem:a71ac977a7b8dd6abbee947df43c85ec1"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structmshadow_1_1Tensor.html">mshadow::Tensor</a>< <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#a71ac977a7b8dd6abbee947df43c85ec1">get_host_space</a> (<a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>< ndim > shape) const</td></tr> |
| <tr class="memdesc:a71ac977a7b8dd6abbee947df43c85ec1"><td class="mdescLeft"> </td><td class="mdescRight">Get cpu space requested as mshadow Tensor. The caller can request arbitrary size. <a href="#a71ac977a7b8dd6abbee947df43c85ec1">More...</a><br /></td></tr> |
| <tr class="separator:a71ac977a7b8dd6abbee947df43c85ec1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a95f1c70975a646f9db28140798ae87d0"><td class="memTemplParams" colspan="2">template<typename xpu , int ndim, typename DType > </td></tr> |
| <tr class="memitem:a95f1c70975a646f9db28140798ae87d0"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structmshadow_1_1Tensor.html">mshadow::Tensor</a>< xpu, ndim, DType > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#a95f1c70975a646f9db28140798ae87d0">get_space_typed</a> (<a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>< ndim > shape, <a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>< xpu > *stream) const</td></tr> |
| <tr class="memdesc:a95f1c70975a646f9db28140798ae87d0"><td class="mdescLeft"> </td><td class="mdescRight">Get space requested as mshadow Tensor in specified type. The caller can request arbitrary size. <a href="#a95f1c70975a646f9db28140798ae87d0">More...</a><br /></td></tr> |
| <tr class="separator:a95f1c70975a646f9db28140798ae87d0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3dc6c8f2b200e2e045fe0ff74c18e5f7"><td class="memTemplParams" colspan="2">template<int ndim, typename DType > </td></tr> |
| <tr class="memitem:a3dc6c8f2b200e2e045fe0ff74c18e5f7"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structmshadow_1_1Tensor.html">mshadow::Tensor</a>< <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#a3dc6c8f2b200e2e045fe0ff74c18e5f7">get_host_space_typed</a> (<a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>< ndim > shape) const</td></tr> |
| <tr class="memdesc:a3dc6c8f2b200e2e045fe0ff74c18e5f7"><td class="mdescLeft"> </td><td class="mdescRight">Get CPU space as mshadow Tensor in specified type. The caller can request arbitrary size. <a href="#a3dc6c8f2b200e2e045fe0ff74c18e5f7">More...</a><br /></td></tr> |
| <tr class="separator:a3dc6c8f2b200e2e045fe0ff74c18e5f7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9e78ffb2885f9411ecb52683d935e9c1"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#a9e78ffb2885f9411ecb52683d935e9c1">get_space_internal</a> (size_t size) const</td></tr> |
| <tr class="memdesc:a9e78ffb2885f9411ecb52683d935e9c1"><td class="mdescLeft"> </td><td class="mdescRight">internal function to get space from resources. <a href="#a9e78ffb2885f9411ecb52683d935e9c1">More...</a><br /></td></tr> |
| <tr class="separator:a9e78ffb2885f9411ecb52683d935e9c1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a220125a23ff2a0666ec0ec498a71c19b"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Resource.html#a220125a23ff2a0666ec0ec498a71c19b">get_host_space_internal</a> (size_t size) const</td></tr> |
| <tr class="memdesc:a220125a23ff2a0666ec0ec498a71c19b"><td class="mdescLeft"> </td><td class="mdescRight">internal function to get cpu space from resources. <a href="#a220125a23ff2a0666ec0ec498a71c19b">More...</a><br /></td></tr> |
| <tr class="separator:a220125a23ff2a0666ec0ec498a71c19b"><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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 name="details" id="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 id="a76a2cc8f2a94b67b3533a048a80396aa"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a76a2cc8f2a94b67b3533a048a80396aa">◆ </a></span>Resource()</h2> |
| |
| <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 id="a71ac977a7b8dd6abbee947df43c85ec1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a71ac977a7b8dd6abbee947df43c85ec1">◆ </a></span>get_host_space()</h2> |
| |
| <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"><a class="el" href="structmshadow_1_1Tensor.html">mshadow::Tensor</a><<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"><a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>< 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 id="a220125a23ff2a0666ec0ec498a71c19b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a220125a23ff2a0666ec0ec498a71c19b">◆ </a></span>get_host_space_internal()</h2> |
| |
| <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 id="a3dc6c8f2b200e2e045fe0ff74c18e5f7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3dc6c8f2b200e2e045fe0ff74c18e5f7">◆ </a></span>get_host_space_typed()</h2> |
| |
| <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"><a class="el" href="structmshadow_1_1Tensor.html">mshadow::Tensor</a><<a class="el" href="namespacemxnet.html#a850af9d76d9d4beaeb5234c1434973e3">cpu</a>, ndim, DType> mxnet::Resource::get_host_space_typed </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>< 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 id="a01d3688ee499b78722a72789fbe08f3b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a01d3688ee499b78722a72789fbe08f3b">◆ </a></span>get_parallel_random()</h2> |
| |
| <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 id="a18ed29b378bdfad93358c275967afe60"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a18ed29b378bdfad93358c275967afe60">◆ </a></span>get_random()</h2> |
| |
| <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="classmshadow_1_1Random.html">mshadow::Random</a><xpu, DType>* mxnet::Resource::get_random </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>< 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 id="a3c3ced58b1ed0e4fdb0f8e62c6c4a362"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3c3ced58b1ed0e4fdb0f8e62c6c4a362">◆ </a></span>get_space()</h2> |
| |
| <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"><a class="el" href="structmshadow_1_1Tensor.html">mshadow::Tensor</a><xpu, ndim, <a class="el" href="namespacemxnet.html#a4421326e33f2a848cb2fa3e70ab24ff4">real_t</a>> mxnet::Resource::get_space </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>< ndim > </td> |
| <td class="paramname"><em>shape</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>< 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 id="a9e78ffb2885f9411ecb52683d935e9c1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9e78ffb2885f9411ecb52683d935e9c1">◆ </a></span>get_space_internal()</h2> |
| |
| <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 id="a95f1c70975a646f9db28140798ae87d0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a95f1c70975a646f9db28140798ae87d0">◆ </a></span>get_space_typed()</h2> |
| |
| <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"><a class="el" href="structmshadow_1_1Tensor.html">mshadow::Tensor</a><xpu, ndim, DType> mxnet::Resource::get_space_typed </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>< ndim > </td> |
| <td class="paramname"><em>shape</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>< 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 id="aa1fc8578c0fa849afe7da29c1cf1308b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa1fc8578c0fa849afe7da29c1cf1308b">◆ </a></span>id</h2> |
| |
| <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 id="a7e9576783b7e9023375ffebd76a11806"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7e9576783b7e9023375ffebd76a11806">◆ </a></span>ptr_</h2> |
| |
| <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 id="ae841e25cf5ee4aed895ace7fa080edc4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae841e25cf5ee4aed895ace7fa080edc4">◆ </a></span>req</h2> |
| |
| <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 id="a5a8048bdda73fefa3af322aaaba50eb8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5a8048bdda73fefa3af322aaaba50eb8">◆ </a></span>var</h2> |
| |
| <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>/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 00:58:44 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
