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 node_handle_map</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="../../unordered/reference.html#header.boost.unordered_map_hpp" title="Header <boost/unordered_map.hpp>"> 10<link rel="prev" href="../unordered_multiset.html" title="Class template unordered_multiset"> 11<link rel="next" href="../unordered_map.html" title="Class template unordered_map"> 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="../unordered_multiset.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../unordered/reference.html#header.boost.unordered_map_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="../unordered_map.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.unordered.node_handle_map"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template node_handle_map</span></h2> 30<p>boost::unordered::node_handle_map — 31 An object that owns a single element extracted from an 32 <a class="link" href="../unordered_map.html" title="Class template unordered_map">unordered_map</a> or an 33 <a class="link" href="../unordered_multimap.html" title="Class template unordered_multimap">unordered_multimap</a>, that 34 can then be inserted into a compatible container type. 35 36 The name and template parameters of this type are implementation 37 defined, and should be obtained using the <code class="computeroutput">node_type</code> 38 member typedef from the appropriate container. 39 </p> 40</div> 41<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 42<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="../../unordered/reference.html#header.boost.unordered_map_hpp" title="Header <boost/unordered_map.hpp>">boost/unordered_map.hpp</a>> 43 44</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ImplementationDefined<span class="special">></span> 45<span class="keyword">class</span> <a class="link" href="node_handle_map.html" title="Class template node_handle_map">node_handle_map</a> <span class="special">{</span> 46<span class="keyword">public</span><span class="special">:</span> 47 <span class="comment">// types</span> 48 <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">Container</span><span class="special">::</span><span class="identifier">key_type</span> <a name="boost.unordered.node_handle_map.key_type"></a><span class="identifier">key_type</span><span class="special">;</span> 49 <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">Container</span><span class="special">::</span><span class="identifier">mapped_type</span> <a name="boost.unordered.node_handle_map.mapped_type"></a><span class="identifier">mapped_type</span><span class="special">;</span> 50 <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">Container</span><span class="special">::</span><span class="identifier">allocator_type</span><span class="special">></span> <a name="boost.unordered.node_handle_map.allocator_type"></a><span class="identifier">allocator_type</span><span class="special">;</span> 51 52 <span class="comment">// <a class="link" href="node_handle_map.html#boost.unordered.node_handle_mapconstruct-copy-destruct">construct/copy/destruct</a></span> 53 <span class="keyword">constexpr</span> <a class="link" href="node_handle_map.html#id-1_3_45_10_2_1_3_1_6-bb"><span class="identifier">node_handle_map</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 54 <a class="link" href="node_handle_map.html#id-1_3_45_10_2_1_3_1_8-bb"><span class="identifier">node_handle_map</span></a><span class="special">(</span><span class="identifier">node_handle_map</span> <span class="special">&&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 55 <a class="link" href="node_handle_map.html#id-1_3_45_10_2_1_3_1_7-bb"><span class="special">~</span><span class="identifier">node_handle_map</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 56 <span class="identifier">node_handle_map</span><span class="special">&</span> <a class="link" href="node_handle_map.html#id-1_3_45_10_2_1_3_1_9-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">node_handle_map</span><span class="special">&&</span><span class="special">)</span><span class="special">;</span> 57 <span class="identifier">key_type</span><span class="special">&</span> <a class="link" href="node_handle_map.html#id-1_3_45_10_2_1_3_1_10-bb"><span class="identifier">key</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 58 <span class="identifier">mapped_type</span><span class="special">&</span> <a class="link" href="node_handle_map.html#id-1_3_45_10_2_1_3_1_11-bb"><span class="identifier">mapped</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 59 <span class="identifier">allocator_type</span> <a class="link" href="node_handle_map.html#id-1_3_45_10_2_1_3_1_12-bb"><span class="identifier">get_allocator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 60 <span class="keyword">explicit</span> <a class="link" href="node_handle_map.html#id-1_3_45_10_2_1_3_1_13-bb"><span class="keyword">operator</span> <span class="keyword">bool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 61 <span class="keyword">bool</span> <a class="link" href="node_handle_map.html#id-1_3_45_10_2_1_3_1_14-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 62 <span class="keyword">void</span> <a class="link" href="node_handle_map.html#id-1_3_45_10_2_1_3_1_15-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">node_handle_map</span><span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">(</span><span class="identifier">ator_traits</span><span class="special">::</span><span class="identifier">propagate_on_container_swap</span><span class="special">::</span><span class="identifier">value</span><span class="special">)</span><span class="special">;</span> 63<span class="special">}</span><span class="special">;</span> 64 65<span class="comment">// <a class="link" href="node_handle_map.html#id-1_3_45_10_2_1_3_1_16-bb">swap</a></span> 66<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ImplementationDefined<span class="special">></span> 67 <span class="keyword">void</span> <a class="link" href="node_handle_map.html#boost.unordered.node_handle_map.swap"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">node_handle_map</span><span class="special"><</span><span class="identifier">ImplementationDefined</span><span class="special">></span><span class="special">&</span><span class="special">,</span> 68 <span class="identifier">node_handle_map</span><span class="special"><</span><span class="identifier">ImplementationDefined</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></div> 69<div class="refsect1"> 70<a name="id-1.3.45.10.3.3.4"></a><h2>Description</h2> 71<div class="refsect2"> 72<a name="id-1.3.45.10.3.3.4.2"></a><h3> 73<a name="boost.unordered.node_handle_mapconstruct-copy-destruct"></a><code class="computeroutput">node_handle_map</code> 74 public 75 construct/copy/destruct</h3> 76<div class="orderedlist"><ol class="orderedlist" type="1"> 77<li class="listitem"><pre class="literallayout"><span class="keyword">constexpr</span> <a name="id-1_3_45_10_2_1_3_1_6-bb"></a><span class="identifier">node_handle_map</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> 78<li class="listitem"><pre class="literallayout"><a name="id-1_3_45_10_2_1_3_1_8-bb"></a><span class="identifier">node_handle_map</span><span class="special">(</span><span class="identifier">node_handle_map</span> <span class="special">&&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> 79<li class="listitem"><pre class="literallayout"><a name="id-1_3_45_10_2_1_3_1_7-bb"></a><span class="special">~</span><span class="identifier">node_handle_map</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 80</ol></div> 81</div> 82<pre class="literallayout"><span class="identifier">node_handle_map</span><span class="special">&</span> <a name="id-1_3_45_10_2_1_3_1_9-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">node_handle_map</span><span class="special">&&</span><span class="special">)</span><span class="special">;</span></pre> 83<pre class="literallayout"><span class="identifier">key_type</span><span class="special">&</span> <a name="id-1_3_45_10_2_1_3_1_10-bb"></a><span class="identifier">key</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 84<pre class="literallayout"><span class="identifier">mapped_type</span><span class="special">&</span> <a name="id-1_3_45_10_2_1_3_1_11-bb"></a><span class="identifier">mapped</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 85<pre class="literallayout"><span class="identifier">allocator_type</span> <a name="id-1_3_45_10_2_1_3_1_12-bb"></a><span class="identifier">get_allocator</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 86<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_45_10_2_1_3_1_13-bb"></a><span class="keyword">operator</span> <span class="keyword">bool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 87<pre class="literallayout"><span class="keyword">bool</span> <a name="id-1_3_45_10_2_1_3_1_14-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 88<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_45_10_2_1_3_1_15-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">node_handle_map</span><span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">(</span><span class="identifier">ator_traits</span><span class="special">::</span><span class="identifier">propagate_on_container_swap</span><span class="special">::</span><span class="identifier">value</span><span class="special">)</span><span class="special">;</span></pre> 89<div class="variablelist"><table border="0" class="variablelist compact"> 90<colgroup> 91<col align="left" valign="top"> 92<col> 93</colgroup> 94<tbody><tr> 95<td><p><span class="term">Notes:</span></p></td> 96<td><p> 97 In C++17 is also <code class="computeroutput">noexcept</code> if <code class="computeroutput">ator_traits::is_always_equal::value</code> is true. 98 But we don't support that trait yet. 99 </p></td> 100</tr></tbody> 101</table></div> 102<div class="refsect2"> 103<a name="id-1.3.45.10.3.3.4.11"></a><h3> 104<a name="id-1_3_45_10_2_1_3_1_16-bb"></a><code class="computeroutput">node_handle_map</code> swap</h3> 105<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 106<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ImplementationDefined<span class="special">></span> 107 <span class="keyword">void</span> <a name="boost.unordered.node_handle_map.swap"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">node_handle_map</span><span class="special"><</span><span class="identifier">ImplementationDefined</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> 108 <span class="identifier">node_handle_map</span><span class="special"><</span><span class="identifier">ImplementationDefined</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre> 109<div class="variablelist"><table border="0" class="variablelist compact"> 110<colgroup> 111<col align="left" valign="top"> 112<col> 113</colgroup> 114<tbody><tr> 115<td><p><span class="term">Effects:</span></p></td> 116<td><p><code class="computeroutput">x.swap(y)</code></p></td> 117</tr></tbody> 118</table></div> 119</li></ol></div> 120</div> 121</div> 122</div> 123<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 124<td align="left"></td> 125<td align="right"><div class="copyright-footer">Copyright © 2003, 2004 Jeremy B. Maitin-Shepard<br>Copyright © 2005-2008 Daniel 126 James<p> 127 Distributed under the Boost Software License, Version 1.0. (See accompanying 128 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>) 129 </p> 130</div></td> 131</tr></table> 132<hr> 133<div class="spirit-nav"> 134<a accesskey="p" href="../unordered_multiset.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../unordered/reference.html#header.boost.unordered_map_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="../unordered_map.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 135</div> 136</body> 137</html> 138
