memory
/
classfoonathan_1_1memory_1_1composabl...

<!-- HTML header for doxygen 1.8.16-->
<!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.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>memory: composable_allocator_traits&lt; memory_pool&lt; PoolType, BlockOrRawAllocator &gt; &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="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">memory
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<div id="main-nav">
    <ul class="sm sm-dox" id="main-menu">
        <li><a href="index.html">Main Page</a></li>
        <li><a href="md_doc_tutorial.html">Tutorial</a></li>
        <li><a href="namespacefoonathan_1_1memory.html">Index</a></li>
        <li><a href="files.html">Files</a></li>
    </ul>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacefoonathan.html">foonathan</a></li><li class="navelem"><a class="el" href="namespacefoonathan_1_1memory.html">memory</a></li><li class="navelem"><a class="el" href="classfoonathan_1_1memory_1_1composable__allocator__traits_3_01memory__pool_3_01_pool_type_00_01_56d9b96e5c95a80e8643d831a5b55e1c.html">composable_allocator_traits&lt; memory_pool&lt; PoolType, BlockOrRawAllocator &gt; &gt;</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Typedefs</a> &#124;
<a href="#pub-static-methods">Static Functions</a>  </div>
  <div class="headertitle">
<div class="title">composable_allocator_traits&lt; memory_pool&lt; PoolType, BlockOrRawAllocator &gt; &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__allocator.html">Allocator implementations</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename PoolType, class BlockOrRawAllocator&gt;<br />
class foonathan::memory::composable_allocator_traits&lt; memory_pool&lt; PoolType, BlockOrRawAllocator &gt; &gt;</h3>

<p>Specialization of the <a class="el" href="classfoonathan_1_1memory_1_1composable__allocator__traits.html">composable_allocator_traits</a> for <a class="el" href="classfoonathan_1_1memory_1_1memory__pool.html">memory_pool</a> classes. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a007729290ed3dff7da413b35950a3c14"><td class="memItemLeft" align="right" valign="top"><a id="a007729290ed3dff7da413b35950a3c14"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>allocator_type</b> = <a class="el" href="classfoonathan_1_1memory_1_1memory__pool.html">memory_pool</a>&lt; PoolType, BlockOrRawAllocator &gt;</td></tr>
<tr class="separator:a007729290ed3dff7da413b35950a3c14"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Functions</h2></td></tr>
<tr class="memitem:afb19d897c2277942cc40f2719e8c40c6"><td class="memItemLeft" align="right" valign="top">static void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1composable__allocator__traits_3_01memory__pool_3_01_pool_type_00_01_56d9b96e5c95a80e8643d831a5b55e1c.html#afb19d897c2277942cc40f2719e8c40c6">try_allocate_node</a> (<a class="el" href="classfoonathan_1_1memory_1_1memory__pool.html">allocator_type</a> &amp;state, std::size_t size, std::size_t alignment) noexcept</td></tr>
<tr class="separator:afb19d897c2277942cc40f2719e8c40c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adaa854dcc976d7c174ede3d2049d7717"><td class="memItemLeft" align="right" valign="top">static void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1composable__allocator__traits_3_01memory__pool_3_01_pool_type_00_01_56d9b96e5c95a80e8643d831a5b55e1c.html#adaa854dcc976d7c174ede3d2049d7717">try_allocate_array</a> (<a class="el" href="classfoonathan_1_1memory_1_1memory__pool.html">allocator_type</a> &amp;state, std::size_t count, std::size_t size, std::size_t alignment) noexcept</td></tr>
<tr class="separator:adaa854dcc976d7c174ede3d2049d7717"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a767ceac9cb6d4d9d0c26efc7a9aa1c42"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1composable__allocator__traits_3_01memory__pool_3_01_pool_type_00_01_56d9b96e5c95a80e8643d831a5b55e1c.html#a767ceac9cb6d4d9d0c26efc7a9aa1c42">try_deallocate_node</a> (<a class="el" href="classfoonathan_1_1memory_1_1memory__pool.html">allocator_type</a> &amp;state, void *node, std::size_t size, std::size_t alignment) noexcept</td></tr>
<tr class="separator:a767ceac9cb6d4d9d0c26efc7a9aa1c42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e83f014fc6cfa59a5643791de8fa306"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1composable__allocator__traits_3_01memory__pool_3_01_pool_type_00_01_56d9b96e5c95a80e8643d831a5b55e1c.html#a7e83f014fc6cfa59a5643791de8fa306">try_deallocate_array</a> (<a class="el" href="classfoonathan_1_1memory_1_1memory__pool.html">allocator_type</a> &amp;state, void *array, std::size_t count, std::size_t size, std::size_t alignment) noexcept</td></tr>
<tr class="separator:a7e83f014fc6cfa59a5643791de8fa306"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Functions</h2>
<a id="afb19d897c2277942cc40f2719e8c40c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb19d897c2277942cc40f2719e8c40c6">&#9670;&nbsp;</a></span>try_allocate_node()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void* try_allocate_node </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classfoonathan_1_1memory_1_1memory__pool.html">allocator_type</a> &amp;&#160;</td>
          <td class="paramname"><em>state</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>alignment</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Returns:</dt><dd>The result of <a class="el" href="classfoonathan_1_1memory_1_1memory__pool.html#a508dd5fbab863e311e289112cdff924b">memory_pool::try_allocate_node()</a> or <code>nullptr</code> if the allocation size was too big. </dd></dl>

</div>
</div>
<a id="adaa854dcc976d7c174ede3d2049d7717"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adaa854dcc976d7c174ede3d2049d7717">&#9670;&nbsp;</a></span>try_allocate_array()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void* try_allocate_array </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classfoonathan_1_1memory_1_1memory__pool.html">allocator_type</a> &amp;&#160;</td>
          <td class="paramname"><em>state</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>count</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>alignment</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Forwards to <a class="el" href="classfoonathan_1_1memory_1_1memory__pool.html#ad61bb3867173270d1341f18194af8300">memory_pool::try_allocate_array()</a> with the number of nodes adjusted to be the minimum, if the <code>size</code> is less than the <a class="el" href="classfoonathan_1_1memory_1_1memory__pool.html#a5d4e471c06eda1a92506955593a4fd7b">memory_pool::node_size()</a>. </dd></dl>
<dl class="section user"><dt>Returns:</dt><dd>A <a href="md_doc_concepts.html#concept_array">array</a> with specified properties or <code>nullptr</code> if it was unable to allocate. </dd></dl>

</div>
</div>
<a id="a767ceac9cb6d4d9d0c26efc7a9aa1c42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a767ceac9cb6d4d9d0c26efc7a9aa1c42">&#9670;&nbsp;</a></span>try_deallocate_node()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool try_deallocate_node </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classfoonathan_1_1memory_1_1memory__pool.html">allocator_type</a> &amp;&#160;</td>
          <td class="paramname"><em>state</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>node</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>alignment</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Just forwards to <a class="el" href="classfoonathan_1_1memory_1_1memory__pool.html#a72c9901827edcc731c4e69271ec03de9">memory_pool::try_deallocate_node()</a>. </dd></dl>
<dl class="section user"><dt>Returns:</dt><dd>Whether the deallocation was successful. </dd></dl>

</div>
</div>
<a id="a7e83f014fc6cfa59a5643791de8fa306"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e83f014fc6cfa59a5643791de8fa306">&#9670;&nbsp;</a></span>try_deallocate_array()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool try_deallocate_array </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classfoonathan_1_1memory_1_1memory__pool.html">allocator_type</a> &amp;&#160;</td>
          <td class="paramname"><em>state</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>array</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>count</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>alignment</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Forwards to <a class="el" href="classfoonathan_1_1memory_1_1memory__pool.html#a23ee5abed4a79390885e45c7dcb1a663">memory_pool::deallocate_array()</a> with the same size adjustment. </dd></dl>
<dl class="section user"><dt>Returns:</dt><dd>Whether the deallocation was successful. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.16-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>