3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Class template unordered_multiset</title>
5 <link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
8 <link rel="up" href="../unordered/reference.html#header.boost.unordered_set_hpp" title="Header <boost/unordered_set.hpp>">
9 <link rel="prev" href="unordered_set.html" title="Class template unordered_set">
10 <link rel="next" href="unordered_map.html" title="Class template unordered_map">
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
15 <td align="center"><a href="../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../more/index.htm">More</a></td>
22 <div class="spirit-nav">
23 <a accesskey="p" href="unordered_set.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_map.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
25 <div class="refentry">
26 <a name="boost.unordered_multiset"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Class template unordered_multiset</span></h2>
29 <p>boost::unordered_multiset —
30 An unordered associative container that stores values. The same key can be stored multiple times.
33 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
34 <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>>
36 </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Value<span class="special">,</span> <span class="keyword">typename</span> Hash <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">hash</span><span class="special"><</span><span class="identifier">Value</span><span class="special">></span><span class="special">,</span>
37 <span class="keyword">typename</span> Pred <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">equal_to</span><span class="special"><</span><span class="identifier">Value</span><span class="special">></span><span class="special">,</span>
38 <span class="keyword">typename</span> Alloc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">allocator</span><span class="special"><</span><span class="identifier">Value</span><span class="special">></span> <span class="special">></span>
39 <span class="keyword">class</span> <a class="link" href="unordered_multiset.html" title="Class template unordered_multiset">unordered_multiset</a> <span class="special">{</span>
40 <span class="keyword">public</span><span class="special">:</span>
41 <span class="comment">// <a class="link" href="unordered_multiset.html#boost.unordered_multisettypes">types</a></span>
42 <span class="keyword">typedef</span> <span class="identifier">Value</span> <a name="boost.unordered_multiset.key_type"></a><span class="identifier">key_type</span><span class="special">;</span>
43 <span class="keyword">typedef</span> <span class="identifier">Value</span> <a name="boost.unordered_multiset.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
44 <span class="keyword">typedef</span> <span class="identifier">Hash</span> <a name="boost.unordered_multiset.hasher"></a><span class="identifier">hasher</span><span class="special">;</span>
45 <span class="keyword">typedef</span> <span class="identifier">Pred</span> <a name="boost.unordered_multiset.key_equal"></a><span class="identifier">key_equal</span><span class="special">;</span>
46 <span class="keyword">typedef</span> <span class="identifier">Alloc</span> <a name="boost.unordered_multiset.allocator_type"></a><span class="identifier">allocator_type</span><span class="special">;</span>
47 <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">allocator_type</span><span class="special">::</span><span class="identifier">pointer</span> <a class="link" href="unordered_multiset.html#boost.unordered_multiset.pointer"><span class="identifier">pointer</span></a><span class="special">;</span>
48 <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">allocator_type</span><span class="special">::</span><span class="identifier">const_pointer</span> <a class="link" href="unordered_multiset.html#boost.unordered_multiset.const_pointer"><span class="identifier">const_pointer</span></a><span class="special">;</span>
49 <span class="keyword">typedef</span> <span class="identifier">value_type</span><span class="special">&</span> <a name="boost.unordered_multiset.reference"></a><span class="identifier">reference</span><span class="special">;</span> <span class="comment">// lvalue of value_type.</span>
50 <span class="keyword">typedef</span> <span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <a name="boost.unordered_multiset.const_reference"></a><span class="identifier">const_reference</span><span class="special">;</span> <span class="comment">// const lvalue of value_type.</span>
51 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span> <a class="link" href="unordered_multiset.html#boost.unordered_multiset.size_type"><span class="identifier">size_type</span></a><span class="special">;</span>
52 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span> <a class="link" href="unordered_multiset.html#boost.unordered_multiset.difference_type"><span class="identifier">difference_type</span></a><span class="special">;</span>
53 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span> <a class="link" href="unordered_multiset.html#boost.unordered_multiset.iterator"><span class="identifier">iterator</span></a><span class="special">;</span>
54 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span> <a class="link" href="unordered_multiset.html#boost.unordered_multiset.const_iterator"><span class="identifier">const_iterator</span></a><span class="special">;</span>
55 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span> <a class="link" href="unordered_multiset.html#boost.unordered_multiset.local_iterator"><span class="identifier">local_iterator</span></a><span class="special">;</span>
56 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span> <a class="link" href="unordered_multiset.html#boost.unordered_multiset.const_local_iterator"><span class="identifier">const_local_iterator</span></a><span class="special">;</span>
58 <span class="comment">// <a class="link" href="unordered_multiset.html#boost.unordered_multisetconstruct-copy-destruct">construct/copy/destruct</a></span>
59 <span class="keyword">explicit</span> <a class="link" href="unordered_multiset.html#idp157047856-bb"><span class="identifier">unordered_multiset</span></a><span class="special">(</span><span class="identifier">size_type</span> <span class="special">=</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span><span class="special">,</span>
60 <span class="identifier">hasher</span> <span class="keyword">const</span><span class="special">&</span> <span class="special">=</span> <span class="identifier">hasher</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
61 <span class="identifier">key_equal</span> <span class="keyword">const</span><span class="special">&</span> <span class="special">=</span> <span class="identifier">key_equal</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
62 <span class="identifier">allocator_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="special">=</span> <span class="identifier">allocator_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
63 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> InputIterator<span class="special">></span>
64 <a class="link" href="unordered_multiset.html#idp157060112-bb"><span class="identifier">unordered_multiset</span></a><span class="special">(</span><span class="identifier">InputIterator</span><span class="special">,</span> <span class="identifier">InputIterator</span><span class="special">,</span>
65 <span class="identifier">size_type</span> <span class="special">=</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span><span class="special">,</span>
66 <span class="identifier">hasher</span> <span class="keyword">const</span><span class="special">&</span> <span class="special">=</span> <span class="identifier">hasher</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
67 <span class="identifier">key_equal</span> <span class="keyword">const</span><span class="special">&</span> <span class="special">=</span> <span class="identifier">key_equal</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
68 <span class="identifier">allocator_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="special">=</span> <span class="identifier">allocator_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
69 <a class="link" href="unordered_multiset.html#idp157074464-bb"><span class="identifier">unordered_multiset</span></a><span class="special">(</span><span class="identifier">unordered_multiset</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span>
70 <a class="link" href="unordered_multiset.html#idp157078960-bb"><span class="identifier">unordered_multiset</span></a><span class="special">(</span><span class="identifier">unordered_multiset</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span>
71 <span class="keyword">explicit</span> <a class="link" href="unordered_multiset.html#idp157085056-bb"><span class="identifier">unordered_multiset</span></a><span class="special">(</span><span class="identifier">Allocator</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span>
72 <a class="link" href="unordered_multiset.html#idp157088256-bb"><span class="identifier">unordered_multiset</span></a><span class="special">(</span><span class="identifier">unordered_multiset</span> <span class="keyword">const</span><span class="special">&</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span>
73 <a class="link" href="unordered_multiset.html#idp157092944-bb"><span class="special">~</span><span class="identifier">unordered_multiset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
74 <span class="identifier">unordered_multiset</span><span class="special">&</span> <a class="link" href="unordered_multiset.html#idp157094256-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">unordered_multiset</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span>
75 <span class="identifier">unordered_multiset</span><span class="special">&</span> <a class="link" href="unordered_multiset.html#idp157099952-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">unordered_multiset</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span>
76 <span class="identifier">allocator_type</span> <a class="link" href="unordered_multiset.html#idp157106800-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>
78 <span class="comment">// <a class="link" href="unordered_multiset.html#idp157108240-bb">size and capacity</a></span>
79 <span class="keyword">bool</span> <a class="link" href="unordered_multiset.html#idp157108800-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
80 <span class="identifier">size_type</span> <a class="link" href="unordered_multiset.html#idp302576624-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
81 <span class="identifier">size_type</span> <a class="link" href="unordered_multiset.html#idp302579856-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>
83 <span class="comment">// <a class="link" href="unordered_multiset.html#idp302582448-bb">iterators</a></span>
84 <span class="identifier">iterator</span> <a class="link" href="unordered_multiset.html#idp302583568-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
85 <span class="identifier">const_iterator</span> <a class="link" href="unordered_multiset.html#idp302584144-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
86 <span class="identifier">iterator</span> <a class="link" href="unordered_multiset.html#idp302586288-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
87 <span class="identifier">const_iterator</span> <a class="link" href="unordered_multiset.html#idp302587184-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
88 <span class="identifier">const_iterator</span> <a class="link" href="unordered_multiset.html#idp302588928-bb"><span class="identifier">cbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
89 <span class="identifier">const_iterator</span> <a class="link" href="unordered_multiset.html#idp302590960-bb"><span class="identifier">cend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
91 <span class="comment">// <a class="link" href="unordered_multiset.html#idp302593088-bb">modifiers</a></span>
92 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> Args<span class="special">></span> <span class="identifier">iterator</span> <a class="link" href="unordered_multiset.html#idp302593648-bb"><span class="identifier">emplace</span></a><span class="special">(</span><span class="identifier">Args</span><span class="special">&&</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
93 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> Args<span class="special">></span> <span class="identifier">iterator</span> <a class="link" href="unordered_multiset.html#idp302607584-bb"><span class="identifier">emplace_hint</span></a><span class="special">(</span><span class="identifier">const_iterator</span><span class="special">,</span> <span class="identifier">Args</span><span class="special">&&</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
94 <span class="identifier">iterator</span> <a class="link" href="unordered_multiset.html#idp302624016-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span>
95 <span class="identifier">iterator</span> <a class="link" href="unordered_multiset.html#idp302632944-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">&&</span><span class="special">)</span><span class="special">;</span>
96 <span class="identifier">iterator</span> <a class="link" href="unordered_multiset.html#idp302641872-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">const_iterator</span><span class="special">,</span> <span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span>
97 <span class="identifier">iterator</span> <a class="link" href="unordered_multiset.html#idp311918960-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">const_iterator</span><span class="special">,</span> <span class="identifier">value_type</span><span class="special">&&</span><span class="special">)</span><span class="special">;</span>
98 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> InputIterator<span class="special">></span> <span class="keyword">void</span> <a class="link" href="unordered_multiset.html#idp311930096-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">InputIterator</span><span class="special">,</span> <span class="identifier">InputIterator</span><span class="special">)</span><span class="special">;</span>
99 <span class="identifier">iterator</span> <a class="link" href="unordered_multiset.html#idp311941200-bb"><span class="identifier">erase</span></a><span class="special">(</span><span class="identifier">const_iterator</span><span class="special">)</span><span class="special">;</span>
100 <span class="identifier">size_type</span> <a class="link" href="unordered_multiset.html#idp311949232-bb"><span class="identifier">erase</span></a><span class="special">(</span><span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span>
101 <span class="identifier">iterator</span> <a class="link" href="unordered_multiset.html#idp311955552-bb"><span class="identifier">erase</span></a><span class="special">(</span><span class="identifier">const_iterator</span><span class="special">,</span> <span class="identifier">const_iterator</span><span class="special">)</span><span class="special">;</span>
102 <span class="keyword">void</span> <a class="link" href="unordered_multiset.html#idp311964528-bb"><span class="identifier">quick_erase</span></a><span class="special">(</span><span class="identifier">const_iterator</span><span class="special">)</span><span class="special">;</span>
103 <span class="keyword">void</span> <a class="link" href="unordered_multiset.html#idp311972192-bb"><span class="identifier">erase_return_void</span></a><span class="special">(</span><span class="identifier">const_iterator</span><span class="special">)</span><span class="special">;</span>
104 <span class="keyword">void</span> <a class="link" href="unordered_multiset.html#idp311979856-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
105 <span class="keyword">void</span> <a class="link" href="unordered_multiset.html#idp311984160-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">unordered_multiset</span><span class="special">&</span><span class="special">)</span><span class="special">;</span>
107 <span class="comment">// <a class="link" href="unordered_multiset.html#idp303524640-bb">observers</a></span>
108 <span class="identifier">hasher</span> <a class="link" href="unordered_multiset.html#idp303525200-bb"><span class="identifier">hash_function</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
109 <span class="identifier">key_equal</span> <a class="link" href="unordered_multiset.html#idp303527056-bb"><span class="identifier">key_eq</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
111 <span class="comment">// <a class="link" href="unordered_multiset.html#idp303529072-bb">lookup</a></span>
112 <span class="identifier">iterator</span> <a class="link" href="unordered_multiset.html#idp303530192-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span>
113 <span class="identifier">const_iterator</span> <a class="link" href="unordered_multiset.html#idp303532256-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
114 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CompatibleKey<span class="special">,</span> <span class="keyword">typename</span> CompatibleHash<span class="special">,</span>
115 <span class="keyword">typename</span> CompatiblePredicate<span class="special">></span>
116 <span class="identifier">iterator</span> <a class="link" href="unordered_multiset.html#idp303534592-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="identifier">CompatibleKey</span> <span class="keyword">const</span><span class="special">&</span><span class="special">,</span> <span class="identifier">CompatibleHash</span> <span class="keyword">const</span><span class="special">&</span><span class="special">,</span>
117 <span class="identifier">CompatiblePredicate</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span>
118 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CompatibleKey<span class="special">,</span> <span class="keyword">typename</span> CompatibleHash<span class="special">,</span>
119 <span class="keyword">typename</span> CompatiblePredicate<span class="special">></span>
120 <span class="identifier">const_iterator</span>
121 <a class="link" href="unordered_multiset.html#idp303541136-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="identifier">CompatibleKey</span> <span class="keyword">const</span><span class="special">&</span><span class="special">,</span> <span class="identifier">CompatibleHash</span> <span class="keyword">const</span><span class="special">&</span><span class="special">,</span>
122 <span class="identifier">CompatiblePredicate</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
123 <span class="identifier">size_type</span> <a class="link" href="unordered_multiset.html#idp303550768-bb"><span class="identifier">count</span></a><span class="special">(</span><span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
124 <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">iterator</span><span class="special">,</span> <span class="identifier">iterator</span><span class="special">></span> <a class="link" href="unordered_multiset.html#idp303555248-bb"><span class="identifier">equal_range</span></a><span class="special">(</span><span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span>
125 <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">const_iterator</span><span class="special">,</span> <span class="identifier">const_iterator</span><span class="special">></span> <a class="link" href="unordered_multiset.html#idp303557328-bb"><span class="identifier">equal_range</span></a><span class="special">(</span><span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
127 <span class="comment">// <a class="link" href="unordered_multiset.html#idp303562976-bb">bucket interface</a></span>
128 <span class="identifier">size_type</span> <a class="link" href="unordered_multiset.html#idp303563536-bb"><span class="identifier">bucket_count</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
129 <span class="identifier">size_type</span> <a class="link" href="unordered_multiset.html#idp303565872-bb"><span class="identifier">max_bucket_count</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
130 <span class="identifier">size_type</span> <a class="link" href="unordered_multiset.html#idp303568176-bb"><span class="identifier">bucket_size</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
131 <span class="identifier">size_type</span> <a class="link" href="unordered_multiset.html#idp303573616-bb"><span class="identifier">bucket</span></a><span class="special">(</span><span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
132 <span class="identifier">local_iterator</span> <a class="link" href="unordered_multiset.html#idp303579296-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
133 <span class="identifier">const_local_iterator</span> <a class="link" href="unordered_multiset.html#idp303581360-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
134 <span class="identifier">local_iterator</span> <a class="link" href="unordered_multiset.html#idp303587360-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
135 <span class="identifier">const_local_iterator</span> <a class="link" href="unordered_multiset.html#idp303685520-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
136 <span class="identifier">const_local_iterator</span> <a class="link" href="unordered_multiset.html#idp303690960-bb"><span class="identifier">cbegin</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
137 <span class="identifier">const_local_iterator</span> <a class="link" href="unordered_multiset.html#idp303696512-bb"><span class="identifier">cend</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
139 <span class="comment">// <a class="link" href="unordered_multiset.html#idp303702064-bb">hash policy</a></span>
140 <span class="keyword">float</span> <a class="link" href="unordered_multiset.html#idp303702624-bb"><span class="identifier">load_factor</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
141 <span class="keyword">float</span> <a class="link" href="unordered_multiset.html#idp303704928-bb"><span class="identifier">max_load_factor</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
142 <span class="keyword">void</span> <a class="link" href="unordered_multiset.html#idp303707232-bb"><span class="identifier">max_load_factor</span></a><span class="special">(</span><span class="keyword">float</span><span class="special">)</span><span class="special">;</span>
143 <span class="keyword">void</span> <a class="link" href="unordered_multiset.html#idp303710880-bb"><span class="identifier">rehash</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
144 <span class="keyword">void</span> <a class="link" href="unordered_multiset.html#idp303716048-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
145 <span class="special">}</span><span class="special">;</span>
147 <span class="comment">// <a class="link" href="unordered_multiset.html#idp303720544-bb">Equality Comparisons</a></span>
148 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Value<span class="special">,</span> <span class="keyword">typename</span> Hash<span class="special">,</span> <span class="keyword">typename</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span>
149 <span class="keyword">bool</span> <a class="link" href="unordered_multiset.html#boost.unordered_multiset.operator==_idp303721104"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="identifier">unordered_multiset</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Hash</span><span class="special">,</span> <span class="identifier">Pred</span><span class="special">,</span> <span class="identifier">Alloc</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span><span class="special">,</span>
150 <span class="identifier">unordered_multiset</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Hash</span><span class="special">,</span> <span class="identifier">Pred</span><span class="special">,</span> <span class="identifier">Alloc</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span>
151 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Value<span class="special">,</span> <span class="keyword">typename</span> Hash<span class="special">,</span> <span class="keyword">typename</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span>
152 <span class="keyword">bool</span> <a class="link" href="unordered_multiset.html#boost.unordered_multiset.operator!=_idp303732448"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="identifier">unordered_multiset</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Hash</span><span class="special">,</span> <span class="identifier">Pred</span><span class="special">,</span> <span class="identifier">Alloc</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span><span class="special">,</span>
153 <span class="identifier">unordered_multiset</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Hash</span><span class="special">,</span> <span class="identifier">Pred</span><span class="special">,</span> <span class="identifier">Alloc</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span>
155 <span class="comment">// <a class="link" href="unordered_multiset.html#idp303743952-bb">swap</a></span>
156 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Value<span class="special">,</span> <span class="keyword">typename</span> Hash<span class="special">,</span> <span class="keyword">typename</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span>
157 <span class="keyword">void</span> <a class="link" href="unordered_multiset.html#boost.unordered_multiset.swap_idp303744512"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">unordered_multiset</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Hash</span><span class="special">,</span> <span class="identifier">Pred</span><span class="special">,</span> <span class="identifier">Alloc</span><span class="special">></span><span class="special">&</span><span class="special">,</span>
158 <span class="identifier">unordered_multiset</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Hash</span><span class="special">,</span> <span class="identifier">Pred</span><span class="special">,</span> <span class="identifier">Alloc</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></div>
159 <div class="refsect1">
160 <a name="idp518749680"></a><h2>Description</h2>
161 <p><span class="bold"><strong>Template Parameters</strong></span>
163 <div class="informaltable"><table class="table">
170 <td><span class="emphasis"><em>Value</em></span></td>
172 <code class="computeroutput">Value</code> must be <code class="computeroutput">Erasable</code> from the container
173 (i.e. <code class="computeroutput">allocator_traits</code> can <code class="computeroutput">destroy</code> it).
177 <td><span class="emphasis"><em>Hash</em></span></td>
178 <td>A unary function object type that acts a hash function for a <code class="computeroutput">Value</code>. It takes a single argument of type <code class="computeroutput">Value</code> and returns a value of type std::size_t.</td>
181 <td><span class="emphasis"><em>Pred</em></span></td>
182 <td>A binary function object that implements an equivalence relation on values of type <code class="computeroutput">Value</code>.
183 A binary function object that induces an equivalence relation on values of type <code class="computeroutput">Value</code>.
184 It takes two arguments of type <code class="computeroutput">Value</code> and returns a value of type bool.</td>
187 <td><span class="emphasis"><em>Alloc</em></span></td>
188 <td>An allocator whose value type is the same as the container's value type.</td>
192 <p>The elements are organized into buckets. Keys with the same hash code are stored in the same bucket and elements with equivalent keys are stored next to each other.</p>
193 <p>The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash.</p>
194 <div class="refsect2">
195 <a name="idp518764672"></a><h3>
196 <a name="boost.unordered_multisettypes"></a><code class="computeroutput">unordered_multiset</code>
199 <div class="orderedlist"><ol class="orderedlist" type="1">
200 <li class="listitem">
202 <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">allocator_type</span><span class="special">::</span><span class="identifier">pointer</span> <a name="boost.unordered_multiset.pointer"></a><span class="identifier">pointer</span><span class="special">;</span></p>
204 <code class="computeroutput">value_type*</code> if
205 <code class="computeroutput">allocator_type::pointer</code> is not defined.
208 <li class="listitem">
210 <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">allocator_type</span><span class="special">::</span><span class="identifier">const_pointer</span> <a name="boost.unordered_multiset.const_pointer"></a><span class="identifier">const_pointer</span><span class="special">;</span></p>
212 <code class="computeroutput">boost::pointer_to_other<pointer, value_type>::type</code>
213 if <code class="computeroutput">allocator_type::const_pointer</code> is not defined.
216 <li class="listitem">
218 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span> <a name="boost.unordered_multiset.size_type"></a><span class="identifier">size_type</span><span class="special">;</span></p>
219 <p>An unsigned integral type.</p>
220 <p>size_type can represent any non-negative value of difference_type.</p>
222 <li class="listitem">
224 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span> <a name="boost.unordered_multiset.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span></p>
225 <p>A signed integral type.</p>
226 <p>Is identical to the difference type of iterator and const_iterator.</p>
228 <li class="listitem">
230 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span> <a name="boost.unordered_multiset.iterator"></a><span class="identifier">iterator</span><span class="special">;</span></p>
231 <p>A constant iterator whose value type is value_type. </p>
232 <p>The iterator category is at least a forward iterator.</p>
233 <p>Convertible to const_iterator.</p>
235 <li class="listitem">
237 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span> <a name="boost.unordered_multiset.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span></p>
238 <p>A constant iterator whose value type is value_type. </p>
239 <p>The iterator category is at least a forward iterator.</p>
241 <li class="listitem">
243 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span> <a name="boost.unordered_multiset.local_iterator"></a><span class="identifier">local_iterator</span><span class="special">;</span></p>
244 <p>An iterator with the same value type, difference type and pointer and reference type as iterator.</p>
245 <p>A local_iterator object can be used to iterate through a single bucket.</p>
247 <li class="listitem">
249 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span> <a name="boost.unordered_multiset.const_local_iterator"></a><span class="identifier">const_local_iterator</span><span class="special">;</span></p>
250 <p>A constant iterator with the same value type, difference type and pointer and reference type as const_iterator.</p>
251 <p>A const_local_iterator object can be used to iterate through a single bucket.</p>
255 <div class="refsect2">
256 <a name="idp518816128"></a><h3>
257 <a name="boost.unordered_multisetconstruct-copy-destruct"></a><code class="computeroutput">unordered_multiset</code>
259 construct/copy/destruct</h3>
260 <div class="orderedlist"><ol class="orderedlist" type="1">
261 <li class="listitem">
262 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp157047856-bb"></a><span class="identifier">unordered_multiset</span><span class="special">(</span><span class="identifier">size_type</span> n <span class="special">=</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span><span class="special">,</span>
263 <span class="identifier">hasher</span> <span class="keyword">const</span><span class="special">&</span> hf <span class="special">=</span> <span class="identifier">hasher</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
264 <span class="identifier">key_equal</span> <span class="keyword">const</span><span class="special">&</span> eq <span class="special">=</span> <span class="identifier">key_equal</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
265 <span class="identifier">allocator_type</span> <span class="keyword">const</span><span class="special">&</span> a <span class="special">=</span> <span class="identifier">allocator_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>
266 <p>Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocator and a maximum load factor of 1.0.</p>
267 <div class="variablelist"><table border="0" class="variablelist compact">
269 <col align="left" valign="top">
274 <td><p><span class="term">Postconditions:</span></p></td>
275 <td><code class="computeroutput"><a class="link" href="unordered_multiset.html#idp302576624-bb">size</a>() == 0</code></td>
278 <td><p><span class="term">Requires:</span></p></td>
279 <td><p>If the defaults are used, <code class="computeroutput">hasher</code>, <code class="computeroutput">key_equal</code> and
280 <code class="computeroutput">allocator_type</code> need to be <code class="computeroutput">DefaultConstructible</code>.
286 <li class="listitem">
287 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> InputIterator<span class="special">></span>
288 <a name="idp157060112-bb"></a><span class="identifier">unordered_multiset</span><span class="special">(</span><span class="identifier">InputIterator</span> f<span class="special">,</span> <span class="identifier">InputIterator</span> l<span class="special">,</span>
289 <span class="identifier">size_type</span> n <span class="special">=</span> <span class="emphasis"><em><span class="identifier">implementation</span><span class="special">-</span><span class="identifier">defined</span></em></span><span class="special">,</span>
290 <span class="identifier">hasher</span> <span class="keyword">const</span><span class="special">&</span> hf <span class="special">=</span> <span class="identifier">hasher</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
291 <span class="identifier">key_equal</span> <span class="keyword">const</span><span class="special">&</span> eq <span class="special">=</span> <span class="identifier">key_equal</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
292 <span class="identifier">allocator_type</span> <span class="keyword">const</span><span class="special">&</span> a <span class="special">=</span> <span class="identifier">allocator_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>
293 <p>Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocator and a maximum load factor of 1.0 and inserts the elements from [f, l) into it.</p>
294 <div class="variablelist"><table border="0" class="variablelist compact">
296 <col align="left" valign="top">
300 <td><p><span class="term">Requires:</span></p></td>
301 <td><p>If the defaults are used, <code class="computeroutput">hasher</code>, <code class="computeroutput">key_equal</code> and
302 <code class="computeroutput">allocator_type</code> need to be <code class="computeroutput">DefaultConstructible</code>.
307 <li class="listitem">
308 <pre class="literallayout"><a name="idp157074464-bb"></a><span class="identifier">unordered_multiset</span><span class="special">(</span><span class="identifier">unordered_multiset</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span></pre>
309 <p>The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator.</p>
310 <p>If <code class="computeroutput">Allocator::select_on_container_copy_construction</code>
311 exists and has the right signature, the allocator will be
312 constructed from its result.</p>
313 <div class="variablelist"><table border="0" class="variablelist compact">
315 <col align="left" valign="top">
319 <td><p><span class="term">Requires:</span></p></td>
320 <td><p><code class="computeroutput">value_type</code> is copy constructible</p></td>
324 <li class="listitem">
325 <pre class="literallayout"><a name="idp157078960-bb"></a><span class="identifier">unordered_multiset</span><span class="special">(</span><span class="identifier">unordered_multiset</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span></pre>
326 <p>The move constructor.</p>
327 <div class="variablelist"><table border="0" class="variablelist compact">
329 <col align="left" valign="top">
334 <td><p><span class="term">Notes:</span></p></td>
335 <td><p>This is implemented using Boost.Move.</p></td>
338 <td><p><span class="term">Requires:</span></p></td>
341 <code class="computeroutput">value_type</code> is move constructible.
344 On compilers without rvalue reference support the
345 emulation does not support moving without calling
346 <code class="computeroutput">boost::move</code> if <code class="computeroutput">value_type</code> is
347 not copyable. So, for example, you can't return the
348 container from a function.
355 <li class="listitem">
356 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp157085056-bb"></a><span class="identifier">unordered_multiset</span><span class="special">(</span><span class="identifier">Allocator</span> <span class="keyword">const</span><span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre>
357 <p>Constructs an empty container, using allocator <code class="computeroutput">a</code>.</p>
359 <li class="listitem">
360 <pre class="literallayout"><a name="idp157088256-bb"></a><span class="identifier">unordered_multiset</span><span class="special">(</span><span class="identifier">unordered_multiset</span> <span class="keyword">const</span><span class="special">&</span> x<span class="special">,</span> <span class="identifier">Allocator</span> <span class="keyword">const</span><span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre>
361 <p>Constructs an container, copying <code class="computeroutput">x</code>'s contained elements, hash function, predicate, maximum load factor, but using allocator <code class="computeroutput">a</code>.</p>
363 <li class="listitem">
364 <pre class="literallayout"><a name="idp157092944-bb"></a><span class="special">~</span><span class="identifier">unordered_multiset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
365 <div class="variablelist"><table border="0" class="variablelist compact">
367 <col align="left" valign="top">
371 <td><p><span class="term">Notes:</span></p></td>
372 <td><p>The destructor is applied to every element, and all memory is deallocated</p></td>
378 <pre class="literallayout"><span class="identifier">unordered_multiset</span><span class="special">&</span> <a name="idp157094256-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">unordered_multiset</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span></pre>
379 <p>The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator.</p>
380 <p>If <code class="computeroutput">Alloc::propagate_on_container_copy_assignment</code>
381 exists and <code class="computeroutput">Alloc::propagate_on_container_copy_assignment::value
382 </code> is true, the allocator is overwritten, if not the
383 copied elements are created using the existing
385 <div class="variablelist"><table border="0" class="variablelist compact">
387 <col align="left" valign="top">
391 <td><p><span class="term">Requires:</span></p></td>
392 <td><p><code class="computeroutput">value_type</code> is copy constructible</p></td>
395 <pre class="literallayout"><span class="identifier">unordered_multiset</span><span class="special">&</span> <a name="idp157099952-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">unordered_multiset</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span></pre>
396 <p>The move assignment operator.</p>
397 <p>If <code class="computeroutput">Alloc::propagate_on_container_move_assignment</code>
398 exists and <code class="computeroutput">Alloc::propagate_on_container_move_assignment::value
399 </code> is true, the allocator is overwritten, if not the
400 moved elements are created using the existing
402 <div class="variablelist"><table border="0" class="variablelist compact">
404 <col align="left" valign="top">
409 <td><p><span class="term">Notes:</span></p></td>
411 On compilers without rvalue references, this is emulated using
412 Boost.Move. Note that on some compilers the copy assignment
413 operator may be used in some circumstances.
417 <td><p><span class="term">Requires:</span></p></td>
419 <code class="computeroutput">value_type</code> is move constructible.
424 <pre class="literallayout"><span class="identifier">allocator_type</span> <a name="idp157106800-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>
425 <div class="refsect2">
426 <a name="idp518948064"></a><h3>
427 <a name="idp157108240-bb"></a><code class="computeroutput">unordered_multiset</code> size and capacity</h3>
428 <div class="orderedlist"><ol class="orderedlist" type="1">
429 <li class="listitem">
430 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp157108800-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
431 <div class="variablelist"><table border="0" class="variablelist compact">
433 <col align="left" valign="top">
437 <td><p><span class="term">Returns:</span></p></td>
438 <td><code class="computeroutput"><a class="link" href="unordered_multiset.html#idp302576624-bb">size</a>() == 0</code></td>
442 <li class="listitem">
443 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp302576624-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
444 <div class="variablelist"><table border="0" class="variablelist compact">
446 <col align="left" valign="top">
450 <td><p><span class="term">Returns:</span></p></td>
451 <td><code class="computeroutput">std::distance(<a class="link" href="unordered_multiset.html#idp302583008-bb">begin</a>(), <a class="link" href="unordered_multiset.html#idp302585728-bb">end</a>())</code></td>
455 <li class="listitem">
456 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp302579856-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>
457 <div class="variablelist"><table border="0" class="variablelist compact">
459 <col align="left" valign="top">
463 <td><p><span class="term">Returns:</span></p></td>
465 <code class="computeroutput"><a class="link" href="unordered_multiset.html#idp302576624-bb">size</a>()</code> of the largest possible container.
472 <div class="refsect2">
473 <a name="idp518973728"></a><h3>
474 <a name="idp302582448-bb"></a><code class="computeroutput">unordered_multiset</code> iterators</h3>
475 <div class="orderedlist"><ol class="orderedlist" type="1">
476 <li class="listitem">
477 <pre class="literallayout"><a name="idp302583008-bb"></a><span class="identifier">iterator</span> <a name="idp302583568-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span>
478 <span class="identifier">const_iterator</span> <a name="idp302584144-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
479 <div class="variablelist"><table border="0" class="variablelist compact">
481 <col align="left" valign="top">
485 <td><p><span class="term">Returns:</span></p></td>
486 <td>An iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container.
491 <li class="listitem">
492 <pre class="literallayout"><a name="idp302585728-bb"></a><span class="identifier">iterator</span> <a name="idp302586288-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span>
493 <span class="identifier">const_iterator</span> <a name="idp302587184-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
494 <div class="variablelist"><table border="0" class="variablelist compact">
496 <col align="left" valign="top">
500 <td><p><span class="term">Returns:</span></p></td>
501 <td>An iterator which refers to the past-the-end value for the container.
506 <li class="listitem">
507 <pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp302588928-bb"></a><span class="identifier">cbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
508 <div class="variablelist"><table border="0" class="variablelist compact">
510 <col align="left" valign="top">
514 <td><p><span class="term">Returns:</span></p></td>
515 <td>A constant iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container.
520 <li class="listitem">
521 <pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp302590960-bb"></a><span class="identifier">cend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
522 <div class="variablelist"><table border="0" class="variablelist compact">
524 <col align="left" valign="top">
528 <td><p><span class="term">Returns:</span></p></td>
529 <td>A constant iterator which refers to the past-the-end value for the container.
536 <div class="refsect2">
537 <a name="idp519009280"></a><h3>
538 <a name="idp302593088-bb"></a><code class="computeroutput">unordered_multiset</code> modifiers</h3>
539 <div class="orderedlist"><ol class="orderedlist" type="1">
540 <li class="listitem">
541 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> Args<span class="special">></span> <span class="identifier">iterator</span> <a name="idp302593648-bb"></a><span class="identifier">emplace</span><span class="special">(</span><span class="identifier">Args</span><span class="special">&&</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre>
542 <p>Inserts an object, constructed with the arguments <code class="computeroutput">args</code>, in the container.</p>
543 <div class="variablelist"><table border="0" class="variablelist compact">
545 <col align="left" valign="top">
550 <td><p><span class="term">Requires:</span></p></td>
551 <td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">EmplaceConstructible</code> into
552 <code class="computeroutput">X</code> from <code class="computeroutput">args</code>.
556 <td><p><span class="term">Returns:</span></p></td>
557 <td><p>An iterator pointing to the inserted element.</p></td>
560 <td><p><span class="term">Throws:</span></p></td>
561 <td><p>If an exception is thrown by an operation other than a call to <code class="computeroutput">hasher</code> the function has no effect.</p></td>
564 <td><p><span class="term">Notes:</span></p></td>
566 <p>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</p>
567 <p>Pointers and references to elements are never invalidated.</p>
568 <p>If the compiler doesn't support variadic template arguments or rvalue
569 references, this is emulated for up to 10 arguments, with no support
570 for rvalue references or move semantics.</p>
571 <p>Since existing <code class="computeroutput">std::pair</code> implementations don't support
572 <code class="computeroutput">std::piecewise_construct</code> this emulates it,
573 but using <code class="computeroutput">boost::unordered::piecewise_construct</code>.</p>
579 <li class="listitem">
580 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> Args<span class="special">></span>
581 <span class="identifier">iterator</span> <a name="idp302607584-bb"></a><span class="identifier">emplace_hint</span><span class="special">(</span><span class="identifier">const_iterator</span> hint<span class="special">,</span> <span class="identifier">Args</span><span class="special">&&</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre>
582 <p>Inserts an object, constructed with the arguments <code class="computeroutput">args</code>, in the container.</p>
583 <p><code class="computeroutput">hint</code> is a suggestion to where the element should be inserted.</p>
584 <div class="variablelist"><table border="0" class="variablelist compact">
586 <col align="left" valign="top">
591 <td><p><span class="term">Requires:</span></p></td>
592 <td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">EmplaceConstructible</code> into
593 <code class="computeroutput">X</code> from <code class="computeroutput">args</code>.
597 <td><p><span class="term">Returns:</span></p></td>
598 <td><p>An iterator pointing to the inserted element.</p></td>
601 <td><p><span class="term">Throws:</span></p></td>
602 <td><p>If an exception is thrown by an operation other than a call to <code class="computeroutput">hasher</code> the function has no effect.</p></td>
605 <td><p><span class="term">Notes:</span></p></td>
607 <p>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same value. </p>
608 <p>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</p>
609 <p>Pointers and references to elements are never invalidated.</p>
610 <p>If the compiler doesn't support variadic template arguments or rvalue
611 references, this is emulated for up to 10 arguments, with no support
612 for rvalue references or move semantics.</p>
613 <p>Since existing <code class="computeroutput">std::pair</code> implementations don't support
614 <code class="computeroutput">std::piecewise_construct</code> this emulates it,
615 but using <code class="computeroutput">boost::unordered::piecewise_construct</code>.</p>
621 <li class="listitem">
622 <pre class="literallayout"><span class="identifier">iterator</span> <a name="idp302624016-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> obj<span class="special">)</span><span class="special">;</span></pre>
623 <p>Inserts <code class="computeroutput">obj</code> in the container.</p>
624 <div class="variablelist"><table border="0" class="variablelist compact">
626 <col align="left" valign="top">
631 <td><p><span class="term">Requires:</span></p></td>
632 <td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">CopyInsertable</code>.</p></td>
635 <td><p><span class="term">Returns:</span></p></td>
636 <td><p>An iterator pointing to the inserted element.</p></td>
639 <td><p><span class="term">Throws:</span></p></td>
640 <td><p>If an exception is thrown by an operation other than a call to <code class="computeroutput">hasher</code> the function has no effect.</p></td>
643 <td><p><span class="term">Notes:</span></p></td>
645 <p>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</p>
646 <p>Pointers and references to elements are never invalidated.</p>
652 <li class="listitem">
653 <pre class="literallayout"><span class="identifier">iterator</span> <a name="idp302632944-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">value_type</span><span class="special">&&</span> obj<span class="special">)</span><span class="special">;</span></pre>
654 <p>Inserts <code class="computeroutput">obj</code> in the container.</p>
655 <div class="variablelist"><table border="0" class="variablelist compact">
657 <col align="left" valign="top">
662 <td><p><span class="term">Requires:</span></p></td>
663 <td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">MoveInsertable</code>.</p></td>
666 <td><p><span class="term">Returns:</span></p></td>
667 <td><p>An iterator pointing to the inserted element.</p></td>
670 <td><p><span class="term">Throws:</span></p></td>
671 <td><p>If an exception is thrown by an operation other than a call to <code class="computeroutput">hasher</code> the function has no effect.</p></td>
674 <td><p><span class="term">Notes:</span></p></td>
676 <p>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</p>
677 <p>Pointers and references to elements are never invalidated.</p>
683 <li class="listitem">
684 <pre class="literallayout"><span class="identifier">iterator</span> <a name="idp302641872-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">const_iterator</span> hint<span class="special">,</span> <span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> obj<span class="special">)</span><span class="special">;</span></pre>
685 <p>Inserts <code class="computeroutput">obj</code> in the container.</p>
686 <p>hint is a suggestion to where the element should be inserted.</p>
687 <div class="variablelist"><table border="0" class="variablelist compact">
689 <col align="left" valign="top">
694 <td><p><span class="term">Requires:</span></p></td>
695 <td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">CopyInsertable</code>.</p></td>
698 <td><p><span class="term">Returns:</span></p></td>
699 <td><p>An iterator pointing to the inserted element.</p></td>
702 <td><p><span class="term">Throws:</span></p></td>
703 <td><p>If an exception is thrown by an operation other than a call to <code class="computeroutput">hasher</code> the function has no effect.</p></td>
706 <td><p><span class="term">Notes:</span></p></td>
708 <p>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same value. </p>
709 <p>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</p>
710 <p>Pointers and references to elements are never invalidated.</p>
716 <li class="listitem">
717 <pre class="literallayout"><span class="identifier">iterator</span> <a name="idp311918960-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">const_iterator</span> hint<span class="special">,</span> <span class="identifier">value_type</span><span class="special">&&</span> obj<span class="special">)</span><span class="special">;</span></pre>
718 <p>Inserts <code class="computeroutput">obj</code> in the container.</p>
719 <p>hint is a suggestion to where the element should be inserted.</p>
720 <div class="variablelist"><table border="0" class="variablelist compact">
722 <col align="left" valign="top">
727 <td><p><span class="term">Requires:</span></p></td>
728 <td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">MoveInsertable</code>.</p></td>
731 <td><p><span class="term">Returns:</span></p></td>
732 <td><p>An iterator pointing to the inserted element.</p></td>
735 <td><p><span class="term">Throws:</span></p></td>
736 <td><p>If an exception is thrown by an operation other than a call to <code class="computeroutput">hasher</code> the function has no effect.</p></td>
739 <td><p><span class="term">Notes:</span></p></td>
741 <p>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same value. </p>
742 <p>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</p>
743 <p>Pointers and references to elements are never invalidated.</p>
749 <li class="listitem">
750 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> InputIterator<span class="special">></span>
751 <span class="keyword">void</span> <a name="idp311930096-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">InputIterator</span> first<span class="special">,</span> <span class="identifier">InputIterator</span> last<span class="special">)</span><span class="special">;</span></pre>
752 <p>Inserts a range of elements into the container. Elements are inserted if and only if there is no element in the container with an equivalent value.</p>
753 <div class="variablelist"><table border="0" class="variablelist compact">
755 <col align="left" valign="top">
760 <td><p><span class="term">Requires:</span></p></td>
761 <td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">EmplaceConstructible</code> into
762 <code class="computeroutput">X</code> from <code class="computeroutput">*first</code>.</p></td>
765 <td><p><span class="term">Throws:</span></p></td>
766 <td><p>When inserting a single element, if an exception is thrown by an operation other than a call to <code class="computeroutput">hasher</code> the function has no effect.</p></td>
769 <td><p><span class="term">Notes:</span></p></td>
771 <p>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</p>
772 <p>Pointers and references to elements are never invalidated.</p>
778 <li class="listitem">
779 <pre class="literallayout"><span class="identifier">iterator</span> <a name="idp311941200-bb"></a><span class="identifier">erase</span><span class="special">(</span><span class="identifier">const_iterator</span> position<span class="special">)</span><span class="special">;</span></pre>
780 <p>Erase the element pointed to by <code class="computeroutput">position</code>.</p>
781 <div class="variablelist"><table border="0" class="variablelist compact">
783 <col align="left" valign="top">
788 <td><p><span class="term">Returns:</span></p></td>
789 <td><p>The iterator following <code class="computeroutput">position</code> before the erasure.</p></td>
792 <td><p><span class="term">Throws:</span></p></td>
793 <td><p>Only throws an exception if it is thrown by <code class="computeroutput">hasher</code> or <code class="computeroutput">key_equal</code>.</p></td>
796 <td><p><span class="term">Notes:</span></p></td>
798 In older versions this could be inefficient because it had to search
799 through several buckets to find the position of the returned iterator.
800 The data structure has been changed so that this is no longer the case,
801 and the alternative erase methods have been deprecated.
807 <li class="listitem">
808 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp311949232-bb"></a><span class="identifier">erase</span><span class="special">(</span><span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&</span> k<span class="special">)</span><span class="special">;</span></pre>
809 <p>Erase all elements with key equivalent to <code class="computeroutput">k</code>.</p>
810 <div class="variablelist"><table border="0" class="variablelist compact">
812 <col align="left" valign="top">
817 <td><p><span class="term">Returns:</span></p></td>
818 <td><p>The number of elements erased.</p></td>
821 <td><p><span class="term">Throws:</span></p></td>
822 <td><p>Only throws an exception if it is thrown by <code class="computeroutput">hasher</code> or <code class="computeroutput">key_equal</code>.</p></td>
827 <li class="listitem">
828 <pre class="literallayout"><span class="identifier">iterator</span> <a name="idp311955552-bb"></a><span class="identifier">erase</span><span class="special">(</span><span class="identifier">const_iterator</span> first<span class="special">,</span> <span class="identifier">const_iterator</span> last<span class="special">)</span><span class="special">;</span></pre>
829 <p>Erases the elements in the range from <code class="computeroutput">first</code> to <code class="computeroutput">last</code>.</p>
830 <div class="variablelist"><table border="0" class="variablelist compact">
832 <col align="left" valign="top">
837 <td><p><span class="term">Returns:</span></p></td>
838 <td><p>The iterator following the erased elements - i.e. <code class="computeroutput">last</code>.</p></td>
841 <td><p><span class="term">Throws:</span></p></td>
843 <p>Only throws an exception if it is thrown by <code class="computeroutput">hasher</code> or <code class="computeroutput">key_equal</code>.</p>
844 <p>In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations.</p>
850 <li class="listitem">
851 <pre class="literallayout"><span class="keyword">void</span> <a name="idp311964528-bb"></a><span class="identifier">quick_erase</span><span class="special">(</span><span class="identifier">const_iterator</span> position<span class="special">)</span><span class="special">;</span></pre>
852 <p>Erase the element pointed to by <code class="computeroutput">position</code>.</p>
853 <div class="variablelist"><table border="0" class="variablelist compact">
855 <col align="left" valign="top">
860 <td><p><span class="term">Throws:</span></p></td>
862 <p>Only throws an exception if it is thrown by <code class="computeroutput">hasher</code> or <code class="computeroutput">key_equal</code>.</p>
863 <p>In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations.</p>
867 <td><p><span class="term">Notes:</span></p></td>
869 This method was implemented because returning an iterator to
870 the next element from <code class="computeroutput">erase</code> was expensive, but
871 the container has been redesigned so that is no longer the
872 case. So this method is now deprecated.
878 <li class="listitem">
879 <pre class="literallayout"><span class="keyword">void</span> <a name="idp311972192-bb"></a><span class="identifier">erase_return_void</span><span class="special">(</span><span class="identifier">const_iterator</span> position<span class="special">)</span><span class="special">;</span></pre>
880 <p>Erase the element pointed to by <code class="computeroutput">position</code>.</p>
881 <div class="variablelist"><table border="0" class="variablelist compact">
883 <col align="left" valign="top">
888 <td><p><span class="term">Throws:</span></p></td>
890 <p>Only throws an exception if it is thrown by <code class="computeroutput">hasher</code> or <code class="computeroutput">key_equal</code>.</p>
891 <p>In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations.</p>
895 <td><p><span class="term">Notes:</span></p></td>
897 This method was implemented because returning an iterator to
898 the next element from <code class="computeroutput">erase</code> was expensive, but
899 the container has been redesigned so that is no longer the
900 case. So this method is now deprecated.
906 <li class="listitem">
907 <pre class="literallayout"><span class="keyword">void</span> <a name="idp311979856-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
908 <p>Erases all elements in the container.</p>
909 <div class="variablelist"><table border="0" class="variablelist compact">
911 <col align="left" valign="top">
916 <td><p><span class="term">Postconditions:</span></p></td>
917 <td><p><code class="computeroutput"><a class="link" href="unordered_multiset.html#idp302576624-bb">size</a>() == 0</code></p></td>
920 <td><p><span class="term">Throws:</span></p></td>
921 <td><p>Never throws an exception.</p></td>
926 <li class="listitem">
927 <pre class="literallayout"><span class="keyword">void</span> <a name="idp311984160-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">unordered_multiset</span><span class="special">&</span><span class="special">)</span><span class="special">;</span></pre>
928 <p>Swaps the contents of the container with the parameter.</p>
929 <p>If <code class="computeroutput">Allocator::propagate_on_container_swap</code> is declared and
930 <code class="computeroutput">Allocator::propagate_on_container_swap::value</code> is true then the
931 containers' allocators are swapped. Otherwise, swapping with unequal allocators
932 results in undefined behavior.</p>
933 <div class="variablelist"><table border="0" class="variablelist compact">
935 <col align="left" valign="top">
940 <td><p><span class="term">Throws:</span></p></td>
941 <td><p>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code class="computeroutput">key_equal</code> or <code class="computeroutput">hasher</code>.</p></td>
944 <td><p><span class="term">Notes:</span></p></td>
945 <td><p>The exception specifications aren't quite the same as the C++11 standard, as
946 the equality predieate and hash function are swapped using their copy constructors.</p></td>
953 <div class="refsect2">
954 <a name="idp519207248"></a><h3>
955 <a name="idp303524640-bb"></a><code class="computeroutput">unordered_multiset</code> observers</h3>
956 <div class="orderedlist"><ol class="orderedlist" type="1">
957 <li class="listitem">
958 <pre class="literallayout"><span class="identifier">hasher</span> <a name="idp303525200-bb"></a><span class="identifier">hash_function</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
959 <div class="variablelist"><table border="0" class="variablelist compact">
961 <col align="left" valign="top">
965 <td><p><span class="term">Returns:</span></p></td>
966 <td>The container's hash function.
971 <li class="listitem">
972 <pre class="literallayout"><span class="identifier">key_equal</span> <a name="idp303527056-bb"></a><span class="identifier">key_eq</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
973 <div class="variablelist"><table border="0" class="variablelist compact">
975 <col align="left" valign="top">
979 <td><p><span class="term">Returns:</span></p></td>
980 <td>The container's key equality predicate.
987 <div class="refsect2">
988 <a name="idp519222144"></a><h3>
989 <a name="idp303529072-bb"></a><code class="computeroutput">unordered_multiset</code> lookup</h3>
990 <div class="orderedlist"><ol class="orderedlist" type="1">
991 <li class="listitem">
992 <pre class="literallayout"><a name="idp303529632-bb"></a><span class="identifier">iterator</span> <a name="idp303530192-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&</span> k<span class="special">)</span><span class="special">;</span>
993 <span class="identifier">const_iterator</span> <a name="idp303532256-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&</span> k<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
994 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CompatibleKey<span class="special">,</span> <span class="keyword">typename</span> CompatibleHash<span class="special">,</span>
995 <span class="keyword">typename</span> CompatiblePredicate<span class="special">></span>
996 <span class="identifier">iterator</span> <a name="idp303534592-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="identifier">CompatibleKey</span> <span class="keyword">const</span><span class="special">&</span> k<span class="special">,</span> <span class="identifier">CompatibleHash</span> <span class="keyword">const</span><span class="special">&</span> hash<span class="special">,</span>
997 <span class="identifier">CompatiblePredicate</span> <span class="keyword">const</span><span class="special">&</span> eq<span class="special">)</span><span class="special">;</span>
998 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CompatibleKey<span class="special">,</span> <span class="keyword">typename</span> CompatibleHash<span class="special">,</span>
999 <span class="keyword">typename</span> CompatiblePredicate<span class="special">></span>
1000 <span class="identifier">const_iterator</span>
1001 <a name="idp303541136-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="identifier">CompatibleKey</span> <span class="keyword">const</span><span class="special">&</span> k<span class="special">,</span> <span class="identifier">CompatibleHash</span> <span class="keyword">const</span><span class="special">&</span> hash<span class="special">,</span>
1002 <span class="identifier">CompatiblePredicate</span> <span class="keyword">const</span><span class="special">&</span> eq<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1003 <div class="variablelist"><table border="0" class="variablelist compact">
1005 <col align="left" valign="top">
1010 <td><p><span class="term">Returns:</span></p></td>
1011 <td><p>An iterator pointing to an element with key equivalent to <code class="computeroutput">k</code>, or <code class="computeroutput">b.end()</code> if no such element exists.</p></td>
1014 <td><p><span class="term">Notes:</span></p></td>
1016 The templated overloads are a non-standard extensions which
1017 allows you to use a compatible hash function and equality
1018 predicate for a key of a different type in order to avoid
1019 an expensive type cast. In general, its use is not encouraged.
1025 <li class="listitem">
1026 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp303550768-bb"></a><span class="identifier">count</span><span class="special">(</span><span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&</span> k<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1027 <div class="variablelist"><table border="0" class="variablelist compact">
1029 <col align="left" valign="top">
1033 <td><p><span class="term">Returns:</span></p></td>
1034 <td><p>The number of elements with key equivalent to <code class="computeroutput">k</code>.</p></td>
1038 <li class="listitem">
1039 <pre class="literallayout"><a name="idp303554688-bb"></a><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">iterator</span><span class="special">,</span> <span class="identifier">iterator</span><span class="special">></span> <a name="idp303555248-bb"></a><span class="identifier">equal_range</span><span class="special">(</span><span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&</span> k<span class="special">)</span><span class="special">;</span>
1040 <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">const_iterator</span><span class="special">,</span> <span class="identifier">const_iterator</span><span class="special">></span> <a name="idp303557328-bb"></a><span class="identifier">equal_range</span><span class="special">(</span><span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&</span> k<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1041 <div class="variablelist"><table border="0" class="variablelist compact">
1043 <col align="left" valign="top">
1047 <td><p><span class="term">Returns:</span></p></td>
1048 <td><p>A range containing all elements with key equivalent to <code class="computeroutput">k</code>.
1049 If the container doesn't container any such elements, returns
1050 <code class="computeroutput">std::make_pair(b.end(),b.end())</code>.
1057 <div class="refsect2">
1058 <a name="idp519306560"></a><h3>
1059 <a name="idp303562976-bb"></a><code class="computeroutput">unordered_multiset</code> bucket interface</h3>
1060 <div class="orderedlist"><ol class="orderedlist" type="1">
1061 <li class="listitem">
1062 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp303563536-bb"></a><span class="identifier">bucket_count</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1063 <div class="variablelist"><table border="0" class="variablelist compact">
1065 <col align="left" valign="top">
1069 <td><p><span class="term">Returns:</span></p></td>
1070 <td><p>The number of buckets.</p></td>
1074 <li class="listitem">
1075 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp303565872-bb"></a><span class="identifier">max_bucket_count</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1076 <div class="variablelist"><table border="0" class="variablelist compact">
1078 <col align="left" valign="top">
1082 <td><p><span class="term">Returns:</span></p></td>
1083 <td><p>An upper bound on the number of buckets.</p></td>
1087 <li class="listitem">
1088 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp303568176-bb"></a><span class="identifier">bucket_size</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1089 <div class="variablelist"><table border="0" class="variablelist compact">
1091 <col align="left" valign="top">
1096 <td><p><span class="term">Requires:</span></p></td>
1097 <td><p><code class="computeroutput">n < <a class="link" href="unordered_multiset.html#idp303563536-bb">bucket_count</a>()</code></p></td>
1100 <td><p><span class="term">Returns:</span></p></td>
1101 <td><p>The number of elements in bucket <code class="computeroutput">n</code>.</p></td>
1106 <li class="listitem">
1107 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp303573616-bb"></a><span class="identifier">bucket</span><span class="special">(</span><span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&</span> k<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1108 <div class="variablelist"><table border="0" class="variablelist compact">
1110 <col align="left" valign="top">
1115 <td><p><span class="term">Returns:</span></p></td>
1116 <td><p>The index of the bucket which would contain an element with key <code class="computeroutput">k</code>.</p></td>
1119 <td><p><span class="term">Postconditions:</span></p></td>
1120 <td><p>The return value is less than <code class="computeroutput">bucket_count()</code></p></td>
1125 <li class="listitem">
1126 <pre class="literallayout"><a name="idp303578736-bb"></a><span class="identifier">local_iterator</span> <a name="idp303579296-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span>
1127 <span class="identifier">const_local_iterator</span> <a name="idp303581360-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1128 <div class="variablelist"><table border="0" class="variablelist compact">
1130 <col align="left" valign="top">
1135 <td><p><span class="term">Requires:</span></p></td>
1136 <td><p><code class="computeroutput">n</code> shall be in the range <code class="computeroutput">[0, bucket_count())</code>.</p></td>
1139 <td><p><span class="term">Returns:</span></p></td>
1140 <td><p>A local iterator pointing the first element in the bucket with index <code class="computeroutput">n</code>.</p></td>
1145 <li class="listitem">
1146 <pre class="literallayout"><a name="idp303586800-bb"></a><span class="identifier">local_iterator</span> <a name="idp303587360-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span>
1147 <span class="identifier">const_local_iterator</span> <a name="idp303685520-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1148 <div class="variablelist"><table border="0" class="variablelist compact">
1150 <col align="left" valign="top">
1155 <td><p><span class="term">Requires:</span></p></td>
1156 <td><p><code class="computeroutput">n</code> shall be in the range <code class="computeroutput">[0, bucket_count())</code>.</p></td>
1159 <td><p><span class="term">Returns:</span></p></td>
1160 <td><p>A local iterator pointing the 'one past the end' element in the bucket with index <code class="computeroutput">n</code>.</p></td>
1165 <li class="listitem">
1166 <pre class="literallayout"><span class="identifier">const_local_iterator</span> <a name="idp303690960-bb"></a><span class="identifier">cbegin</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1167 <div class="variablelist"><table border="0" class="variablelist compact">
1169 <col align="left" valign="top">
1174 <td><p><span class="term">Requires:</span></p></td>
1175 <td><p><code class="computeroutput">n</code> shall be in the range <code class="computeroutput">[0, bucket_count())</code>.</p></td>
1178 <td><p><span class="term">Returns:</span></p></td>
1179 <td><p>A constant local iterator pointing the first element in the bucket with index <code class="computeroutput">n</code>.</p></td>
1184 <li class="listitem">
1185 <pre class="literallayout"><span class="identifier">const_local_iterator</span> <a name="idp303696512-bb"></a><span class="identifier">cend</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre>
1186 <div class="variablelist"><table border="0" class="variablelist compact">
1188 <col align="left" valign="top">
1193 <td><p><span class="term">Requires:</span></p></td>
1194 <td><p><code class="computeroutput">n</code> shall be in the range <code class="computeroutput">[0, bucket_count())</code>.</p></td>
1197 <td><p><span class="term">Returns:</span></p></td>
1198 <td><p>A constant local iterator pointing the 'one past the end' element in the bucket with index <code class="computeroutput">n</code>.</p></td>
1205 <div class="refsect2">
1206 <a name="idp519389888"></a><h3>
1207 <a name="idp303702064-bb"></a><code class="computeroutput">unordered_multiset</code> hash policy</h3>
1208 <div class="orderedlist"><ol class="orderedlist" type="1">
1209 <li class="listitem">
1210 <pre class="literallayout"><span class="keyword">float</span> <a name="idp303702624-bb"></a><span class="identifier">load_factor</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1211 <div class="variablelist"><table border="0" class="variablelist compact">
1213 <col align="left" valign="top">
1217 <td><p><span class="term">Returns:</span></p></td>
1218 <td><p>The average number of elements per bucket.</p></td>
1222 <li class="listitem">
1223 <pre class="literallayout"><span class="keyword">float</span> <a name="idp303704928-bb"></a><span class="identifier">max_load_factor</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1224 <div class="variablelist"><table border="0" class="variablelist compact">
1226 <col align="left" valign="top">
1230 <td><p><span class="term">Returns:</span></p></td>
1231 <td><p>Returns the current maximum load factor.</p></td>
1235 <li class="listitem">
1236 <pre class="literallayout"><span class="keyword">void</span> <a name="idp303707232-bb"></a><span class="identifier">max_load_factor</span><span class="special">(</span><span class="keyword">float</span> z<span class="special">)</span><span class="special">;</span></pre>
1237 <div class="variablelist"><table border="0" class="variablelist compact">
1239 <col align="left" valign="top">
1243 <td><p><span class="term">Effects:</span></p></td>
1244 <td><p>Changes the container's maximum load factor, using <code class="computeroutput">z</code> as a hint.</p></td>
1248 <li class="listitem">
1249 <pre class="literallayout"><span class="keyword">void</span> <a name="idp303710880-bb"></a><span class="identifier">rehash</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre>
1250 <p>Changes the number of buckets so that there at least <code class="computeroutput">n</code> buckets, and so that the load factor is less than the maximum load factor.</p>
1251 <p>Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated.</p>
1252 <div class="variablelist"><table border="0" class="variablelist compact">
1254 <col align="left" valign="top">
1258 <td><p><span class="term">Throws:</span></p></td>
1259 <td><p>The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function.</p></td>
1263 <li class="listitem">
1264 <pre class="literallayout"><span class="keyword">void</span> <a name="idp303716048-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre>
1265 <p>Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated.</p>
1266 <div class="variablelist"><table border="0" class="variablelist compact">
1268 <col align="left" valign="top">
1272 <td><p><span class="term">Throws:</span></p></td>
1273 <td><p>The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function.</p></td>
1279 <div class="refsect2">
1280 <a name="idp519427072"></a><h3>
1281 <a name="idp303720544-bb"></a><code class="computeroutput">unordered_multiset</code> Equality Comparisons</h3>
1282 <div class="orderedlist"><ol class="orderedlist" type="1">
1283 <li class="listitem">
1284 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Value<span class="special">,</span> <span class="keyword">typename</span> Hash<span class="special">,</span> <span class="keyword">typename</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span>
1285 <span class="keyword">bool</span> <a name="boost.unordered_multiset.operator==_idp303721104"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="identifier">unordered_multiset</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Hash</span><span class="special">,</span> <span class="identifier">Pred</span><span class="special">,</span> <span class="identifier">Alloc</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> x<span class="special">,</span>
1286 <span class="identifier">unordered_multiset</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Hash</span><span class="special">,</span> <span class="identifier">Pred</span><span class="special">,</span> <span class="identifier">Alloc</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre>
1287 <p>Return <code class="computeroutput">true</code> if <code class="computeroutput">x.size() ==
1288 y.size</code> and for every equivalent key group in
1289 <code class="computeroutput">x</code>, there is a group in <code class="computeroutput">y</code>
1290 for the same key, which is a permutation (using
1291 <code class="computeroutput">operator==</code> to compare the value types).
1293 <div class="variablelist"><table border="0" class="variablelist compact">
1295 <col align="left" valign="top">
1299 <td><p><span class="term">Notes:</span></p></td>
1301 <p>The behavior of this function was changed to match
1302 the C++11 standard in Boost 1.48.</p>
1303 <p>Behavior is undefined if the two containers don't have
1304 equivalent equality predicates.</p>
1309 <li class="listitem">
1310 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Value<span class="special">,</span> <span class="keyword">typename</span> Hash<span class="special">,</span> <span class="keyword">typename</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span>
1311 <span class="keyword">bool</span> <a name="boost.unordered_multiset.operator!=_idp303732448"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="identifier">unordered_multiset</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Hash</span><span class="special">,</span> <span class="identifier">Pred</span><span class="special">,</span> <span class="identifier">Alloc</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> x<span class="special">,</span>
1312 <span class="identifier">unordered_multiset</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Hash</span><span class="special">,</span> <span class="identifier">Pred</span><span class="special">,</span> <span class="identifier">Alloc</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre>
1313 <p>Return <code class="computeroutput">false</code> if <code class="computeroutput">x.size() ==
1314 y.size</code> and for every equivalent key group in
1315 <code class="computeroutput">x</code>, there is a group in <code class="computeroutput">y</code>
1316 for the same key, which is a permutation (using
1317 <code class="computeroutput">operator==</code> to compare the value types).
1319 <div class="variablelist"><table border="0" class="variablelist compact">
1321 <col align="left" valign="top">
1325 <td><p><span class="term">Notes:</span></p></td>
1327 <p>The behavior of this function was changed to match
1328 the C++11 standard in Boost 1.48.</p>
1329 <p>Behavior is undefined if the two containers don't have
1330 equivalent equality predicates.</p>
1337 <div class="refsect2">
1338 <a name="idp519494288"></a><h3>
1339 <a name="idp303743952-bb"></a><code class="computeroutput">unordered_multiset</code> swap</h3>
1340 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
1341 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Value<span class="special">,</span> <span class="keyword">typename</span> Hash<span class="special">,</span> <span class="keyword">typename</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span>
1342 <span class="keyword">void</span> <a name="boost.unordered_multiset.swap_idp303744512"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">unordered_multiset</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Hash</span><span class="special">,</span> <span class="identifier">Pred</span><span class="special">,</span> <span class="identifier">Alloc</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span>
1343 <span class="identifier">unordered_multiset</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Hash</span><span class="special">,</span> <span class="identifier">Pred</span><span class="special">,</span> <span class="identifier">Alloc</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre>
1344 <p>Swaps the contents of <code class="computeroutput">x</code> and <code class="computeroutput">y</code>.</p>
1345 <p>If <code class="computeroutput">Allocator::propagate_on_container_swap</code> is declared and
1346 <code class="computeroutput">Allocator::propagate_on_container_swap::value</code> is true then the
1347 containers' allocators are swapped. Otherwise, swapping with unequal allocators
1348 results in undefined behavior.</p>
1349 <div class="variablelist"><table border="0" class="variablelist compact">
1351 <col align="left" valign="top">
1356 <td><p><span class="term">Effects:</span></p></td>
1357 <td><p><code class="computeroutput">x.swap(y)</code></p></td>
1360 <td><p><span class="term">Throws:</span></p></td>
1361 <td><p>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code class="computeroutput">key_equal</code> or <code class="computeroutput">hasher</code>.</p></td>
1364 <td><p><span class="term">Notes:</span></p></td>
1365 <td><p>The exception specifications aren't quite the same as the C++11 standard, as
1366 the equality predieate and hash function are swapped using their copy constructors.</p></td>
1374 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
1375 <td align="left"></td>
1376 <td align="right"><div class="copyright-footer">Copyright © 2003, 2004 Jeremy B. Maitin-Shepard<br>Copyright © 2005-2008 Daniel
1378 Distributed under the Boost Software License, Version 1.0. (See accompanying
1379 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>)
1384 <div class="spirit-nav">
1385 <a accesskey="p" href="unordered_set.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_map.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>