Imported Upstream version 1.64.0
[platform/upstream/boost.git] / doc / html / boost / container / node_allocator.html
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=US-ASCII">
5 <title>Class template node_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.node_allocator_hpp" title="Header &lt;boost/container/node_allocator.hpp&gt;">
10 <link rel="prev" href="new_allocator/rebind.html" title="Struct template rebind">
11 <link rel="next" href="node_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="new_allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.node_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="node_allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25 </div>
26 <div class="refentry">
27 <a name="boost.container.node_allocator"></a><div class="titlepage"></div>
28 <div class="refnamediv">
29 <h2><span class="refentrytitle">Class template node_allocator</span></h2>
30 <p>boost::container::node_allocator</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: &lt;<a class="link" href="../../boost_container_header_reference.html#header.boost.container.node_allocator_hpp" title="Header &lt;boost/container/node_allocator.hpp&gt;">boost/container/node_allocator.hpp</a>&gt;
34
35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> NodesPerBlock <span class="special">=</span> <span class="identifier">NodeAlloc_nodes_per_block</span><span class="special">&gt;</span> 
36 <span class="keyword">class</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_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.node_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.node_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.node_allocator.const_pointer"></a><span class="identifier">const_pointer</span><span class="special">;</span>  
42   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>    <a name="boost.container.node_allocator.reference"></a><span class="identifier">reference</span><span class="special">;</span>      
43   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>    <a name="boost.container.node_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.node_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.node_allocator.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>
46   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>    <a name="boost.container.node_allocator.version"></a><span class="identifier">version</span><span class="special">;</span>        
47
48   <span class="comment">// member classes/structs/unions</span>
49   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T2<span class="special">&gt;</span> 
50   <span class="keyword">struct</span> <a class="link" href="node_allocator/rebind.html" title="Struct template rebind">rebind</a> <span class="special">{</span>
51     <span class="comment">// types</span>
52     <span class="keyword">typedef</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special">&lt;</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span> <span class="special">&gt;</span> <a class="link" href="node_allocator/rebind.html#boost.container.node_allocator.rebind.other"><span class="identifier">other</span></a><span class="special">;</span>
53   <span class="special">}</span><span class="special">;</span>
54
55   <span class="comment">// <a class="link" href="node_allocator.html#boost.container.node_allocatorconstruct-copy-destruct">construct/copy/destruct</a></span>
56   <a class="link" href="node_allocator.html#idp50562832-bb"><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
57   <a class="link" href="node_allocator.html#idp50563680-bb"><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
58   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T2<span class="special">&gt;</span> 
59     <a class="link" href="node_allocator.html#idp50566416-bb"><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special">&lt;</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
60   <a class="link" href="node_allocator.html#idp50570000-bb"><span class="special">~</span><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
61
62   <span class="comment">// <a class="link" href="node_allocator.html#idp50531664-bb">public member functions</a></span>
63   <span class="identifier">size_type</span> <a class="link" href="node_allocator.html#idp50532224-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
64   <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#idp50533808-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
65   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp50536816-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
66   <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#idp50539760-bb"><span class="identifier">allocation_command</span></a><span class="special">(</span><span class="identifier">allocation_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">&amp;</span><span class="special">,</span> 
67                              <span class="identifier">pointer</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
68   <span class="identifier">size_type</span> <a class="link" href="node_allocator.html#idp50543376-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="identifier">pointer</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
69   <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#idp50545680-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
70   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp50547088-bb"><span class="identifier">allocate_individual</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
71   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp50549808-bb"><span class="identifier">deallocate_one</span></a><span class="special">(</span><span class="identifier">pointer</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
72   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp50552208-bb"><span class="identifier">deallocate_individual</span></a><span class="special">(</span><span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
73   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp50554016-bb"><span class="identifier">allocate_many</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
74   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp50557424-bb"><span class="identifier">allocate_many</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">size_type</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
75   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp50560864-bb"><span class="identifier">deallocate_many</span></a><span class="special">(</span><span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
76
77   <span class="comment">// <a class="link" href="node_allocator.html#idp50570576-bb">public static functions</a></span>
78   <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp50571136-bb"><span class="identifier">deallocate_free_blocks</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
79
80   <span class="comment">// <a class="link" href="node_allocator.html#idp50573008-bb">friend functions</a></span>
81   <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp50573568-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
82   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="node_allocator.html#idp50576576-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
83   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="node_allocator.html#idp50580480-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
84
85   <span class="comment">// <a class="link" href="node_allocator.html#idp50584544-bb">private member functions</a></span>
86   <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#idp50585120-bb"><span class="identifier">priv_allocation_command</span></a><span class="special">(</span><span class="identifier">allocation_type</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">&amp;</span><span class="special">,</span> 
87                                   <span class="identifier">pointer</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
88 <span class="special">}</span><span class="special">;</span></pre></div>
89 <div class="refsect1">
90 <a name="idp191140080"></a><h2>Description</h2>
91 <p>An STL node allocator that uses a modified DlMalloc as memory source.</p>
92 <p>This node allocator shares a segregated storage between all instances of <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> with equal sizeof(T).</p>
93 <p>NodesPerBlock is the number of nodes allocated at once when the allocator runs out of nodes </p>
94 <div class="refsect2">
95 <a name="idp191142464"></a><h3>
96 <a name="boost.container.node_allocatorconstruct-copy-destruct"></a><code class="computeroutput">node_allocator</code> 
97         public
98        construct/copy/destruct</h3>
99 <div class="orderedlist"><ol class="orderedlist" type="1">
100 <li class="listitem">
101 <pre class="literallayout"><a name="idp50562832-bb"></a><span class="identifier">node_allocator</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Default constructor. </li>
102 <li class="listitem">
103 <pre class="literallayout"><a name="idp50563680-bb"></a><span class="identifier">node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Copy constructor from other <code class="computeroutput"><a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a></code>. </li>
104 <li class="listitem">
105 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T2<span class="special">&gt;</span> 
106   <a name="idp50566416-bb"></a><span class="identifier">node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special">&lt;</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Copy constructor from related <code class="computeroutput"><a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a></code>. </li>
107 <li class="listitem">
108 <pre class="literallayout"><a name="idp50570000-bb"></a><span class="special">~</span><span class="identifier">node_allocator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destructor. </li>
109 </ol></div>
110 </div>
111 <div class="refsect2">
112 <a name="idp191174800"></a><h3>
113 <a name="idp50531664-bb"></a><code class="computeroutput">node_allocator</code> public member functions</h3>
114 <div class="orderedlist"><ol class="orderedlist" type="1">
115 <li class="listitem">
116 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp50532224-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
117 <p>Returns the number of elements that could be allocated. Never throws </p>
118 </li>
119 <li class="listitem">
120 <pre class="literallayout"><span class="identifier">pointer</span> <a name="idp50533808-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre>
121 <p>Allocate memory for an array of count elements. Throws std::bad_alloc if there is no enough memory </p>
122 </li>
123 <li class="listitem">
124 <pre class="literallayout"><span class="keyword">void</span> <a name="idp50536816-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span> ptr<span class="special">,</span> <span class="identifier">size_type</span> count<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
125 <p>Deallocate allocated memory. Never throws </p>
126 </li>
127 <li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idp50539760-bb"></a><span class="identifier">allocation_command</span><span class="special">(</span><span class="identifier">allocation_type</span> command<span class="special">,</span> <span class="identifier">size_type</span> limit_size<span class="special">,</span> 
128                            <span class="identifier">size_type</span> <span class="special">&amp;</span> prefer_in_recvd_out_size<span class="special">,</span> 
129                            <span class="identifier">pointer</span> <span class="special">&amp;</span> reuse<span class="special">)</span><span class="special">;</span></pre></li>
130 <li class="listitem">
131 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp50543376-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="identifier">pointer</span> p<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
132 <p>Returns maximum the number of objects the previously allocated memory pointed by p can hold. </p>
133 </li>
134 <li class="listitem">
135 <pre class="literallayout"><span class="identifier">pointer</span> <a name="idp50545680-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
136 <p>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws bad_alloc if there is no enough memory </p>
137 </li>
138 <li class="listitem">
139 <pre class="literallayout"><span class="keyword">void</span> <a name="idp50547088-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> num_elements<span class="special">,</span> 
140                          <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span><span class="special">;</span></pre>
141 <p>Allocates many elements of size == 1. Elements must be individually deallocated with deallocate_one() </p>
142 </li>
143 <li class="listitem">
144 <pre class="literallayout"><span class="keyword">void</span> <a name="idp50549808-bb"></a><span class="identifier">deallocate_one</span><span class="special">(</span><span class="identifier">pointer</span> p<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
145 <p>Deallocates memory previously allocated with allocate_one(). You should never use deallocate_one to deallocate memory allocated with other functions different from allocate_one(). Never throws </p>
146 </li>
147 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp50552208-bb"></a><span class="identifier">deallocate_individual</span><span class="special">(</span><span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
148 <li class="listitem">
149 <pre class="literallayout"><span class="keyword">void</span> <a name="idp50554016-bb"></a><span class="identifier">allocate_many</span><span class="special">(</span><span class="identifier">size_type</span> elem_size<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> n_elements<span class="special">,</span> 
150                    <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span><span class="special">;</span></pre>
151 <p>Allocates many elements of size elem_size. Elements must be individually deallocated with deallocate() </p>
152 </li>
153 <li class="listitem">
154 <pre class="literallayout"><span class="keyword">void</span> <a name="idp50557424-bb"></a><span class="identifier">allocate_many</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">size_type</span> <span class="special">*</span> elem_sizes<span class="special">,</span> <span class="identifier">size_type</span> n_elements<span class="special">,</span> 
155                    <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span><span class="special">;</span></pre>
156 <p>Allocates n_elements elements, each one of size elem_sizes[i] Elements must be individually deallocated with deallocate() </p>
157 </li>
158 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp50560864-bb"></a><span class="identifier">deallocate_many</span><span class="special">(</span><span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
159 </ol></div>
160 </div>
161 <div class="refsect2">
162 <a name="idp191270112"></a><h3>
163 <a name="idp50570576-bb"></a><code class="computeroutput">node_allocator</code> public static functions</h3>
164 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
165 <pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="idp50571136-bb"></a><span class="identifier">deallocate_free_blocks</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Deallocates all free blocks of the pool. </li></ol></div>
166 </div>
167 <div class="refsect2">
168 <a name="idp191278224"></a><h3>
169 <a name="idp50573008-bb"></a><code class="computeroutput">node_allocator</code> friend functions</h3>
170 <div class="orderedlist"><ol class="orderedlist" type="1">
171 <li class="listitem">
172 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="idp50573568-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
173 <p>Swaps allocators. Does not throw. If each allocator is placed in a different memory segment, the result is undefined. </p>
174 </li>
175 <li class="listitem">
176 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp50576576-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
177 <p>An allocator always compares to true, as memory allocated with one instance can be deallocated by another instance </p>
178 </li>
179 <li class="listitem">
180 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp50580480-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
181 <p>An allocator always compares to false, as memory allocated with one instance can be deallocated by another instance </p>
182 </li>
183 </ol></div>
184 </div>
185 <div class="refsect2">
186 <a name="idp191312560"></a><h3>
187 <a name="idp50584544-bb"></a><code class="computeroutput">node_allocator</code> private member functions</h3>
188 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idp50585120-bb"></a><span class="identifier">priv_allocation_command</span><span class="special">(</span><span class="identifier">allocation_type</span> command<span class="special">,</span> 
189                                 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> limit_size<span class="special">,</span> 
190                                 <span class="identifier">size_type</span> <span class="special">&amp;</span> prefer_in_recvd_out_size<span class="special">,</span> 
191                                 <span class="identifier">pointer</span> <span class="special">&amp;</span> reuse<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
192 </div>
193 </div>
194 </div>
195 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
196 <td align="left"></td>
197 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Ion Gaztanaga<p>
198         Distributed under the Boost Software License, Version 1.0. (See accompanying
199         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>)
200       </p>
201 </div></td>
202 </tr></table>
203 <hr>
204 <div class="spirit-nav">
205 <a accesskey="p" href="new_allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.node_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="node_allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
206 </div>
207 </body>
208 </html>