diff options
Diffstat (limited to 'doc/html/boost/unordered/node_handle_set.html')
| -rw-r--r-- | doc/html/boost/unordered/node_handle_set.html | 138 |
1 files changed, 138 insertions, 0 deletions
diff --git a/doc/html/boost/unordered/node_handle_set.html b/doc/html/boost/unordered/node_handle_set.html new file mode 100644 index 0000000000..8843462d11 --- /dev/null +++ b/doc/html/boost/unordered/node_handle_set.html @@ -0,0 +1,138 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class template node_handle_set</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../unordered/reference.html#header.boost.unordered_set_hpp" title="Header <boost/unordered_set.hpp>"> +<link rel="prev" href="../../unordered/reference.html" title="Reference"> +<link rel="next" href="../unordered_set.html" title="Class template unordered_set"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../../unordered/reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../unordered/reference.html#header.boost.unordered_set_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_set.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.unordered.node_handle_set"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template node_handle_set</span></h2> +<p>boost::unordered::node_handle_set — + An object that owns a single element extracted from an + <a class="link" href="../unordered_set.html" title="Class template unordered_set">unordered_set</a> or an + <a class="link" href="../unordered_multiset.html" title="Class template unordered_multiset">unordered_multiset</a>, that + can then be inserted into a compatible container type. + <span style="color: red"><notes><p> + The name and template parameters of this type is implementation + defined, and should be obtained using the <code class="computeroutput">node_type</code> + member typedef from the appropriate container. + </p> +<p> + In this version of Boost, <code class="computeroutput">node_type</code> is different + for <code class="computeroutput">unordered_set</code> and <code class="computeroutput">unordered_multiset</code>, this will be fixed in a future version of Boost. + </p></notes></span></p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<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_set_hpp" title="Header <boost/unordered_set.hpp>">boost/unordered_set.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ImplementationDefined<span class="special">></span> +<span class="keyword">class</span> <a class="link" href="node_handle_set.html" title="Class template node_handle_set">node_handle_set</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">Container</span><span class="special">::</span><span class="identifier">value_type</span><span class="special">></span> <a name="boost.unordered.node_handle_set.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> + <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_set.allocator_type"></a><span class="identifier">allocator_type</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="node_handle_set.html#boost.unordered.node_handle_setconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="keyword">constexpr</span> <a class="link" href="node_handle_set.html#idp775752896-bb"><span class="identifier">node_handle_set</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="node_handle_set.html#idp775754176-bb"><span class="identifier">node_handle_set</span></a><span class="special">(</span><span class="identifier">node_handle_set</span> <span class="special">&&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="node_handle_set.html#idp775753888-bb"><span class="special">~</span><span class="identifier">node_handle_set</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">node_handle_set</span><span class="special">&</span> <a class="link" href="node_handle_set.html#idp775755792-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">node_handle_set</span><span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">value_type</span><span class="special">&</span> <a class="link" href="node_handle_set.html#idp775757856-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">allocator_type</span> <a class="link" href="node_handle_set.html#idp775759296-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> + <span class="keyword">explicit</span> <a class="link" href="node_handle_set.html#idp775760736-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> + <span class="keyword">bool</span> <a class="link" href="node_handle_set.html#idp775762000-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> + <span class="keyword">void</span> <a class="link" href="node_handle_set.html#idp775763440-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">node_handle_set</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> +<span class="special">}</span><span class="special">;</span> + +<span class="comment">// <a class="link" href="node_handle_set.html#idp775767712-bb">swap</a></span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ImplementationDefined<span class="special">></span> + <span class="keyword">void</span> <a class="link" href="node_handle_set.html#boost.unordered.node_handle_set.swap_idp775768560"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">node_handle_set</span><span class="special"><</span><span class="identifier">ImplementationDefined</span><span class="special">></span><span class="special">&</span><span class="special">,</span> + <span class="identifier">node_handle_set</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> +<div class="refsect1"> +<a name="idp605714144"></a><h2>Description</h2> +<div class="refsect2"> +<a name="idp605714560"></a><h3> +<a name="boost.unordered.node_handle_setconstruct-copy-destruct"></a><code class="computeroutput">node_handle_set</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"><pre class="literallayout"><span class="keyword">constexpr</span> <a name="idp775752896-bb"></a><span class="identifier">node_handle_set</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp775754176-bb"></a><span class="identifier">node_handle_set</span><span class="special">(</span><span class="identifier">node_handle_set</span> <span class="special">&&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp775753888-bb"></a><span class="special">~</span><span class="identifier">node_handle_set</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +<pre class="literallayout"><span class="identifier">node_handle_set</span><span class="special">&</span> <a name="idp775755792-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">node_handle_set</span><span class="special">&&</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">value_type</span><span class="special">&</span> <a name="idp775757856-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">allocator_type</span> <a name="idp775759296-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> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp775760736-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> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp775762000-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp775763440-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">node_handle_set</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> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term">Notes:</span></p></td> +<td><p> + In C++17 is also <code class="computeroutput">noexcept</code> if <code class="computeroutput">ator_traits::is_always_equal::value</code> is true. + But we don't support that trait yet. + </p></td> +</tr></tbody> +</table></div> +<div class="refsect2"> +<a name="idp605772576"></a><h3> +<a name="idp775767712-bb"></a><code class="computeroutput">node_handle_set</code> swap</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ImplementationDefined<span class="special">></span> + <span class="keyword">void</span> <a name="boost.unordered.node_handle_set.swap_idp775768560"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">node_handle_set</span><span class="special"><</span><span class="identifier">ImplementationDefined</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> + <span class="identifier">node_handle_set</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> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term">Effects:</span></p></td> +<td><p><code class="computeroutput">x.swap(y)</code></p></td> +</tr></tbody> +</table></div> +</li></ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003, 2004 Jeremy B. Maitin-Shepard<br>Copyright © 2005-2008 Daniel + James<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + 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>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../../unordered/reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../unordered/reference.html#header.boost.unordered_set_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_set.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |