| <!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::common::ObjectPool< T > Class Template 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&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&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="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 src="classmxnet_1_1common_1_1ObjectPool__coll__graph.png" border="0" usemap="#mxnet_1_1common_1_1ObjectPool_3_01T_01_4_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 0 --> |
| </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 class="memItemLeft" align="right" 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="classmxnet_1_1common_1_1ObjectPool.html#aa5ff3f223210e5f3d0881c272462aedb">More...</a><br /></td></tr> |
| <tr class="separator:aa5ff3f223210e5f3d0881c272462aedb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaadcbc99eaec88191b201bad9da441c6"><td class="memTemplParams" colspan="2">template<typename... Args> </td></tr> |
| <tr class="memitem:aaadcbc99eaec88191b201bad9da441c6"><td class="memTemplItemLeft" align="right" valign="top">T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1ObjectPool.html#aaadcbc99eaec88191b201bad9da441c6">New</a> (Args &&... args)</td></tr> |
| <tr class="memdesc:aaadcbc99eaec88191b201bad9da441c6"><td class="mdescLeft"> </td><td class="mdescRight">Create new object. <a href="classmxnet_1_1common_1_1ObjectPool.html#aaadcbc99eaec88191b201bad9da441c6">More...</a><br /></td></tr> |
| <tr class="separator:aaadcbc99eaec88191b201bad9da441c6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7dcdcbe9b6764cedc28a1de2fbc8dd6f"><td class="memItemLeft" align="right" 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="classmxnet_1_1common_1_1ObjectPool.html#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 class="memItemLeft" align="right" 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="classmxnet_1_1common_1_1ObjectPool.html#a82b4d0c3577560a4f6f62f482b125471">More...</a><br /></td></tr> |
| <tr class="separator:a82b4d0c3577560a4f6f62f482b125471"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a250b8d5cb7354eb565261cf24cabeb68"><td class="memItemLeft" align="right" valign="top">static const 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#a250b8d5cb7354eb565261cf24cabeb68">_GetSharedRef</a> ()</td></tr> |
| <tr class="memdesc:a250b8d5cb7354eb565261cf24cabeb68"><td class="mdescLeft"> </td><td class="mdescRight">Get a shared ptr of the singleton instance of pool. <a href="classmxnet_1_1common_1_1ObjectPool.html#a250b8d5cb7354eb565261cf24cabeb68">More...</a><br /></td></tr> |
| <tr class="separator:a250b8d5cb7354eb565261cf24cabeb68"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="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 id="aa5ff3f223210e5f3d0881c272462aedb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa5ff3f223210e5f3d0881c272462aedb">◆ </a></span>~ObjectPool()</h2> |
| |
| <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> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Destructor. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a250b8d5cb7354eb565261cf24cabeb68"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a250b8d5cb7354eb565261cf24cabeb68">◆ </a></span>_GetSharedRef()</h2> |
| |
| <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">const 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> |
| </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 id="a7dcdcbe9b6764cedc28a1de2fbc8dd6f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7dcdcbe9b6764cedc28a1de2fbc8dd6f">◆ </a></span>Delete()</h2> |
| |
| <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 id="a82b4d0c3577560a4f6f62f482b125471"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a82b4d0c3577560a4f6f62f482b125471">◆ </a></span>Get()</h2> |
| |
| <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> |
| </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 id="aaadcbc99eaec88191b201bad9da441c6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaadcbc99eaec88191b201bad9da441c6">◆ </a></span>New()</h2> |
| |
| <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>/work/mxnet/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 Sat Nov 5 2022 01:16:58 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |