memory
/
classfoonathan_1_1memory_1_1memory__r...

<!-- 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: memory_resource_adapter&lt; RawAllocator &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_1memory__resource__adapter.html">memory_resource_adapter</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">memory_resource_adapter&lt; RawAllocator &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span><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 RawAllocator&gt;<br />
class foonathan::memory::memory_resource_adapter&lt; RawAllocator &gt;</h3>

<p>Wraps a <a href="md_doc_concepts.html#concept_rawallocator">RawAllocator</a> and makes it a <a class="el" href="classfoonathan_1_1memory_1_1memory__resource.html">memory_resource</a>. </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:a822c89378d2400636a878d6e43ea066e"><td class="memItemLeft" align="right" valign="top"><a id="a822c89378d2400636a878d6e43ea066e"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>allocator_type</b> = typename <a class="el" href="classfoonathan_1_1memory_1_1allocator__traits.html">allocator_traits</a>&lt; RawAllocator &gt;::allocator_type</td></tr>
<tr class="separator:a822c89378d2400636a878d6e43ea066e"><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:a2820c93e0e8bf0a56039ae18e0672e64"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1memory__resource__adapter.html#a2820c93e0e8bf0a56039ae18e0672e64">memory_resource_adapter</a> (allocator_type &amp;&amp;other) noexcept</td></tr>
<tr class="separator:a2820c93e0e8bf0a56039ae18e0672e64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a004bd1b4081f1657140ca5c1a33a4d15"><td class="memItemLeft" align="right" valign="top"><a id="a004bd1b4081f1657140ca5c1a33a4d15"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><b>allocate</b> (std::size_t bytes, std::size_t alignment=max_alignment)</td></tr>
<tr class="separator:a004bd1b4081f1657140ca5c1a33a4d15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac68ff68363c1adf5282f535e1ef1835f"><td class="memItemLeft" align="right" valign="top"><a id="ac68ff68363c1adf5282f535e1ef1835f"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>deallocate</b> (void *p, std::size_t bytes, std::size_t alignment=max_alignment)</td></tr>
<tr class="separator:ac68ff68363c1adf5282f535e1ef1835f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc031d5aeed6d34498b4033e1c1855cc"><td class="memItemLeft" align="right" valign="top"><a id="abc031d5aeed6d34498b4033e1c1855cc"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_equal</b> (const <a class="el" href="classfoonathan_1_1memory_1_1memory__resource.html">memory_resource</a> &amp;other) const noexcept</td></tr>
<tr class="separator:abc031d5aeed6d34498b4033e1c1855cc"><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_1memory__resource__adapter.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_1memory__resource__adapter.html#a3071272ab0aa16b56563ba54251ee752">get_allocator</a> () const noexcept</td></tr>
<tr class="separator:a3071272ab0aa16b56563ba54251ee752"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructors</h2>
<a id="a2820c93e0e8bf0a56039ae18e0672e64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2820c93e0e8bf0a56039ae18e0672e64">&#9670;&nbsp;</a></span>memory_resource_adapter()</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_1memory__resource__adapter.html">memory_resource_adapter</a> </td>
          <td>(</td>
          <td class="paramtype">allocator_type &amp;&amp;&#160;</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">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Creates the resource by moving in the allocator. </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Functions</h2>
<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 reference to the wrapped 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 reference to the wrapped allocator. </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void* do_allocate </td>
          <td>(</td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>bytes</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">override</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Allocates raw memory with given size and alignment. It forwards to <code>allocate_node()</code> or <code>allocate_array()</code> depending on the size. </dd></dl>
<dl class="section user"><dt>Returns:</dt><dd>The new memory as returned by the <a href="md_doc_concepts.html#concept_rawallocator">RawAllocator</a>. </dd></dl>
<dl class="section user"><dt>Throws:</dt><dd>Anything thrown by the allocation function. </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void do_deallocate </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>p</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>bytes</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">override</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Deallocates memory previously allocated by <a class="el" href="classfoonathan_1_1memory_1_1memory__resource__adapter.html#aa92e731344f1e7ab68faa84d27e9e158">do_allocate</a>. It forwards to <code>deallocate_node()</code> or <code>deallocate_array()</code> depending on the size. </dd></dl>
<dl class="section user"><dt>Throws:</dt><dd>Nothing. </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool do_is_equal </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classfoonathan_1_1memory_1_1memory__resource.html">memory_resource</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Returns:</dt><dd>Whether or not <code>*this</code> is equal to <code>other</code> by comparing the addresses. </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>