blob: 0fb28d331b95a461cc17324917531b89953cbf7d [file] [log] [blame]
<!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: dmlc::MemoryPool&lt; size, align &gt; 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.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="namespacedmlc.html">dmlc</a></li><li class="navelem"><a class="el" href="classdmlc_1_1MemoryPool.html">MemoryPool</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classdmlc_1_1MemoryPool-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dmlc::MemoryPool&lt; size, align &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A memory pool that allocate memory of fixed size and alignment.
<a href="classdmlc_1_1MemoryPool.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2memory_8h_source.html">memory.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for dmlc::MemoryPool&lt; size, align &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classdmlc_1_1MemoryPool__coll__graph.png" border="0" usemap="#dmlc_1_1MemoryPool_3_01size_00_01align_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="dmlc_1_1MemoryPool_3_01size_00_01align_01_4_coll__map" id="dmlc_1_1MemoryPool_3_01size_00_01align_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:a740c11194c904ee61a3f78e70dda3ae8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1MemoryPool.html#a740c11194c904ee61a3f78e70dda3ae8">MemoryPool</a> ()</td></tr>
<tr class="memdesc:a740c11194c904ee61a3f78e70dda3ae8"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor <a href="#a740c11194c904ee61a3f78e70dda3ae8">More...</a><br /></td></tr>
<tr class="separator:a740c11194c904ee61a3f78e70dda3ae8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a891d237cfb487524ee4934d9c9c91a48"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1MemoryPool.html#a891d237cfb487524ee4934d9c9c91a48">allocate</a> ()</td></tr>
<tr class="memdesc:a891d237cfb487524ee4934d9c9c91a48"><td class="mdescLeft">&#160;</td><td class="mdescRight">allocate a new memory of size <a href="#a891d237cfb487524ee4934d9c9c91a48">More...</a><br /></td></tr>
<tr class="separator:a891d237cfb487524ee4934d9c9c91a48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af79108ad8be488fa46dffec19a43cc92"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1MemoryPool.html#af79108ad8be488fa46dffec19a43cc92">deallocate</a> (void *p)</td></tr>
<tr class="memdesc:af79108ad8be488fa46dffec19a43cc92"><td class="mdescLeft">&#160;</td><td class="mdescRight">deallocate a piece of memory <a href="#af79108ad8be488fa46dffec19a43cc92">More...</a><br /></td></tr>
<tr class="separator:af79108ad8be488fa46dffec19a43cc92"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;size_t size, size_t align&gt;<br />
class dmlc::MemoryPool&lt; size, align &gt;</h3>
<p>A memory pool that allocate memory of fixed size and alignment. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">size</td><td>The size of each piece. </td></tr>
<tr><td class="paramname">align</td><td>The alignment requirement of the memory. </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a740c11194c904ee61a3f78e70dda3ae8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a740c11194c904ee61a3f78e70dda3ae8">&#9670;&nbsp;</a></span>MemoryPool()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t size, size_t align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdmlc_1_1MemoryPool.html">dmlc::MemoryPool</a>&lt; size, align &gt;::<a class="el" href="classdmlc_1_1MemoryPool.html">MemoryPool</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>constructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a891d237cfb487524ee4934d9c9c91a48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a891d237cfb487524ee4934d9c9c91a48">&#9670;&nbsp;</a></span>allocate()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t size, size_t align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="classdmlc_1_1MemoryPool.html">dmlc::MemoryPool</a>&lt; size, align &gt;::allocate </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>allocate a new memory of size </p>
</div>
</div>
<a id="af79108ad8be488fa46dffec19a43cc92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af79108ad8be488fa46dffec19a43cc92">&#9670;&nbsp;</a></span>deallocate()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t size, size_t align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classdmlc_1_1MemoryPool.html">dmlc::MemoryPool</a>&lt; size, align &gt;::deallocate </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>p</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>deallocate a piece of memory </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>The pointer to the memory to be de-allocated. </td></tr>
</table>
</dd>
</dl>
</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 00:58:43 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>