| <!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::common::ObjectPool< T > Class Template 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="namespacemxnet_1_1common.html">common</a></li><li class="navelem"><a class="el" href="classmxnet_1_1common_1_1ObjectPool.html">ObjectPool</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classmxnet_1_1common_1_1ObjectPool-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::common::ObjectPool< T > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <p>Object pool for fast allocation and deallocation. |
| <a href="classmxnet_1_1common_1_1ObjectPool.html#details">More...</a></p> |
| <p><code>#include <<a class="el" href="object__pool_8h_source.html">object_pool.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::common::ObjectPool< T >:</div> |
| <div class="dyncontent"> |
| <div class="center"><img alt="Collaboration graph" border="0" src="classmxnet_1_1common_1_1ObjectPool__coll__graph.png" usemap="#mxnet_1_1common_1_1ObjectPool_3_01T_01_4_coll__map"/></div> |
| <map id="mxnet_1_1common_1_1ObjectPool_3_01T_01_4_coll__map" name="mxnet_1_1common_1_1ObjectPool_3_01T_01_4_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:aa5ff3f223210e5f3d0881c272462aedb"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1ObjectPool.html#aa5ff3f223210e5f3d0881c272462aedb">~ObjectPool</a> ()</td></tr> |
| <tr class="memdesc:aa5ff3f223210e5f3d0881c272462aedb"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aa5ff3f223210e5f3d0881c272462aedb">More...</a><br/></td></tr> |
| <tr class="separator:aa5ff3f223210e5f3d0881c272462aedb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5d711031f61dbd06d8c6975fd49e5632"><td class="memTemplParams" colspan="2">template<typename... Args> </td></tr> |
| <tr class="memitem:a5d711031f61dbd06d8c6975fd49e5632"><td align="right" class="memTemplItemLeft" valign="top">T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1ObjectPool.html#a5d711031f61dbd06d8c6975fd49e5632">New</a> (Args &&...args)</td></tr> |
| <tr class="memdesc:a5d711031f61dbd06d8c6975fd49e5632"><td class="mdescLeft"> </td><td class="mdescRight">Create new object. <a href="#a5d711031f61dbd06d8c6975fd49e5632">More...</a><br/></td></tr> |
| <tr class="separator:a5d711031f61dbd06d8c6975fd49e5632"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7dcdcbe9b6764cedc28a1de2fbc8dd6f"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1ObjectPool.html#a7dcdcbe9b6764cedc28a1de2fbc8dd6f">Delete</a> (T *ptr)</td></tr> |
| <tr class="memdesc:a7dcdcbe9b6764cedc28a1de2fbc8dd6f"><td class="mdescLeft"> </td><td class="mdescRight">Delete an existing object. <a href="#a7dcdcbe9b6764cedc28a1de2fbc8dd6f">More...</a><br/></td></tr> |
| <tr class="separator:a7dcdcbe9b6764cedc28a1de2fbc8dd6f"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a82b4d0c3577560a4f6f62f482b125471"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="classmxnet_1_1common_1_1ObjectPool.html">ObjectPool</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1ObjectPool.html#a82b4d0c3577560a4f6f62f482b125471">Get</a> ()</td></tr> |
| <tr class="memdesc:a82b4d0c3577560a4f6f62f482b125471"><td class="mdescLeft"> </td><td class="mdescRight">Get singleton instance of pool. <a href="#a82b4d0c3577560a4f6f62f482b125471">More...</a><br/></td></tr> |
| <tr class="separator:a82b4d0c3577560a4f6f62f482b125471"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac6e5e05a710c3f094efb4ba13d36ab89"><td align="right" class="memItemLeft" valign="top">static std::shared_ptr< <a class="el" href="classmxnet_1_1common_1_1ObjectPool.html">ObjectPool</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1ObjectPool.html#ac6e5e05a710c3f094efb4ba13d36ab89">_GetSharedRef</a> ()</td></tr> |
| <tr class="memdesc:ac6e5e05a710c3f094efb4ba13d36ab89"><td class="mdescLeft"> </td><td class="mdescRight">Get a shared ptr of the singleton instance of pool. <a href="#ac6e5e05a710c3f094efb4ba13d36ab89">More...</a><br/></td></tr> |
| <tr class="separator:ac6e5e05a710c3f094efb4ba13d36ab89"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<typename T><br/> |
| class mxnet::common::ObjectPool< T ></h3> |
| <p>Object pool for fast allocation and deallocation. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="aa5ff3f223210e5f3d0881c272462aedb"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1common_1_1ObjectPool.html">mxnet::common::ObjectPool</a>< T >::~<a class="el" href="classmxnet_1_1common_1_1ObjectPool.html">ObjectPool</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Destructor. </p> |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="ac6e5e05a710c3f094efb4ba13d36ab89"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr< <a class="el" href="classmxnet_1_1common_1_1ObjectPool.html">ObjectPool</a>< T > > <a class="el" href="classmxnet_1_1common_1_1ObjectPool.html">mxnet::common::ObjectPool</a>< T >::_GetSharedRef </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get a shared ptr of the singleton instance of pool. </p> |
| <dl class="section return"><dt>Returns</dt><dd>Shared pointer to the Object Pool. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="a7dcdcbe9b6764cedc28a1de2fbc8dd6f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classmxnet_1_1common_1_1ObjectPool.html">mxnet::common::ObjectPool</a>< T >::Delete </td> |
| <td>(</td> |
| <td class="paramtype">T * </td> |
| <td class="paramname"><em>ptr</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Delete an existing object. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">ptr</td><td>The pointer to delete.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>Make sure the pointer to delete is allocated from this pool. </p> |
| </div> |
| </div> |
| <a class="anchor" id="a82b4d0c3577560a4f6f62f482b125471"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1common_1_1ObjectPool.html">ObjectPool</a>< T > * <a class="el" href="classmxnet_1_1common_1_1ObjectPool.html">mxnet::common::ObjectPool</a>< T >::Get </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get singleton instance of pool. </p> |
| <dl class="section return"><dt>Returns</dt><dd>Object Pool. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="a5d711031f61dbd06d8c6975fd49e5632"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <div class="memtemplate"> |
| template<typename... Args> </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T * <a class="el" href="classmxnet_1_1common_1_1ObjectPool.html">mxnet::common::ObjectPool</a>< T >::New </td> |
| <td>(</td> |
| <td class="paramtype">Args &&... </td> |
| <td class="paramname"><em>args</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Create new object. </p> |
| <dl class="section return"><dt>Returns</dt><dd>Pointer to the new object. </dd></dl> |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/common/<a class="el" href="object__pool_8h_source.html">object_pool.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Sep 19 2019 13:11:20 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> |