memory
/
classfoonathan_1_1memory_1_1tracked__...

<!-- 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: tracked_block_allocator&lt; Tracker, BlockOrRawAllocator &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_1tracked__block__allocator.html">tracked_block_allocator</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Typedefs</a> &#124;
<a href="#pub-methods">Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">tracked_block_allocator&lt; Tracker, BlockOrRawAllocator &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__adapter.html">Adapters and Wrappers</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;class Tracker, class BlockOrRawAllocator&gt;<br />
class foonathan::memory::tracked_block_allocator&lt; Tracker, BlockOrRawAllocator &gt;</h3>

<p>A <a href="md_doc_concepts.html#concept_blockallocator">BlockAllocator</a> adapter that tracks another allocator using a <a href="md_doc_concepts.html#concept_tracker">tracker</a>. </p>
<p>It wraps another <a href="md_doc_concepts.html#concept_blockallocator">BlockAllocator</a> and calls the tracker function before forwarding to it. The class can then be used anywhere a <a href="md_doc_concepts.html#concept_blockallocator">BlockAllocator</a> is required and the memory usage will be tracked.<br  />
 It will only call the <code>on_allocator_growth()</code> and <code>on_allocator_shrinking()</code> tracking functions, since a <a href="md_doc_concepts.html#concept_blockallocator">BlockAllocator</a> is normally used inside higher allocators only. </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:a7fd26a8539389ffa2a4b1d1a7b6b839c"><td class="memItemLeft" align="right" valign="top"><a id="a7fd26a8539389ffa2a4b1d1a7b6b839c"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>allocator_type</b> = <a class="el" href="group__core.html#gaf1ce941b1306a592d4ebba1167fd98aa">make_block_allocator_t</a>&lt; BlockOrRawAllocator &gt;</td></tr>
<tr class="separator:a7fd26a8539389ffa2a4b1d1a7b6b839c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8a347f1c1210da5e03c5c5f13a0c18c"><td class="memItemLeft" align="right" valign="top"><a id="ab8a347f1c1210da5e03c5c5f13a0c18c"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>tracker</b> = Tracker</td></tr>
<tr class="separator:ab8a347f1c1210da5e03c5c5f13a0c18c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Member Functions</h2></td></tr>
<tr class="memitem:a3e2a7a8350889a0bfb7fc9f20060dba7"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:a3e2a7a8350889a0bfb7fc9f20060dba7"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1tracked__block__allocator.html#a3e2a7a8350889a0bfb7fc9f20060dba7">tracked_block_allocator</a> (std::size_t block_size, tracker t, Args &amp;&amp;... args)</td></tr>
<tr class="separator:a3e2a7a8350889a0bfb7fc9f20060dba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36f99ac62de57d19c29608794fcf79ab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfoonathan_1_1memory_1_1memory__block.html">memory_block</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1tracked__block__allocator.html#a36f99ac62de57d19c29608794fcf79ab">allocate_block</a> ()</td></tr>
<tr class="separator:a36f99ac62de57d19c29608794fcf79ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5b19333f805f82c358df1f9bf416050"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1tracked__block__allocator.html#ab5b19333f805f82c358df1f9bf416050">deallocate_block</a> (<a class="el" href="structfoonathan_1_1memory_1_1memory__block.html">memory_block</a> block) noexcept</td></tr>
<tr class="separator:ab5b19333f805f82c358df1f9bf416050"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2c71dfd2e8d552b753c7d16186b83da"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1tracked__block__allocator.html#ad2c71dfd2e8d552b753c7d16186b83da">next_block_size</a> () const noexcept</td></tr>
<tr class="separator:ad2c71dfd2e8d552b753c7d16186b83da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr class="memitem:a9dd1208db958184eee224c1b37817ad1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1tracked__block__allocator.html#a9dd1208db958184eee224c1b37817ad1">tracked_block_allocator</a> (tracker t={}) noexcept</td></tr>
<tr class="separator:a9dd1208db958184eee224c1b37817ad1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5dcaab523429f5f1118f7dd2414a21a0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1tracked__block__allocator.html#a5dcaab523429f5f1118f7dd2414a21a0">tracked_block_allocator</a> (tracker t, allocator_type &amp;&amp;alloc) noexcept</td></tr>
<tr class="separator:a5dcaab523429f5f1118f7dd2414a21a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr class="memitem:a3ae445687ecb4a037b542ede5c6f48ac"><td class="memItemLeft" align="right" valign="top">allocator_type &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1tracked__block__allocator.html#a3ae445687ecb4a037b542ede5c6f48ac">get_allocator</a> () noexcept</td></tr>
<tr class="separator:a3ae445687ecb4a037b542ede5c6f48ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3071272ab0aa16b56563ba54251ee752"><td class="memItemLeft" align="right" valign="top">const allocator_type &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1tracked__block__allocator.html#a3071272ab0aa16b56563ba54251ee752">get_allocator</a> () const noexcept</td></tr>
<tr class="separator:a3071272ab0aa16b56563ba54251ee752"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr class="memitem:a588a975a505877493882737ea9619032"><td class="memItemLeft" align="right" valign="top">tracker &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1tracked__block__allocator.html#a588a975a505877493882737ea9619032">get_tracker</a> () noexcept</td></tr>
<tr class="separator:a588a975a505877493882737ea9619032"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93b0438c66c335b11935575a41fda848"><td class="memItemLeft" align="right" valign="top">const tracker &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1tracked__block__allocator.html#a93b0438c66c335b11935575a41fda848">get_tracker</a> () const noexcept</td></tr>
<tr class="separator:a93b0438c66c335b11935575a41fda848"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructors</h2>
<a id="a9dd1208db958184eee224c1b37817ad1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9dd1208db958184eee224c1b37817ad1">&#9670;&nbsp;</a></span>tracked_block_allocator() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classfoonathan_1_1memory_1_1tracked__block__allocator.html">tracked_block_allocator</a> </td>
          <td>(</td>
          <td class="paramtype">tracker&#160;</td>
          <td class="paramname"><em>t</em> = <code>{}</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Creates it by giving it a <a href="md_doc_concepts.html#concept_tracker">tracker</a> and the tracked <a href="md_doc_concepts.html#concept_rawallocator">RawAllocator</a>. It will embed both objects. </dd></dl>

</div>
</div>
<a id="a5dcaab523429f5f1118f7dd2414a21a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5dcaab523429f5f1118f7dd2414a21a0">&#9670;&nbsp;</a></span>tracked_block_allocator() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classfoonathan_1_1memory_1_1tracked__block__allocator.html">tracked_block_allocator</a> </td>
          <td>(</td>
          <td class="paramtype">tracker&#160;</td>
          <td class="paramname"><em>t</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">allocator_type &amp;&amp;&#160;</td>
          <td class="paramname"><em>alloc</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">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Creates it by giving it a <a href="md_doc_concepts.html#concept_tracker">tracker</a> and the tracked <a href="md_doc_concepts.html#concept_rawallocator">RawAllocator</a>. It will embed both objects. </dd></dl>

</div>
</div>
<a id="a3e2a7a8350889a0bfb7fc9f20060dba7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e2a7a8350889a0bfb7fc9f20060dba7">&#9670;&nbsp;</a></span>tracked_block_allocator() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classfoonathan_1_1memory_1_1tracked__block__allocator.html">tracked_block_allocator</a> </td>
          <td>(</td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>block_size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">tracker&#160;</td>
          <td class="paramname"><em>t</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Args &amp;&amp;...&#160;</td>
          <td class="paramname"><em>args</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Creates it in the form required by the concept. The allocator will be constructed using <code>block_size</code> and <code>args</code>. </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Functions</h2>
<a id="a36f99ac62de57d19c29608794fcf79ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36f99ac62de57d19c29608794fcf79ab">&#9670;&nbsp;</a></span>allocate_block()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structfoonathan_1_1memory_1_1memory__block.html">memory_block</a> allocate_block </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Calls <code>Tracker::on_allocator_growth()</code> after forwarding to the allocator. </dd></dl>
<dl class="section user"><dt>Returns:</dt><dd>The block as the returned by the allocator. </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void deallocate_block </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structfoonathan_1_1memory_1_1memory__block.html">memory_block</a>&#160;</td>
          <td class="paramname"><em>block</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Calls <code>Tracker::on_allocator_shrinking()</code> and forwards to the allocator. </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::size_t next_block_size </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Returns:</dt><dd>The next block size as returned by the allocator. </dd></dl>

</div>
</div>
<a id="a3ae445687ecb4a037b542ede5c6f48ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ae445687ecb4a037b542ede5c6f48ac">&#9670;&nbsp;</a></span>get_allocator() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">allocator_type&amp; get_allocator </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Returns:</dt><dd>A (const) reference to the used allocator. </dd></dl>

</div>
</div>
<a id="a3071272ab0aa16b56563ba54251ee752"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3071272ab0aa16b56563ba54251ee752">&#9670;&nbsp;</a></span>get_allocator() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const allocator_type&amp; get_allocator </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Returns:</dt><dd>A (const) reference to the used allocator. </dd></dl>

</div>
</div>
<a id="a588a975a505877493882737ea9619032"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a588a975a505877493882737ea9619032">&#9670;&nbsp;</a></span>get_tracker() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">tracker&amp; get_tracker </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Returns:</dt><dd>A (const) reference to the tracker. </dd></dl>

</div>
</div>
<a id="a93b0438c66c335b11935575a41fda848"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93b0438c66c335b11935575a41fda848">&#9670;&nbsp;</a></span>get_tracker() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const tracker&amp; get_tracker </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Returns:</dt><dd>A (const) reference to the tracker. </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>