| <!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: dmlc::ThreadlocalAllocator< 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="namespacedmlc.html">dmlc</a></li><li class="navelem"><a class="el" href="classdmlc_1_1ThreadlocalAllocator.html">ThreadlocalAllocator</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="classdmlc_1_1ThreadlocalAllocator-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::ThreadlocalAllocator< T > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A thread local allocator that get memory from a threadlocal memory pool. This is suitable to allocate objects that do not cross thread. |
| <a href="classdmlc_1_1ThreadlocalAllocator.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2memory_8h_source.html">memory.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::ThreadlocalAllocator< T >:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1ThreadlocalAllocator__coll__graph.png" border="0" usemap="#dmlc_1_1ThreadlocalAllocator_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-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:aa9509829a2b96a97eca105cfc918f8ee"><td class="memItemLeft" align="right" valign="top">typedef T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadlocalAllocator.html#aa9509829a2b96a97eca105cfc918f8ee">pointer</a></td></tr> |
| <tr class="memdesc:aa9509829a2b96a97eca105cfc918f8ee"><td class="mdescLeft"> </td><td class="mdescRight">pointer type <a href="classdmlc_1_1ThreadlocalAllocator.html#aa9509829a2b96a97eca105cfc918f8ee">More...</a><br /></td></tr> |
| <tr class="separator:aa9509829a2b96a97eca105cfc918f8ee"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a15e68f08f76d0dca8fd10bd09ace570c"><td class="memItemLeft" align="right" valign="top">typedef T </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadlocalAllocator.html#a15e68f08f76d0dca8fd10bd09ace570c">value_type</a></td></tr> |
| <tr class="memdesc:a15e68f08f76d0dca8fd10bd09ace570c"><td class="mdescLeft"> </td><td class="mdescRight">value type <a href="classdmlc_1_1ThreadlocalAllocator.html#a15e68f08f76d0dca8fd10bd09ace570c">More...</a><br /></td></tr> |
| <tr class="separator:a15e68f08f76d0dca8fd10bd09ace570c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><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:a647ff459997d57e201cf295a8afea966"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadlocalAllocator.html#a647ff459997d57e201cf295a8afea966">ThreadlocalAllocator</a> ()</td></tr> |
| <tr class="memdesc:a647ff459997d57e201cf295a8afea966"><td class="mdescLeft"> </td><td class="mdescRight">default constructor <a href="classdmlc_1_1ThreadlocalAllocator.html#a647ff459997d57e201cf295a8afea966">More...</a><br /></td></tr> |
| <tr class="separator:a647ff459997d57e201cf295a8afea966"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adc4594319463c55342eccaf3e49b0109"><td class="memTemplParams" colspan="2">template<typename U > </td></tr> |
| <tr class="memitem:adc4594319463c55342eccaf3e49b0109"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadlocalAllocator.html#adc4594319463c55342eccaf3e49b0109">ThreadlocalAllocator</a> (const <a class="el" href="classdmlc_1_1ThreadlocalAllocator.html">ThreadlocalAllocator</a>< U > &other)</td></tr> |
| <tr class="memdesc:adc4594319463c55342eccaf3e49b0109"><td class="mdescLeft"> </td><td class="mdescRight">constructor from another allocator <a href="classdmlc_1_1ThreadlocalAllocator.html#adc4594319463c55342eccaf3e49b0109">More...</a><br /></td></tr> |
| <tr class="separator:adc4594319463c55342eccaf3e49b0109"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae0d77e0a063397c0f769f04947e662bd"><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadlocalAllocator.html#ae0d77e0a063397c0f769f04947e662bd">allocate</a> (size_t n)</td></tr> |
| <tr class="memdesc:ae0d77e0a063397c0f769f04947e662bd"><td class="mdescLeft"> </td><td class="mdescRight">allocate memory <a href="classdmlc_1_1ThreadlocalAllocator.html#ae0d77e0a063397c0f769f04947e662bd">More...</a><br /></td></tr> |
| <tr class="separator:ae0d77e0a063397c0f769f04947e662bd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa13d2a783f533d59a3d00c84c547a647"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadlocalAllocator.html#aa13d2a783f533d59a3d00c84c547a647">deallocate</a> (T *p, size_t n)</td></tr> |
| <tr class="memdesc:aa13d2a783f533d59a3d00c84c547a647"><td class="mdescLeft"> </td><td class="mdescRight">deallocate memory <a href="classdmlc_1_1ThreadlocalAllocator.html#aa13d2a783f533d59a3d00c84c547a647">More...</a><br /></td></tr> |
| <tr class="separator:aa13d2a783f533d59a3d00c84c547a647"><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:a8532d289334d9ba00bb12aa3177ccef2"><td class="memItemLeft" align="right" valign="top">const typedef T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadlocalAllocator.html#a8532d289334d9ba00bb12aa3177ccef2">const_ptr</a></td></tr> |
| <tr class="memdesc:a8532d289334d9ba00bb12aa3177ccef2"><td class="mdescLeft"> </td><td class="mdescRight">const pointer type <a href="classdmlc_1_1ThreadlocalAllocator.html#a8532d289334d9ba00bb12aa3177ccef2">More...</a><br /></td></tr> |
| <tr class="separator:a8532d289334d9ba00bb12aa3177ccef2"><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 dmlc::ThreadlocalAllocator< T ></h3> |
| |
| <p>A thread local allocator that get memory from a threadlocal memory pool. This is suitable to allocate objects that do not cross thread. </p> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>the type of the data to be allocated. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div><h2 class="groupheader">Member Typedef Documentation</h2> |
| <a id="aa9509829a2b96a97eca105cfc918f8ee"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa9509829a2b96a97eca105cfc918f8ee">◆ </a></span>pointer</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef T* <a class="el" href="classdmlc_1_1ThreadlocalAllocator.html">dmlc::ThreadlocalAllocator</a>< T >::<a class="el" href="classdmlc_1_1ThreadlocalAllocator.html#aa9509829a2b96a97eca105cfc918f8ee">pointer</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>pointer type </p> |
| |
| </div> |
| </div> |
| <a id="a15e68f08f76d0dca8fd10bd09ace570c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a15e68f08f76d0dca8fd10bd09ace570c">◆ </a></span>value_type</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef T <a class="el" href="classdmlc_1_1ThreadlocalAllocator.html">dmlc::ThreadlocalAllocator</a>< T >::<a class="el" href="classdmlc_1_1ThreadlocalAllocator.html#a15e68f08f76d0dca8fd10bd09ace570c">value_type</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>value type </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a647ff459997d57e201cf295a8afea966"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a647ff459997d57e201cf295a8afea966">◆ </a></span>ThreadlocalAllocator() <span class="overload">[1/2]</span></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="classdmlc_1_1ThreadlocalAllocator.html">dmlc::ThreadlocalAllocator</a>< T >::<a class="el" href="classdmlc_1_1ThreadlocalAllocator.html">ThreadlocalAllocator</a> </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> |
| <a id="adc4594319463c55342eccaf3e49b0109"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adc4594319463c55342eccaf3e49b0109">◆ </a></span>ThreadlocalAllocator() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <div class="memtemplate"> |
| template<typename U > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdmlc_1_1ThreadlocalAllocator.html">dmlc::ThreadlocalAllocator</a>< T >::<a class="el" href="classdmlc_1_1ThreadlocalAllocator.html">ThreadlocalAllocator</a> </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classdmlc_1_1ThreadlocalAllocator.html">ThreadlocalAllocator</a>< U > & </td> |
| <td class="paramname"><em>other</em></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>constructor from another allocator </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">other</td><td>another allocator </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">U</td><td>another type </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ae0d77e0a063397c0f769f04947e662bd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae0d77e0a063397c0f769f04947e662bd">◆ </a></span>allocate()</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">T* <a class="el" href="classdmlc_1_1ThreadlocalAllocator.html">dmlc::ThreadlocalAllocator</a>< T >::allocate </td> |
| <td>(</td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>n</em></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>allocate memory </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">n</td><td>number of blocks </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an uninitialized memory of type T. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa13d2a783f533d59a3d00c84c547a647"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa13d2a783f533d59a3d00c84c547a647">◆ </a></span>deallocate()</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">void <a class="el" href="classdmlc_1_1ThreadlocalAllocator.html">dmlc::ThreadlocalAllocator</a>< T >::deallocate </td> |
| <td>(</td> |
| <td class="paramtype">T * </td> |
| <td class="paramname"><em>p</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>n</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"> |
| |
| <p>deallocate memory </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">p</td><td>a memory to be returned. </td></tr> |
| <tr><td class="paramname">n</td><td>number of blocks </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a8532d289334d9ba00bb12aa3177ccef2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8532d289334d9ba00bb12aa3177ccef2">◆ </a></span>const_ptr</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const typedef T* <a class="el" href="classdmlc_1_1ThreadlocalAllocator.html">dmlc::ThreadlocalAllocator</a>< T >::const_ptr</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>const pointer type </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/3rdparty/dmlc-core/include/dmlc/<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2memory_8h_source.html">memory.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 03:47:40 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> |
