| <!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.11"/> |
| <title>mxnet: OpResource Class 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> |
| <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 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.11 --> |
| <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 Page</span></a></li> |
| <li><a href="modules.html"><span>Modules</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 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="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" |
| 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><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classOpResource-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">OpResource Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>provide resource APIs memory allocation mechanism to Forward/Backward functions |
| <a href="classOpResource.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="lib__api_8h_source.html">lib_api.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for OpResource:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classOpResource__coll__graph.png" border="0" usemap="#OpResource_coll__map" alt="Collaboration graph"/></div> |
| <map name="OpResource_coll__map" id="OpResource_coll__map"> |
| </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:a6471d878703887fdb89dfe69bf64b67b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpResource.html#a6471d878703887fdb89dfe69bf64b67b">OpResource</a> (<a class="el" href="lib__api_8h.html#a968fbc7c8188f24a0c761e04e6683f46">xpu_malloc_t</a> cpu_malloc_fp, void *cpu_alloc_fp, <a class="el" href="lib__api_8h.html#a968fbc7c8188f24a0c761e04e6683f46">xpu_malloc_t</a> gpu_malloc_fp, void *gpu_alloc_fp, void *stream, <a class="el" href="lib__api_8h.html#a67cbe0396691abf6f71dc89cfdf42113">sparse_malloc_t</a> sparse_malloc_fp, void *sparse_alloc_fp, void *rng_cpu_states, void *rng_gpu_states)</td></tr> |
| <tr class="separator:a6471d878703887fdb89dfe69bf64b67b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adf842311bd61ec0a834ee477ee374649"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpResource.html#adf842311bd61ec0a834ee477ee374649">alloc_cpu</a> (int size) const </td></tr> |
| <tr class="memdesc:adf842311bd61ec0a834ee477ee374649"><td class="mdescLeft"> </td><td class="mdescRight">allocate cpu memory controlled by MXNet <a href="#adf842311bd61ec0a834ee477ee374649">More...</a><br /></td></tr> |
| <tr class="separator:adf842311bd61ec0a834ee477ee374649"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6b537e802679d429fc20165ae4aed716"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpResource.html#a6b537e802679d429fc20165ae4aed716">alloc_gpu</a> (int size) const </td></tr> |
| <tr class="memdesc:a6b537e802679d429fc20165ae4aed716"><td class="mdescLeft"> </td><td class="mdescRight">allocate gpu memory controlled by MXNet <a href="#a6b537e802679d429fc20165ae4aed716">More...</a><br /></td></tr> |
| <tr class="separator:a6b537e802679d429fc20165ae4aed716"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aad10bf33d01e020cad28051e3de5296d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="lib__api_8h.html#ad8162b92183ede23d6d3c3195f87e69a">mx_stream_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpResource.html#aad10bf33d01e020cad28051e3de5296d">get_cuda_stream</a> () const </td></tr> |
| <tr class="memdesc:aad10bf33d01e020cad28051e3de5296d"><td class="mdescLeft"> </td><td class="mdescRight">return the cuda stream object with correct type <a href="#aad10bf33d01e020cad28051e3de5296d">More...</a><br /></td></tr> |
| <tr class="separator:aad10bf33d01e020cad28051e3de5296d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa539223f5762668ecb9a57e8a6ff16ae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpResource.html#aa539223f5762668ecb9a57e8a6ff16ae">alloc_sparse</a> (<a class="el" href="structMXSparse.html">MXSparse</a> *sparse, int index, int indices_len, int indptr_len=0) const </td></tr> |
| <tr class="memdesc:aa539223f5762668ecb9a57e8a6ff16ae"><td class="mdescLeft"> </td><td class="mdescRight">allocate sparse memory controlled by MXNet <a href="#aa539223f5762668ecb9a57e8a6ff16ae">More...</a><br /></td></tr> |
| <tr class="separator:aa539223f5762668ecb9a57e8a6ff16ae"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a032dfa01de54cc58c97dc0b3c2b884fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="lib__api_8h.html#a9157ce7266380f368c7108e9c01de9cf">mx_cpu_rand_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpResource.html#a032dfa01de54cc58c97dc0b3c2b884fc">get_cpu_rand_states</a> () const </td></tr> |
| <tr class="memdesc:a032dfa01de54cc58c97dc0b3c2b884fc"><td class="mdescLeft"> </td><td class="mdescRight">get pointer to initialized and seeded random number states located on CPU <a href="#a032dfa01de54cc58c97dc0b3c2b884fc">More...</a><br /></td></tr> |
| <tr class="separator:a032dfa01de54cc58c97dc0b3c2b884fc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abe5802f0dd55055507e334f4d707c39d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="lib__api_8h.html#ac3e9b5f89cdbed5da83c4d1e82b353f6">mx_gpu_rand_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpResource.html#abe5802f0dd55055507e334f4d707c39d">get_gpu_rand_states</a> () const </td></tr> |
| <tr class="memdesc:abe5802f0dd55055507e334f4d707c39d"><td class="mdescLeft"> </td><td class="mdescRight">get pointer to initialized and seeded random number states located on GPU <a href="#abe5802f0dd55055507e334f4d707c39d">More...</a><br /></td></tr> |
| <tr class="separator:abe5802f0dd55055507e334f4d707c39d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>provide resource APIs memory allocation mechanism to Forward/Backward functions </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a6471d878703887fdb89dfe69bf64b67b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">OpResource::OpResource </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="lib__api_8h.html#a968fbc7c8188f24a0c761e04e6683f46">xpu_malloc_t</a> </td> |
| <td class="paramname"><em>cpu_malloc_fp</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>cpu_alloc_fp</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="lib__api_8h.html#a968fbc7c8188f24a0c761e04e6683f46">xpu_malloc_t</a> </td> |
| <td class="paramname"><em>gpu_malloc_fp</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>gpu_alloc_fp</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>stream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="lib__api_8h.html#a67cbe0396691abf6f71dc89cfdf42113">sparse_malloc_t</a> </td> |
| <td class="paramname"><em>sparse_malloc_fp</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>sparse_alloc_fp</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>rng_cpu_states</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>rng_gpu_states</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</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"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="adf842311bd61ec0a834ee477ee374649"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void* OpResource::alloc_cpu </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>size</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>allocate cpu memory controlled by MXNet </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6b537e802679d429fc20165ae4aed716"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void* OpResource::alloc_gpu </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>size</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>allocate gpu memory controlled by MXNet </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa539223f5762668ecb9a57e8a6ff16ae"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void OpResource::alloc_sparse </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structMXSparse.html">MXSparse</a> * </td> |
| <td class="paramname"><em>sparse</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>index</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>indices_len</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>indptr_len</em> = <code>0</code> </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>allocate sparse memory controlled by MXNet </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a032dfa01de54cc58c97dc0b3c2b884fc"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="lib__api_8h.html#a9157ce7266380f368c7108e9c01de9cf">mx_cpu_rand_t</a>* OpResource::get_cpu_rand_states </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 pointer to initialized and seeded random number states located on CPU </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aad10bf33d01e020cad28051e3de5296d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="lib__api_8h.html#ad8162b92183ede23d6d3c3195f87e69a">mx_stream_t</a> OpResource::get_cuda_stream </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>return the cuda stream object with correct type </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="abe5802f0dd55055507e334f4d707c39d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="lib__api_8h.html#ac3e9b5f89cdbed5da83c4d1e82b353f6">mx_gpu_rand_t</a>* OpResource::get_gpu_rand_states </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 pointer to initialized and seeded random number states located on GPU </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/include/mxnet/<a class="el" href="lib__api_8h_source.html">lib_api.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Fri Sep 11 2020 03:38:05 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.11 |
| </small></address> |
| </body> |
| </html> |
