memory
/
classfoonathan_1_1memory_1_1temporary...

<!-- 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: temporary_allocator Class 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_1temporary__allocator.html">temporary_allocator</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">temporary_allocator Class 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"><p>A stateful <a href="md_doc_concepts.html#concept_rawallocator">RawAllocator</a> that handles temporary allocations. </p>
<p>It works similar to <code>alloca()</code> but uses a seperate <a class="el" href="classfoonathan_1_1memory_1_1memory__stack.html">memory_stack</a> for the allocations, instead of the actual program stack. This avoids the stack overflow error and is portable, with a similar speed. All allocations done in the scope of the allocator object are automatically freed when the object is destroyed. </p>
</div><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:acbe81cd2d27985e6fa3a064c155549b3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1temporary__allocator.html#acbe81cd2d27985e6fa3a064c155549b3">temporary_allocator</a> ()</td></tr>
<tr class="separator:acbe81cd2d27985e6fa3a064c155549b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6dffea1a2218103754b5ac73b0f5adcd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1temporary__allocator.html#a6dffea1a2218103754b5ac73b0f5adcd">temporary_allocator</a> (<a class="el" href="classfoonathan_1_1memory_1_1temporary__stack.html">temporary_stack</a> &amp;<a class="el" href="classfoonathan_1_1memory_1_1stack.html">stack</a>)</td></tr>
<tr class="separator:a6dffea1a2218103754b5ac73b0f5adcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d61f6d0569e5a19eac8913af3fdedca"><td class="memItemLeft" align="right" valign="top"><a id="a3d61f6d0569e5a19eac8913af3fdedca"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>temporary_allocator</b> (<a class="el" href="classfoonathan_1_1memory_1_1temporary__allocator.html">temporary_allocator</a> &amp;&amp;)=delete</td></tr>
<tr class="separator:a3d61f6d0569e5a19eac8913af3fdedca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c2652200555526f69a8449ffa6ba629"><td class="memItemLeft" align="right" valign="top"><a id="a2c2652200555526f69a8449ffa6ba629"></a>
<a class="el" href="classfoonathan_1_1memory_1_1temporary__allocator.html">temporary_allocator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classfoonathan_1_1memory_1_1temporary__allocator.html">temporary_allocator</a> &amp;&amp;)=delete</td></tr>
<tr class="separator:a2c2652200555526f69a8449ffa6ba629"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25a97fd86cd1ca7b24d7853c737824bb"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1temporary__allocator.html#a25a97fd86cd1ca7b24d7853c737824bb">allocate</a> (std::size_t size, std::size_t alignment)</td></tr>
<tr class="separator:a25a97fd86cd1ca7b24d7853c737824bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a518756b2cf243cebed5b0d669be1f757"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1temporary__allocator.html#a518756b2cf243cebed5b0d669be1f757">is_active</a> () const noexcept</td></tr>
<tr class="separator:a518756b2cf243cebed5b0d669be1f757"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9e4af5032d71179d3abf04db463f791"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1temporary__allocator.html#ad9e4af5032d71179d3abf04db463f791">shrink_to_fit</a> () noexcept</td></tr>
<tr class="separator:ad9e4af5032d71179d3abf04db463f791"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac89b96a68328dbf18904c0886af08ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classfoonathan_1_1memory_1_1temporary__stack.html">temporary_stack</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1temporary__allocator.html#aac89b96a68328dbf18904c0886af08ed">get_stack</a> () const noexcept</td></tr>
<tr class="separator:aac89b96a68328dbf18904c0886af08ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructors</h2>
<a id="acbe81cd2d27985e6fa3a064c155549b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbe81cd2d27985e6fa3a064c155549b3">&#9670;&nbsp;</a></span>temporary_allocator() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classfoonathan_1_1memory_1_1temporary__allocator.html">temporary_allocator</a> </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>Creates it by using the <a class="el" href="namespacefoonathan_1_1memory.html#a7f311d60d4857926d16396fc6a3be15a">get_temporary_stack()</a> to get the temporary stack. </dd></dl>
<dl class="section user"><dt>Requires:</dt><dd>There must be a per-thread temporary stack (<a class="el" href="group__allocator.html#ga49bf0d04a94c18512ef2890157412b71">FOONATHAN_MEMORY_TEMPORARY_STACK_MODE</a> must not be equal to <code>0</code>). </dd></dl>

</div>
</div>
<a id="a6dffea1a2218103754b5ac73b0f5adcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6dffea1a2218103754b5ac73b0f5adcd">&#9670;&nbsp;</a></span>temporary_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"><a class="el" href="classfoonathan_1_1memory_1_1temporary__allocator.html">temporary_allocator</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classfoonathan_1_1memory_1_1temporary__stack.html">temporary_stack</a> &amp;&#160;</td>
          <td class="paramname"><em>stack</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Creates it by giving it the <a class="el" href="classfoonathan_1_1memory_1_1temporary__stack.html">temporary_stack</a> it uses for allocation. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* allocate </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>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Allocates memory from the internal <a class="el" href="classfoonathan_1_1memory_1_1memory__stack.html">memory_stack</a> by forwarding to it. </dd></dl>
<dl class="section user"><dt>Returns:</dt><dd>The result of <a class="el" href="classfoonathan_1_1memory_1_1memory__stack.html#a25a97fd86cd1ca7b24d7853c737824bb">memory_stack::allocate()</a>. </dd></dl>
<dl class="section user"><dt>Requires:</dt><dd><code>is_active()</code> must return <code>true</code>. </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool is_active </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>Whether or not the allocator object is active. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The active allocator object is the last object created for one stack. Moving changes the active allocator. </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void shrink_to_fit </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>Effects:</dt><dd>Instructs it to release unnecessary memory after automatic unwinding occurs. This will effectively forward to <a class="el" href="classfoonathan_1_1memory_1_1memory__stack.html#ad9e4af5032d71179d3abf04db463f791">memory_stack::shrink_to_fit()</a> of the internal stack. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Like the use of the <a class="el" href="classfoonathan_1_1memory_1_1temporary__stack__initializer.html">temporary_stack_initializer</a> this can be used as an optimization, to tell when the thread's <a class="el" href="classfoonathan_1_1memory_1_1temporary__stack.html">temporary_stack</a> isn't needed anymore and can be destroyed. </dd>
<dd>
It doesn't call shrink to fit immediately, only in the destructor! </dd></dl>

</div>
</div>
<a id="aac89b96a68328dbf18904c0886af08ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac89b96a68328dbf18904c0886af08ed">&#9670;&nbsp;</a></span>get_stack()</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_1temporary__stack.html">temporary_stack</a>&amp; get_stack </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 internal stack the temporary allocator is using. </dd></dl>
<dl class="section user"><dt>Requires:</dt><dd><code>is_active()</code> must return <code>true</code>. </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>