1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Class template new_allocator</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../boost_container_header_reference.html#header.boost.container.new_allocator_hpp" title="Header <boost/container/new_allocator.hpp>"> 10<link rel="prev" href="pmr/multimap_of.html" title="Struct template multimap_of"> 11<link rel="next" href="new_allocator/rebind.html" title="Struct template rebind"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="pmr/multimap_of.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.new_allocator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="new_allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.container.new_allocator"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template new_allocator</span></h2> 30<p>boost::container::new_allocator — This class is a reduced STL-compatible allocator that allocates memory using operator new. </p> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../boost_container_header_reference.html#header.boost.container.new_allocator_hpp" title="Header <boost/container/new_allocator.hpp>">boost/container/new_allocator.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> 36<span class="keyword">class</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">{</span> 37<span class="keyword">public</span><span class="special">:</span> 38 <span class="comment">// types</span> 39 <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.container.new_allocator.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> 40 <span class="keyword">typedef</span> <span class="identifier">T</span> <span class="special">*</span> <a name="boost.container.new_allocator.pointer"></a><span class="identifier">pointer</span><span class="special">;</span> 41 <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> <a name="boost.container.new_allocator.const_pointer"></a><span class="identifier">const_pointer</span><span class="special">;</span> 42 <span class="keyword">typedef</span> <span class="identifier">T</span> <span class="special">&</span> <a name="boost.container.new_allocator.reference"></a><span class="identifier">reference</span><span class="special">;</span> 43 <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <a name="boost.container.new_allocator.const_reference"></a><span class="identifier">const_reference</span><span class="special">;</span> 44 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="boost.container.new_allocator.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> 45 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ptrdiff_t</span> <a name="boost.container.new_allocator.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span> 46 <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <a name="boost.container.new_allocator.propagat_idm45641213040880"></a><span class="identifier">propagate_on_container_move_assignment</span><span class="special">;</span> <span class="comment">// A integral constant of type bool with value true. </span> 47 <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <a name="boost.container.new_allocator.is_always_equal"></a><span class="identifier">is_always_equal</span><span class="special">;</span> <span class="comment">// A integral constant of type bool with value true. </span> 48 49 <span class="comment">// member classes/structs/unions</span> 50 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> 51 <span class="keyword">struct</span> <a class="link" href="new_allocator/rebind.html" title="Struct template rebind">rebind</a> <span class="special">{</span> 52 <span class="comment">// types</span> 53 <span class="keyword">typedef</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a><span class="special"><</span> <span class="identifier">T2</span> <span class="special">></span> <a class="link" href="new_allocator/rebind.html#boost.container.new_allocator.rebind.other"><span class="identifier">other</span></a><span class="special">;</span> 54 <span class="special">}</span><span class="special">;</span> 55 56 <span class="comment">// <a class="link" href="new_allocator.html#boost.container.new_allocatorconstruct-copy-destruct">construct/copy/destruct</a></span> 57 <a class="link" href="new_allocator.html#idm45641213031232-bb"><span class="identifier">new_allocator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 58 <a class="link" href="new_allocator.html#idm45641213030240-bb"><span class="identifier">new_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 59 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> <a class="link" href="new_allocator.html#idm45641213023952-bb"><span class="identifier">new_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a><span class="special"><</span> <span class="identifier">T2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 60 <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span> <a class="link" href="new_allocator.html#idm45641213027392-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 61 62 <span class="comment">// <a class="link" href="new_allocator.html#idm45641213038528-bb">public member functions</a></span> 63 <span class="identifier">pointer</span> <a class="link" href="new_allocator.html#idm45641213037968-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> 64 <span class="keyword">void</span> <a class="link" href="new_allocator.html#idm45641213035936-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="identifier">pointer</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 65 <span class="identifier">size_type</span> <a class="link" href="new_allocator.html#idm45641213032992-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 66 67 <span class="comment">// <a class="link" href="new_allocator.html#idm45641213020240-bb">friend functions</a></span> 68 <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="new_allocator.html#idm45641213019680-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">,</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 69 <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="new_allocator.html#idm45641213015424-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 70 <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="new_allocator.html#idm45641213010800-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 71<span class="special">}</span><span class="special">;</span></pre></div> 72<div class="refsect1"> 73<a name="id-1.3.10.14.16.3.4"></a><h2>Description</h2> 74<div class="refsect2"> 75<a name="id-1.3.10.14.16.3.4.2"></a><h3> 76<a name="boost.container.new_allocatorconstruct-copy-destruct"></a><code class="computeroutput">new_allocator</code> 77 public 78 construct/copy/destruct</h3> 79<div class="orderedlist"><ol class="orderedlist" type="1"> 80<li class="listitem"> 81<pre class="literallayout"><a name="idm45641213031232-bb"></a><span class="identifier">new_allocator</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 82<p>Default constructor Never throws </p> 83</li> 84<li class="listitem"> 85<pre class="literallayout"><a name="idm45641213030240-bb"></a><span class="identifier">new_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 86<p>Constructor from other <code class="computeroutput"><a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a></code>. Never throws </p> 87</li> 88<li class="listitem"> 89<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> <a name="idm45641213023952-bb"></a><span class="identifier">new_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a><span class="special"><</span> <span class="identifier">T2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 90<p>Constructor from related <code class="computeroutput"><a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a></code>. Never throws </p> 91</li> 92<li class="listitem"> 93<pre class="literallayout"><a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span> <a name="idm45641213027392-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 94<p>Copy assignment operator from other <code class="computeroutput"><a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a></code>. Never throws </p> 95</li> 96</ol></div> 97</div> 98<div class="refsect2"> 99<a name="id-1.3.10.14.16.3.4.3"></a><h3> 100<a name="idm45641213038528-bb"></a><code class="computeroutput">new_allocator</code> public member functions</h3> 101<div class="orderedlist"><ol class="orderedlist" type="1"> 102<li class="listitem"> 103<pre class="literallayout"><span class="identifier">pointer</span> <a name="idm45641213037968-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">)</span><span class="special">;</span></pre> 104<p>Allocates memory for an array of count elements. Throws std::bad_alloc if there is no enough memory </p> 105</li> 106<li class="listitem"> 107<pre class="literallayout"><span class="keyword">void</span> <a name="idm45641213035936-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="identifier">pointer</span> ptr<span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 108<p>Deallocates previously allocated memory. Never throws </p> 109</li> 110<li class="listitem"> 111<pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45641213032992-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 112<p>Returns the maximum number of elements that could be allocated. Never throws </p> 113</li> 114</ol></div> 115</div> 116<div class="refsect2"> 117<a name="id-1.3.10.14.16.3.4.4"></a><h3> 118<a name="idm45641213020240-bb"></a><code class="computeroutput">new_allocator</code> friend functions</h3> 119<div class="orderedlist"><ol class="orderedlist" type="1"> 120<li class="listitem"> 121<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="idm45641213019680-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">,</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 122<p>Swaps two allocators, does nothing because this <code class="computeroutput"><a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a></code> is stateless </p> 123</li> 124<li class="listitem"> 125<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idm45641213015424-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 126<p>An <code class="computeroutput"><a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a></code> always compares to true, as memory allocated with one instance can be deallocated by another instance </p> 127</li> 128<li class="listitem"> 129<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idm45641213010800-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 130<p>An <code class="computeroutput"><a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a></code> always compares to false, as memory allocated with one instance can be deallocated by another instance </p> 131</li> 132</ol></div> 133</div> 134<div class="refsect2"> 135<a name="id-1.3.10.14.16.3.4.6"></a><h3>Specializations</h3> 136<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a class="link" href="new_allo_idm45641213006000.html" title="Class new_allocator<void>">Class new_allocator<void></a></p></li></ul></div> 137</div> 138</div> 139</div> 140<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 141<td align="left"></td> 142<td align="right"><div class="copyright-footer">Copyright © 2009-2018 Ion Gaztanaga<p> 143 Distributed under the Boost Software License, Version 1.0. (See accompanying 144 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 145 </p> 146</div></td> 147</tr></table> 148<hr> 149<div class="spirit-nav"> 150<a accesskey="p" href="pmr/multimap_of.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.new_allocator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="new_allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 151</div> 152</body> 153</html> 154
