1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Class template unordered_multimap</title> 6<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../unordered/reference.html#header.boost.unordered_map_hpp" title="Header <boost/unordered_map.hpp>"> 10<link rel="prev" href="unordered_map.html" title="Class template unordered_map"> 11<link rel="next" href="../unordered/bibliography.html" title="Bibliography"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td> 16<td align="center"><a href="../../../index.html">Home</a></td> 17<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="unordered_map.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../unordered/reference.html#header.boost.unordered_map_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../unordered/bibliography.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.unordered_multimap"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template unordered_multimap</span></h2> 30<p>boost::unordered_multimap — 31 An unordered associative container that associates keys with another value. The same key can be stored multiple times. 32 </p> 33</div> 34<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 35<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../unordered/reference.html#header.boost.unordered_map_hpp" title="Header <boost/unordered_map.hpp>">boost/unordered_map.hpp</a>> 36 37</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> Mapped<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">Key</span><span class="special">></span><span class="special">,</span> 38 <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">Key</span><span class="special">></span><span class="special">,</span> 39 <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">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">Key</span> <span class="keyword">const</span><span class="special">,</span> <span class="identifier">Mapped</span><span class="special">>></span> <span class="special">></span> 40<span class="keyword">class</span> <a class="link" href="unordered_multimap.html" title="Class template unordered_multimap">unordered_multimap</a> <span class="special">{</span> 41<span class="keyword">public</span><span class="special">:</span> 42 <span class="comment">// <a class="link" href="unordered_multimap.html#boost.unordered_multimaptypes">types</a></span> 43 <span class="keyword">typedef</span> <span class="identifier">Key</span> <a name="boost.unordered_multimap.key_type"></a><span class="identifier">key_type</span><span class="special">;</span> 44 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">Key</span> <span class="keyword">const</span><span class="special">,</span> <span class="identifier">Mapped</span><span class="special">></span> <a name="boost.unordered_multimap.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> 45 <span class="keyword">typedef</span> <span class="identifier">Mapped</span> <a name="boost.unordered_multimap.mapped_type"></a><span class="identifier">mapped_type</span><span class="special">;</span> 46 <span class="keyword">typedef</span> <span class="identifier">Hash</span> <a name="boost.unordered_multimap.hasher"></a><span class="identifier">hasher</span><span class="special">;</span> 47 <span class="keyword">typedef</span> <span class="identifier">Pred</span> <a name="boost.unordered_multimap.key_equal"></a><span class="identifier">key_equal</span><span class="special">;</span> 48 <span class="keyword">typedef</span> <span class="identifier">Alloc</span> <a name="boost.unordered_multimap.allocator_type"></a><span class="identifier">allocator_type</span><span class="special">;</span> 49 <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_multimap.html#boost.unordered_multimap.pointer"><span class="identifier">pointer</span></a><span class="special">;</span> 50 <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_multimap.html#boost.unordered_multimap.const_pointer"><span class="identifier">const_pointer</span></a><span class="special">;</span> 51 <span class="keyword">typedef</span> <span class="identifier">value_type</span><span class="special">&</span> <a name="boost.unordered_multimap.reference"></a><span class="identifier">reference</span><span class="special">;</span> <span class="comment">// lvalue of value_type.</span> 52 <span class="keyword">typedef</span> <span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <a name="boost.unordered_multimap.const_reference"></a><span class="identifier">const_reference</span><span class="special">;</span> <span class="comment">// const lvalue of value_type.</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_multimap.html#boost.unordered_multimap.size_type"><span class="identifier">size_type</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_multimap.html#boost.unordered_multimap.difference_type"><span class="identifier">difference_type</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_multimap.html#boost.unordered_multimap.iterator"><span class="identifier">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_multimap.html#boost.unordered_multimap.const_iterator"><span class="identifier">const_iterator</span></a><span class="special">;</span> 57 <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_multimap.html#boost.unordered_multimap.local_iterator"><span class="identifier">local_iterator</span></a><span class="special">;</span> 58 <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_multimap.html#boost.unordered_multimap.const_local_iterator"><span class="identifier">const_local_iterator</span></a><span class="special">;</span> 59 <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_multimap.html#boost.unordered_multimap.node_type"><span class="identifier">node_type</span></a><span class="special">;</span> 60 61 <span class="comment">// <a class="link" href="unordered_multimap.html#boost.unordered_multimapconstruct-copy-destruct">construct/copy/destruct</a></span> 62 <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_21-bb"><span class="identifier">unordered_multimap</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 63 <span class="keyword">explicit</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_22-bb"><span class="identifier">unordered_multimap</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <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> 64 <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> 65 <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> 66 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../InputIterator.html" title="Concept InputIterator">InputIterator</a><span class="special">></span> 67 <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_23-bb"><span class="identifier">unordered_multimap</span></a><span class="special">(</span><span class="identifier">InputIterator</span><span class="special">,</span> <span class="identifier">InputIterator</span><span class="special">,</span> 68 <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> 69 <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> 70 <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> 71 <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> 72 <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_24-bb"><span class="identifier">unordered_multimap</span></a><span class="special">(</span><span class="identifier">unordered_multimap</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span> 73 <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_25-bb"><span class="identifier">unordered_multimap</span></a><span class="special">(</span><span class="identifier">unordered_multimap</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> 74 <span class="keyword">explicit</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_26-bb"><span class="identifier">unordered_multimap</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> 75 <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_27-bb"><span class="identifier">unordered_multimap</span></a><span class="special">(</span><span class="identifier">unordered_multimap</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> 76 <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_28-bb"><span class="identifier">unordered_multimap</span></a><span class="special">(</span><span class="identifier">unordered_multimap</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> 77 <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_29-bb"><span class="identifier">unordered_multimap</span></a><span class="special">(</span><span class="identifier">initializer_list</span><span class="special"><</span><span class="identifier">value_type</span><span class="special">></span><span class="special">,</span> 78 <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> 79 <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> 80 <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> 81 <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> 82 <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_30-bb"><span class="identifier">unordered_multimap</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">allocator_type</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span> 83 <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_31-bb"><span class="identifier">unordered_multimap</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">hasher</span> <span class="keyword">const</span><span class="special">&</span><span class="special">,</span> <span class="identifier">allocator_type</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span> 84 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../InputIterator.html" title="Concept InputIterator">InputIterator</a><span class="special">></span> 85 <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_32-bb"><span class="identifier">unordered_multimap</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="identifier">size_type</span><span class="special">,</span> 86 <span class="identifier">allocator_type</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span> 87 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../InputIterator.html" title="Concept InputIterator">InputIterator</a><span class="special">></span> 88 <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_33-bb"><span class="identifier">unordered_multimap</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="identifier">size_type</span><span class="special">,</span> <span class="identifier">hasher</span> <span class="keyword">const</span><span class="special">&</span><span class="special">,</span> 89 <span class="identifier">allocator_type</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span> 90 <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_34-bb"><span class="special">~</span><span class="identifier">unordered_multimap</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 91 <span class="identifier">unordered_multimap</span><span class="special">&</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_35-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">unordered_multimap</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span> 92 <span class="identifier">unordered_multimap</span><span class="special">&</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_36-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">unordered_multimap</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> 93 <span class="identifier">unordered_multimap</span><span class="special">&</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_37-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">initializer_list</span><span class="special"><</span><span class="identifier">value_type</span><span class="special">></span><span class="special">)</span><span class="special">;</span> 94 <span class="identifier">allocator_type</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_38-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> 95 96 <span class="comment">// <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_39-bb">size and capacity</a></span> 97 <span class="keyword">bool</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_39_1-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 98 <span class="identifier">size_type</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_39_2-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 99 <span class="identifier">size_type</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_39_3-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> 100 101 <span class="comment">// <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_40-bb">iterators</a></span> 102 <span class="identifier">iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_40_1_1-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 103 <span class="identifier">const_iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_40_1_2-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 104 <span class="identifier">iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_40_2_1-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 105 <span class="identifier">const_iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_40_2_2-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 106 <span class="identifier">const_iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_40_3-bb"><span class="identifier">cbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 107 <span class="identifier">const_iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_40_4-bb"><span class="identifier">cend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 108 109 <span class="comment">// <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41-bb">modifiers</a></span> 110 <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_multimap.html#id-1_3_45_10_2_1_2_41_1-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> 111 <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_multimap.html#id-1_3_45_10_2_1_2_41_2-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> 112 <span class="identifier">iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_3-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> 113 <span class="identifier">iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_4-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> 114 <span class="identifier">iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_5-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> 115 <span class="identifier">iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_6-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> 116 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../InputIterator.html" title="Concept InputIterator">InputIterator</a><span class="special">></span> <span class="keyword">void</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_7-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> 117 <span class="keyword">void</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_8-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">initializer_list</span><span class="special"><</span><span class="identifier">value_type</span><span class="special">></span><span class="special">)</span><span class="special">;</span> 118 <span class="keyword">void</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_9-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">initializer_list</span><span class="special"><</span><span class="identifier">value_type</span><span class="special">></span><span class="special">)</span><span class="special">;</span> 119 <span class="identifier">node_type</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_10-bb"><span class="identifier">extract</span></a><span class="special">(</span><span class="identifier">const_iterator</span><span class="special">)</span><span class="special">;</span> 120 <span class="identifier">node_type</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_11-bb"><span class="identifier">extract</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> 121 <span class="identifier">iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_12-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">node_type</span><span class="special">&&</span><span class="special">)</span><span class="special">;</span> 122 <span class="identifier">iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_13-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">const_iterator</span><span class="special">,</span> <span class="identifier">node_type</span><span class="special">&&</span><span class="special">)</span><span class="special">;</span> 123 <span class="identifier">iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_14-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> 124 <span class="identifier">size_type</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_15-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> 125 <span class="identifier">iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_16-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> 126 <span class="keyword">void</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_17-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> 127 <span class="keyword">void</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_18-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> 128 <span class="keyword">void</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_19-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 129 <span class="keyword">void</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_20-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">unordered_multimap</span><span class="special">&</span><span class="special">)</span><span class="special">;</span> 130 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> H2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">></span> 131 <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_21-bb"><span class="identifier">merge</span></a><span class="special">(</span><span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</span><span class="special">,</span> <span class="identifier">H2</span><span class="special">,</span> <span class="identifier">P2</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> 132 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> H2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">></span> 133 <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_41_22-bb"><span class="identifier">merge</span></a><span class="special">(</span><span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</span><span class="special">,</span> <span class="identifier">H2</span><span class="special">,</span> <span class="identifier">P2</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> 134 135 <span class="comment">// <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_42-bb">observers</a></span> 136 <span class="identifier">hasher</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_42_1-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> 137 <span class="identifier">key_equal</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_42_2-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> 138 139 <span class="comment">// <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_43-bb">lookup</a></span> 140 <span class="identifier">iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_43_1_1-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> 141 <span class="identifier">const_iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_43_1_2-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> 142 <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> 143 <span class="keyword">typename</span> CompatiblePredicate<span class="special">></span> 144 <span class="identifier">iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_43_1_3-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> 145 <span class="identifier">CompatiblePredicate</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span> 146 <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> 147 <span class="keyword">typename</span> CompatiblePredicate<span class="special">></span> 148 <span class="identifier">const_iterator</span> 149 <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_43_1_4-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> 150 <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> 151 <span class="identifier">size_type</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_43_2-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> 152 <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_multimap.html#id-1_3_45_10_2_1_2_43_3_1-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> 153 <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_multimap.html#id-1_3_45_10_2_1_2_43_3_2-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> 154 155 <span class="comment">// <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_44-bb">bucket interface</a></span> 156 <span class="identifier">size_type</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_44_1-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> 157 <span class="identifier">size_type</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_44_2-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> 158 <span class="identifier">size_type</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_44_3-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> 159 <span class="identifier">size_type</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_44_4-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> 160 <span class="identifier">local_iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_44_5_1-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> 161 <span class="identifier">const_local_iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_44_5_2-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> 162 <span class="identifier">local_iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_44_6_1-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> 163 <span class="identifier">const_local_iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_44_6_2-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> 164 <span class="identifier">const_local_iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_44_7-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> 165 <span class="identifier">const_local_iterator</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_44_8-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> 166 167 <span class="comment">// <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_45-bb">hash policy</a></span> 168 <span class="keyword">float</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_45_1-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> 169 <span class="keyword">float</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_45_2-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> 170 <span class="keyword">void</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_45_3-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> 171 <span class="keyword">void</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_45_4-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> 172 <span class="keyword">void</span> <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_45_5-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> 173<span class="special">}</span><span class="special">;</span> 174 175<span class="comment">// <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_46-bb">Equality Comparisons</a></span> 176<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> Mapped<span class="special">,</span> <span class="keyword">typename</span> Hash<span class="special">,</span> <span class="keyword">typename</span> Pred<span class="special">,</span> 177 <span class="keyword">typename</span> Alloc<span class="special">></span> 178 <span class="keyword">bool</span> <a class="link" href="unordered_multimap.html#boost.unordered_multimap.operator=="><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</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> 179 <span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</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> 180<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> Mapped<span class="special">,</span> <span class="keyword">typename</span> Hash<span class="special">,</span> <span class="keyword">typename</span> Pred<span class="special">,</span> 181 <span class="keyword">typename</span> Alloc<span class="special">></span> 182 <span class="keyword">bool</span> <a class="link" href="unordered_multimap.html#boost.unordered_multimap.operator!="><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</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> 183 <span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</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> 184 185<span class="comment">// <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_47-bb">swap</a></span> 186<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> Mapped<span class="special">,</span> <span class="keyword">typename</span> Hash<span class="special">,</span> <span class="keyword">typename</span> Pred<span class="special">,</span> 187 <span class="keyword">typename</span> Alloc<span class="special">></span> 188 <span class="keyword">void</span> <a class="link" href="unordered_multimap.html#boost.unordered_multimap.swap"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</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> 189 <span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</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> 190<div class="refsect1"> 191<a name="id-1.3.45.10.3.5.4"></a><h2>Description</h2> 192<p><span class="bold"><strong>Template Parameters</strong></span> 193 </p> 194<div class="informaltable"><table class="table"> 195<colgroup> 196<col> 197<col> 198</colgroup> 199<tbody> 200<tr> 201<td><span class="emphasis"><em>Key</em></span></td> 202<td> 203<code class="computeroutput">Key</code> must be <code class="computeroutput">Erasable</code> from the container 204 (i.e. <code class="computeroutput">allocator_traits</code> can <code class="computeroutput">destroy</code> it). 205 </td> 206</tr> 207<tr> 208<td><span class="emphasis"><em>Mapped</em></span></td> 209<td> 210<code class="computeroutput">Mapped</code> must be <code class="computeroutput">Erasable</code> from the container 211 (i.e. <code class="computeroutput">allocator_traits</code> can <code class="computeroutput">destroy</code> it). 212 </td> 213</tr> 214<tr> 215<td><span class="emphasis"><em>Hash</em></span></td> 216<td>A unary function object type that acts a hash function for a <code class="computeroutput">Key</code>. It takes a single argument of type <code class="computeroutput">Key</code> and returns a value of type std::size_t.</td> 217</tr> 218<tr> 219<td><span class="emphasis"><em>Pred</em></span></td> 220<td>A binary function object that implements an equivalence relation on values of type <code class="computeroutput">Key</code>. 221 A binary function object that induces an equivalence relation on values of type <code class="computeroutput">Key</code>. 222 It takes two arguments of type <code class="computeroutput">Key</code> and returns a value of type bool.</td> 223</tr> 224<tr> 225<td><span class="emphasis"><em>Alloc</em></span></td> 226<td>An allocator whose value type is the same as the container's value type.</td> 227</tr> 228</tbody> 229</table></div> 230<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> 231<p>The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash.</p> 232<div class="refsect2"> 233<a name="id-1.3.45.10.3.5.4.5"></a><h3> 234<a name="boost.unordered_multimaptypes"></a><code class="computeroutput">unordered_multimap</code> 235 public 236 types</h3> 237<div class="orderedlist"><ol class="orderedlist" type="1"> 238<li class="listitem"> 239<p> 240<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_multimap.pointer"></a><span class="identifier">pointer</span><span class="special">;</span></p> 241<p> 242 <code class="computeroutput">value_type*</code> if 243 <code class="computeroutput">allocator_type::pointer</code> is not defined. 244 </p> 245</li> 246<li class="listitem"> 247<p> 248<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_multimap.const_pointer"></a><span class="identifier">const_pointer</span><span class="special">;</span></p> 249<p> 250 <code class="computeroutput">boost::pointer_to_other<pointer, value_type>::type</code> 251 if <code class="computeroutput">allocator_type::const_pointer</code> is not defined. 252 </p> 253</li> 254<li class="listitem"> 255<p> 256<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_multimap.size_type"></a><span class="identifier">size_type</span><span class="special">;</span></p> 257<p>An unsigned integral type.</p> 258<p>size_type can represent any non-negative value of difference_type.</p> 259</li> 260<li class="listitem"> 261<p> 262<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_multimap.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span></p> 263<p>A signed integral type.</p> 264<p>Is identical to the difference type of iterator and const_iterator.</p> 265</li> 266<li class="listitem"> 267<p> 268<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_multimap.iterator"></a><span class="identifier">iterator</span><span class="special">;</span></p> 269<p>An iterator whose value type is value_type. </p> 270<p>The iterator category is at least a forward iterator.</p> 271<p>Convertible to const_iterator.</p> 272</li> 273<li class="listitem"> 274<p> 275<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_multimap.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span></p> 276<p>A constant iterator whose value type is value_type. </p> 277<p>The iterator category is at least a forward iterator.</p> 278</li> 279<li class="listitem"> 280<p> 281<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_multimap.local_iterator"></a><span class="identifier">local_iterator</span><span class="special">;</span></p> 282<p>An iterator with the same value type, difference type and pointer and reference type as iterator.</p> 283<p>A local_iterator object can be used to iterate through a single bucket.</p> 284</li> 285<li class="listitem"> 286<p> 287<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_multimap.const_local_iterator"></a><span class="identifier">const_local_iterator</span><span class="special">;</span></p> 288<p>A constant iterator with the same value type, difference type and pointer and reference type as const_iterator.</p> 289<p>A const_local_iterator object can be used to iterate through a single bucket.</p> 290</li> 291<li class="listitem"> 292<p> 293<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_multimap.node_type"></a><span class="identifier">node_type</span><span class="special">;</span></p> 294<p>See node_handle_map for details.</p> 295</li> 296</ol></div> 297</div> 298<div class="refsect2"> 299<a name="id-1.3.45.10.3.5.4.6"></a><h3> 300<a name="boost.unordered_multimapconstruct-copy-destruct"></a><code class="computeroutput">unordered_multimap</code> 301 public 302 construct/copy/destruct</h3> 303<div class="orderedlist"><ol class="orderedlist" type="1"> 304<li class="listitem"> 305<pre class="literallayout"><a name="id-1_3_45_10_2_1_2_21-bb"></a><span class="identifier">unordered_multimap</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 306<p>Constructs an empty container using hasher() as the hash function, key_equal() as the key equality predicate, allocator_type() as the allocator and a maximum load factor of 1.0.</p> 307<div class="variablelist"><table border="0" class="variablelist compact"> 308<colgroup> 309<col align="left" valign="top"> 310<col> 311</colgroup> 312<tbody> 313<tr> 314<td><p><span class="term">Postconditions:</span></p></td> 315<td><code class="computeroutput"><a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_39_2-bb">size</a>() == 0</code></td> 316</tr> 317<tr> 318<td><p><span class="term">Requires:</span></p></td> 319<td><p>If the defaults are used, <code class="computeroutput">hasher</code>, <code class="computeroutput">key_equal</code> and 320 <code class="computeroutput">allocator_type</code> need to be <code class="computeroutput">DefaultConstructible</code>. 321 </p></td> 322</tr> 323</tbody> 324</table></div> 325</li> 326<li class="listitem"> 327<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_45_10_2_1_2_22-bb"></a><span class="identifier">unordered_multimap</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">,</span> <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> 328 <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> 329 <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> 330<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> 331<div class="variablelist"><table border="0" class="variablelist compact"> 332<colgroup> 333<col align="left" valign="top"> 334<col> 335</colgroup> 336<tbody> 337<tr> 338<td><p><span class="term">Postconditions:</span></p></td> 339<td><code class="computeroutput"><a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_39_2-bb">size</a>() == 0</code></td> 340</tr> 341<tr> 342<td><p><span class="term">Requires:</span></p></td> 343<td><p>If the defaults are used, <code class="computeroutput">hasher</code>, <code class="computeroutput">key_equal</code> and 344 <code class="computeroutput">allocator_type</code> need to be <code class="computeroutput">DefaultConstructible</code>. 345 </p></td> 346</tr> 347</tbody> 348</table></div> 349</li> 350<li class="listitem"> 351<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../InputIterator.html" title="Concept InputIterator">InputIterator</a><span class="special">></span> 352 <a name="id-1_3_45_10_2_1_2_23-bb"></a><span class="identifier">unordered_multimap</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> 353 <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> 354 <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> 355 <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> 356 <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> 357<p>Constructs an empty container with at least <code class="computeroutput">n</code> buckets, 358 using <code class="computeroutput">hf</code> as the hash function, 359 <code class="computeroutput">eq</code> as the key equality predicate, 360 <code class="computeroutput">a</code> as the allocator and a maximum load factor of 1.0 361 and inserts the elements from [f, l) into it. 362 </p> 363<div class="variablelist"><table border="0" class="variablelist compact"> 364<colgroup> 365<col align="left" valign="top"> 366<col> 367</colgroup> 368<tbody><tr> 369<td><p><span class="term">Requires:</span></p></td> 370<td><p>If the defaults are used, <code class="computeroutput">hasher</code>, <code class="computeroutput">key_equal</code> and 371 <code class="computeroutput">allocator_type</code> need to be <code class="computeroutput">DefaultConstructible</code>. 372 </p></td> 373</tr></tbody> 374</table></div> 375</li> 376<li class="listitem"> 377<pre class="literallayout"><a name="id-1_3_45_10_2_1_2_24-bb"></a><span class="identifier">unordered_multimap</span><span class="special">(</span><span class="identifier">unordered_multimap</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> 378<p>The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator.</p> 379<p>If <code class="computeroutput">Allocator::select_on_container_copy_construction</code> 380 exists and has the right signature, the allocator will be 381 constructed from its result.</p> 382<div class="variablelist"><table border="0" class="variablelist compact"> 383<colgroup> 384<col align="left" valign="top"> 385<col> 386</colgroup> 387<tbody><tr> 388<td><p><span class="term">Requires:</span></p></td> 389<td><p><code class="computeroutput">value_type</code> is copy constructible</p></td> 390</tr></tbody> 391</table></div> 392</li> 393<li class="listitem"> 394<pre class="literallayout"><a name="id-1_3_45_10_2_1_2_25-bb"></a><span class="identifier">unordered_multimap</span><span class="special">(</span><span class="identifier">unordered_multimap</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span></pre> 395<p>The move constructor.</p> 396<div class="variablelist"><table border="0" class="variablelist compact"> 397<colgroup> 398<col align="left" valign="top"> 399<col> 400</colgroup> 401<tbody> 402<tr> 403<td><p><span class="term">Notes:</span></p></td> 404<td><p>This is implemented using Boost.Move.</p></td> 405</tr> 406<tr> 407<td><p><span class="term">Requires:</span></p></td> 408<td> 409<p> 410 <code class="computeroutput">value_type</code> is move constructible. 411 </p> 412<p> 413 On compilers without rvalue reference support the 414 emulation does not support moving without calling 415 <code class="computeroutput">boost::move</code> if <code class="computeroutput">value_type</code> is 416 not copyable. So, for example, you can't return the 417 container from a function. 418 </p> 419</td> 420</tr> 421</tbody> 422</table></div> 423</li> 424<li class="listitem"> 425<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_45_10_2_1_2_26-bb"></a><span class="identifier">unordered_multimap</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> 426<p>Constructs an empty container, using allocator <code class="computeroutput">a</code>.</p> 427</li> 428<li class="listitem"> 429<pre class="literallayout"><a name="id-1_3_45_10_2_1_2_27-bb"></a><span class="identifier">unordered_multimap</span><span class="special">(</span><span class="identifier">unordered_multimap</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> 430<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> 431</li> 432<li class="listitem"> 433<pre class="literallayout"><a name="id-1_3_45_10_2_1_2_28-bb"></a><span class="identifier">unordered_multimap</span><span class="special">(</span><span class="identifier">unordered_multimap</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> 434<p>Construct a container moving <code class="computeroutput">x</code>'s contained elements, and having the hash function, predicate and maximum load factor, but using allocate <code class="computeroutput">a</code>.</p> 435<div class="variablelist"><table border="0" class="variablelist compact"> 436<colgroup> 437<col align="left" valign="top"> 438<col> 439</colgroup> 440<tbody> 441<tr> 442<td><p><span class="term">Notes:</span></p></td> 443<td><p>This is implemented using Boost.Move.</p></td> 444</tr> 445<tr> 446<td><p><span class="term">Requires:</span></p></td> 447<td><p> 448 <code class="computeroutput">value_type</code> is move insertable. 449 </p></td> 450</tr> 451</tbody> 452</table></div> 453</li> 454<li class="listitem"> 455<pre class="literallayout"><a name="id-1_3_45_10_2_1_2_29-bb"></a><span class="identifier">unordered_multimap</span><span class="special">(</span><span class="identifier">initializer_list</span><span class="special"><</span><span class="identifier">value_type</span><span class="special">></span> il<span class="special">,</span> 456 <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> 457 <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> 458 <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> 459 <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> 460<p>Constructs an empty container with at least <code class="computeroutput">n</code> buckets, 461 using <code class="computeroutput">hf</code> as the hash function, 462 <code class="computeroutput">eq</code> as the key equality predicate, 463 <code class="computeroutput">a</code> as the allocator and a maximum load factor of 1.0 464 and inserts the elements from <code class="computeroutput">il</code> into it. 465 </p> 466<div class="variablelist"><table border="0" class="variablelist compact"> 467<colgroup> 468<col align="left" valign="top"> 469<col> 470</colgroup> 471<tbody><tr> 472<td><p><span class="term">Requires:</span></p></td> 473<td><p>If the defaults are used, <code class="computeroutput">hasher</code>, <code class="computeroutput">key_equal</code> and 474 <code class="computeroutput">allocator_type</code> need to be <code class="computeroutput">DefaultConstructible</code>. 475 </p></td> 476</tr></tbody> 477</table></div> 478</li> 479<li class="listitem"> 480<pre class="literallayout"><a name="id-1_3_45_10_2_1_2_30-bb"></a><span class="identifier">unordered_multimap</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">,</span> <span class="identifier">allocator_type</span> <span class="keyword">const</span><span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre> 481<p>Constructs an empty container with at least <code class="computeroutput">n</code> buckets, 482 using <code class="computeroutput">hf</code> as the hash function, 483 the default hash function and key equality predicate, 484 <code class="computeroutput">a</code> as the allocator and a maximum load factor of 1.0.</p> 485<div class="variablelist"><table border="0" class="variablelist compact"> 486<colgroup> 487<col align="left" valign="top"> 488<col> 489</colgroup> 490<tbody> 491<tr> 492<td><p><span class="term">Postconditions:</span></p></td> 493<td><code class="computeroutput"><a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_39_2-bb">size</a>() == 0</code></td> 494</tr> 495<tr> 496<td><p><span class="term">Requires:</span></p></td> 497<td><p><code class="computeroutput">hasher</code> and <code class="computeroutput">key_equal</code> need to be <code class="computeroutput">DefaultConstructible</code>. 498 </p></td> 499</tr> 500</tbody> 501</table></div> 502</li> 503<li class="listitem"> 504<pre class="literallayout"><a name="id-1_3_45_10_2_1_2_31-bb"></a><span class="identifier">unordered_multimap</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">,</span> <span class="identifier">hasher</span> <span class="keyword">const</span><span class="special">&</span> hf<span class="special">,</span> <span class="identifier">allocator_type</span> <span class="keyword">const</span><span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre> 505<p>Constructs an empty container with at least <code class="computeroutput">n</code> buckets, 506 using <code class="computeroutput">hf</code> as the hash function, 507 the default key equality predicate, 508 <code class="computeroutput">a</code> as the allocator and a maximum load factor of 1.0.</p> 509<div class="variablelist"><table border="0" class="variablelist compact"> 510<colgroup> 511<col align="left" valign="top"> 512<col> 513</colgroup> 514<tbody> 515<tr> 516<td><p><span class="term">Postconditions:</span></p></td> 517<td><code class="computeroutput"><a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_39_2-bb">size</a>() == 0</code></td> 518</tr> 519<tr> 520<td><p><span class="term">Requires:</span></p></td> 521<td><p><code class="computeroutput">key_equal</code> needs to be <code class="computeroutput">DefaultConstructible</code>. 522 </p></td> 523</tr> 524</tbody> 525</table></div> 526</li> 527<li class="listitem"> 528<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../InputIterator.html" title="Concept InputIterator">InputIterator</a><span class="special">></span> 529 <a name="id-1_3_45_10_2_1_2_32-bb"></a><span class="identifier">unordered_multimap</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> <span class="identifier">size_type</span> n<span class="special">,</span> 530 <span class="identifier">allocator_type</span> <span class="keyword">const</span><span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre> 531<p>Constructs an empty container with at least <code class="computeroutput">n</code> buckets, 532 using <code class="computeroutput">a</code> as the allocator, with the 533 default hash function and key equality predicate 534 and a maximum load factor of 1.0 535 and inserts the elements from [f, l) into it. 536 </p> 537<div class="variablelist"><table border="0" class="variablelist compact"> 538<colgroup> 539<col align="left" valign="top"> 540<col> 541</colgroup> 542<tbody><tr> 543<td><p><span class="term">Requires:</span></p></td> 544<td><p><code class="computeroutput">hasher</code>, <code class="computeroutput">key_equal</code> need to be <code class="computeroutput">DefaultConstructible</code>. 545 </p></td> 546</tr></tbody> 547</table></div> 548</li> 549<li class="listitem"> 550<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../InputIterator.html" title="Concept InputIterator">InputIterator</a><span class="special">></span> 551 <a name="id-1_3_45_10_2_1_2_33-bb"></a><span class="identifier">unordered_multimap</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> <span class="identifier">size_type</span> n<span class="special">,</span> 552 <span class="identifier">hasher</span> <span class="keyword">const</span><span class="special">&</span> hf<span class="special">,</span> <span class="identifier">allocator_type</span> <span class="keyword">const</span><span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre> 553<p>Constructs an empty container with at least <code class="computeroutput">n</code> buckets, 554 using <code class="computeroutput">hf</code> as the hash function, 555 <code class="computeroutput">a</code> as the allocator, with the 556 default key equality predicate 557 and a maximum load factor of 1.0 558 and inserts the elements from [f, l) into it. 559 </p> 560<div class="variablelist"><table border="0" class="variablelist compact"> 561<colgroup> 562<col align="left" valign="top"> 563<col> 564</colgroup> 565<tbody><tr> 566<td><p><span class="term">Requires:</span></p></td> 567<td><p><code class="computeroutput">key_equal</code> needs to be <code class="computeroutput">DefaultConstructible</code>. 568 </p></td> 569</tr></tbody> 570</table></div> 571</li> 572<li class="listitem"> 573<pre class="literallayout"><a name="id-1_3_45_10_2_1_2_34-bb"></a><span class="special">~</span><span class="identifier">unordered_multimap</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 574<div class="variablelist"><table border="0" class="variablelist compact"> 575<colgroup> 576<col align="left" valign="top"> 577<col> 578</colgroup> 579<tbody><tr> 580<td><p><span class="term">Notes:</span></p></td> 581<td><p>The destructor is applied to every element, and all memory is deallocated</p></td> 582</tr></tbody> 583</table></div> 584</li> 585</ol></div> 586</div> 587<pre class="literallayout"><span class="identifier">unordered_multimap</span><span class="special">&</span> <a name="id-1_3_45_10_2_1_2_35-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">unordered_multimap</span> <span class="keyword">const</span><span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> 588<p>The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator.</p> 589<p>If <code class="computeroutput">Alloc::propagate_on_container_copy_assignment</code> 590 exists and <code class="computeroutput">Alloc::propagate_on_container_copy_assignment::value 591 </code> is true, the allocator is overwritten, if not the 592 copied elements are created using the existing 593 allocator.</p> 594<div class="variablelist"><table border="0" class="variablelist compact"> 595<colgroup> 596<col align="left" valign="top"> 597<col> 598</colgroup> 599<tbody><tr> 600<td><p><span class="term">Requires:</span></p></td> 601<td><p><code class="computeroutput">value_type</code> is copy constructible</p></td> 602</tr></tbody> 603</table></div> 604<pre class="literallayout"><span class="identifier">unordered_multimap</span><span class="special">&</span> <a name="id-1_3_45_10_2_1_2_36-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">unordered_multimap</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span></pre> 605<p>The move assignment operator.</p> 606<p>If <code class="computeroutput">Alloc::propagate_on_container_move_assignment</code> 607 exists and <code class="computeroutput">Alloc::propagate_on_container_move_assignment::value 608 </code> is true, the allocator is overwritten, if not the 609 moved elements are created using the existing 610 allocator.</p> 611<div class="variablelist"><table border="0" class="variablelist compact"> 612<colgroup> 613<col align="left" valign="top"> 614<col> 615</colgroup> 616<tbody> 617<tr> 618<td><p><span class="term">Notes:</span></p></td> 619<td><p> 620 On compilers without rvalue references, this is emulated using 621 Boost.Move. Note that on some compilers the copy assignment 622 operator may be used in some circumstances. 623 </p></td> 624</tr> 625<tr> 626<td><p><span class="term">Requires:</span></p></td> 627<td><p> 628 <code class="computeroutput">value_type</code> is move constructible. 629 </p></td> 630</tr> 631</tbody> 632</table></div> 633<pre class="literallayout"><span class="identifier">unordered_multimap</span><span class="special">&</span> <a name="id-1_3_45_10_2_1_2_37-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">initializer_list</span><span class="special"><</span><span class="identifier">value_type</span><span class="special">></span><span class="special">)</span><span class="special">;</span></pre> 634<p>Assign from values in initializer list. All existing elements are either overwritten by the new elements or destroyed.</p> 635<div class="variablelist"><table border="0" class="variablelist compact"> 636<colgroup> 637<col align="left" valign="top"> 638<col> 639</colgroup> 640<tbody><tr> 641<td><p><span class="term">Requires:</span></p></td> 642<td><p> 643 <code class="computeroutput">value_type</code> is <code class="computeroutput">CopyInsertable</code> into the container and 644 <code class="computeroutput">CopyAssignable</code>. 645 </p></td> 646</tr></tbody> 647</table></div> 648<pre class="literallayout"><span class="identifier">allocator_type</span> <a name="id-1_3_45_10_2_1_2_38-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> 649<div class="refsect2"> 650<a name="id-1.3.45.10.3.5.4.19"></a><h3> 651<a name="id-1_3_45_10_2_1_2_39-bb"></a><code class="computeroutput">unordered_multimap</code> size and capacity</h3> 652<div class="orderedlist"><ol class="orderedlist" type="1"> 653<li class="listitem"> 654<pre class="literallayout"><span class="keyword">bool</span> <a name="id-1_3_45_10_2_1_2_39_1-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> 655<div class="variablelist"><table border="0" class="variablelist compact"> 656<colgroup> 657<col align="left" valign="top"> 658<col> 659</colgroup> 660<tbody><tr> 661<td><p><span class="term">Returns:</span></p></td> 662<td><code class="computeroutput"><a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_39_2-bb">size</a>() == 0</code></td> 663</tr></tbody> 664</table></div> 665</li> 666<li class="listitem"> 667<pre class="literallayout"><span class="identifier">size_type</span> <a name="id-1_3_45_10_2_1_2_39_2-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> 668<div class="variablelist"><table border="0" class="variablelist compact"> 669<colgroup> 670<col align="left" valign="top"> 671<col> 672</colgroup> 673<tbody><tr> 674<td><p><span class="term">Returns:</span></p></td> 675<td><code class="computeroutput">std::distance(<a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_40_1-bb">begin</a>(), <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_40_2-bb">end</a>())</code></td> 676</tr></tbody> 677</table></div> 678</li> 679<li class="listitem"> 680<pre class="literallayout"><span class="identifier">size_type</span> <a name="id-1_3_45_10_2_1_2_39_3-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> 681<div class="variablelist"><table border="0" class="variablelist compact"> 682<colgroup> 683<col align="left" valign="top"> 684<col> 685</colgroup> 686<tbody><tr> 687<td><p><span class="term">Returns:</span></p></td> 688<td> 689<code class="computeroutput"><a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_39_2-bb">size</a>()</code> of the largest possible container. 690 </td> 691</tr></tbody> 692</table></div> 693</li> 694</ol></div> 695</div> 696<div class="refsect2"> 697<a name="id-1.3.45.10.3.5.4.20"></a><h3> 698<a name="id-1_3_45_10_2_1_2_40-bb"></a><code class="computeroutput">unordered_multimap</code> iterators</h3> 699<div class="orderedlist"><ol class="orderedlist" type="1"> 700<li class="listitem"> 701<pre class="literallayout"><a name="id-1_3_45_10_2_1_2_40_1-bb"></a><span class="identifier">iterator</span> <a name="id-1_3_45_10_2_1_2_40_1_1-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> 702<span class="identifier">const_iterator</span> <a name="id-1_3_45_10_2_1_2_40_1_2-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> 703<div class="variablelist"><table border="0" class="variablelist compact"> 704<colgroup> 705<col align="left" valign="top"> 706<col> 707</colgroup> 708<tbody><tr> 709<td><p><span class="term">Returns:</span></p></td> 710<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. 711 </td> 712</tr></tbody> 713</table></div> 714</li> 715<li class="listitem"> 716<pre class="literallayout"><a name="id-1_3_45_10_2_1_2_40_2-bb"></a><span class="identifier">iterator</span> <a name="id-1_3_45_10_2_1_2_40_2_1-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> 717<span class="identifier">const_iterator</span> <a name="id-1_3_45_10_2_1_2_40_2_2-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> 718<div class="variablelist"><table border="0" class="variablelist compact"> 719<colgroup> 720<col align="left" valign="top"> 721<col> 722</colgroup> 723<tbody><tr> 724<td><p><span class="term">Returns:</span></p></td> 725<td>An iterator which refers to the past-the-end value for the container. 726 </td> 727</tr></tbody> 728</table></div> 729</li> 730<li class="listitem"> 731<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="id-1_3_45_10_2_1_2_40_3-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> 732<div class="variablelist"><table border="0" class="variablelist compact"> 733<colgroup> 734<col align="left" valign="top"> 735<col> 736</colgroup> 737<tbody><tr> 738<td><p><span class="term">Returns:</span></p></td> 739<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. 740 </td> 741</tr></tbody> 742</table></div> 743</li> 744<li class="listitem"> 745<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="id-1_3_45_10_2_1_2_40_4-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> 746<div class="variablelist"><table border="0" class="variablelist compact"> 747<colgroup> 748<col align="left" valign="top"> 749<col> 750</colgroup> 751<tbody><tr> 752<td><p><span class="term">Returns:</span></p></td> 753<td>A constant iterator which refers to the past-the-end value for the container. 754 </td> 755</tr></tbody> 756</table></div> 757</li> 758</ol></div> 759</div> 760<div class="refsect2"> 761<a name="id-1.3.45.10.3.5.4.21"></a><h3> 762<a name="id-1_3_45_10_2_1_2_41-bb"></a><code class="computeroutput">unordered_multimap</code> modifiers</h3> 763<div class="orderedlist"><ol class="orderedlist" type="1"> 764<li class="listitem"> 765<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="id-1_3_45_10_2_1_2_41_1-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> 766<p>Inserts an object, constructed with the arguments <code class="computeroutput">args</code>, in the container.</p> 767<div class="variablelist"><table border="0" class="variablelist compact"> 768<colgroup> 769<col align="left" valign="top"> 770<col> 771</colgroup> 772<tbody> 773<tr> 774<td><p><span class="term">Requires:</span></p></td> 775<td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">EmplaceConstructible</code> into 776 <code class="computeroutput">X</code> from <code class="computeroutput">args</code>. 777 </p></td> 778</tr> 779<tr> 780<td><p><span class="term">Returns:</span></p></td> 781<td><p>An iterator pointing to the inserted element.</p></td> 782</tr> 783<tr> 784<td><p><span class="term">Throws:</span></p></td> 785<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> 786</tr> 787<tr> 788<td><p><span class="term">Notes:</span></p></td> 789<td> 790<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> 791<p>Pointers and references to elements are never invalidated.</p> 792<p>If the compiler doesn't support variadic template arguments or rvalue 793 references, this is emulated for up to 10 arguments, with no support 794 for rvalue references or move semantics.</p> 795<p>Since existing <code class="computeroutput">std::pair</code> implementations don't support 796 <code class="computeroutput">std::piecewise_construct</code> this emulates it, 797 but using <code class="computeroutput">boost::unordered::piecewise_construct</code>.</p> 798</td> 799</tr> 800</tbody> 801</table></div> 802</li> 803<li class="listitem"> 804<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> 805 <span class="identifier">iterator</span> <a name="id-1_3_45_10_2_1_2_41_2-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> 806<p>Inserts an object, constructed with the arguments <code class="computeroutput">args</code>, in the container.</p> 807<p><code class="computeroutput">hint</code> is a suggestion to where the element should be inserted.</p> 808<div class="variablelist"><table border="0" class="variablelist compact"> 809<colgroup> 810<col align="left" valign="top"> 811<col> 812</colgroup> 813<tbody> 814<tr> 815<td><p><span class="term">Requires:</span></p></td> 816<td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">EmplaceConstructible</code> into 817 <code class="computeroutput">X</code> from <code class="computeroutput">args</code>. 818 </p></td> 819</tr> 820<tr> 821<td><p><span class="term">Returns:</span></p></td> 822<td><p>An iterator pointing to the inserted element.</p></td> 823</tr> 824<tr> 825<td><p><span class="term">Throws:</span></p></td> 826<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> 827</tr> 828<tr> 829<td><p><span class="term">Notes:</span></p></td> 830<td> 831<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 key. </p> 832<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> 833<p>Pointers and references to elements are never invalidated.</p> 834<p>If the compiler doesn't support variadic template arguments or rvalue 835 references, this is emulated for up to 10 arguments, with no support 836 for rvalue references or move semantics.</p> 837<p>Since existing <code class="computeroutput">std::pair</code> implementations don't support 838 <code class="computeroutput">std::piecewise_construct</code> this emulates it, 839 but using <code class="computeroutput">boost::unordered::piecewise_construct</code>.</p> 840</td> 841</tr> 842</tbody> 843</table></div> 844</li> 845<li class="listitem"> 846<pre class="literallayout"><span class="identifier">iterator</span> <a name="id-1_3_45_10_2_1_2_41_3-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> 847<p>Inserts <code class="computeroutput">obj</code> in the container.</p> 848<div class="variablelist"><table border="0" class="variablelist compact"> 849<colgroup> 850<col align="left" valign="top"> 851<col> 852</colgroup> 853<tbody> 854<tr> 855<td><p><span class="term">Requires:</span></p></td> 856<td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">CopyInsertable</code>.</p></td> 857</tr> 858<tr> 859<td><p><span class="term">Returns:</span></p></td> 860<td><p>An iterator pointing to the inserted element.</p></td> 861</tr> 862<tr> 863<td><p><span class="term">Throws:</span></p></td> 864<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> 865</tr> 866<tr> 867<td><p><span class="term">Notes:</span></p></td> 868<td> 869<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> 870<p>Pointers and references to elements are never invalidated.</p> 871</td> 872</tr> 873</tbody> 874</table></div> 875</li> 876<li class="listitem"> 877<pre class="literallayout"><span class="identifier">iterator</span> <a name="id-1_3_45_10_2_1_2_41_4-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> 878<p>Inserts <code class="computeroutput">obj</code> in the container.</p> 879<div class="variablelist"><table border="0" class="variablelist compact"> 880<colgroup> 881<col align="left" valign="top"> 882<col> 883</colgroup> 884<tbody> 885<tr> 886<td><p><span class="term">Requires:</span></p></td> 887<td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">MoveInsertable</code>.</p></td> 888</tr> 889<tr> 890<td><p><span class="term">Returns:</span></p></td> 891<td><p>An iterator pointing to the inserted element.</p></td> 892</tr> 893<tr> 894<td><p><span class="term">Throws:</span></p></td> 895<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> 896</tr> 897<tr> 898<td><p><span class="term">Notes:</span></p></td> 899<td> 900<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> 901<p>Pointers and references to elements are never invalidated.</p> 902</td> 903</tr> 904</tbody> 905</table></div> 906</li> 907<li class="listitem"> 908<pre class="literallayout"><span class="identifier">iterator</span> <a name="id-1_3_45_10_2_1_2_41_5-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> 909<p>Inserts <code class="computeroutput">obj</code> in the container.</p> 910<p>hint is a suggestion to where the element should be inserted.</p> 911<div class="variablelist"><table border="0" class="variablelist compact"> 912<colgroup> 913<col align="left" valign="top"> 914<col> 915</colgroup> 916<tbody> 917<tr> 918<td><p><span class="term">Requires:</span></p></td> 919<td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">CopyInsertable</code>.</p></td> 920</tr> 921<tr> 922<td><p><span class="term">Returns:</span></p></td> 923<td><p>An iterator pointing to the inserted element.</p></td> 924</tr> 925<tr> 926<td><p><span class="term">Throws:</span></p></td> 927<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> 928</tr> 929<tr> 930<td><p><span class="term">Notes:</span></p></td> 931<td> 932<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 key. </p> 933<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> 934<p>Pointers and references to elements are never invalidated.</p> 935</td> 936</tr> 937</tbody> 938</table></div> 939</li> 940<li class="listitem"> 941<pre class="literallayout"><span class="identifier">iterator</span> <a name="id-1_3_45_10_2_1_2_41_6-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> 942<p>Inserts <code class="computeroutput">obj</code> in the container.</p> 943<p>hint is a suggestion to where the element should be inserted.</p> 944<div class="variablelist"><table border="0" class="variablelist compact"> 945<colgroup> 946<col align="left" valign="top"> 947<col> 948</colgroup> 949<tbody> 950<tr> 951<td><p><span class="term">Requires:</span></p></td> 952<td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">MoveInsertable</code>.</p></td> 953</tr> 954<tr> 955<td><p><span class="term">Returns:</span></p></td> 956<td><p>An iterator pointing to the inserted element.</p></td> 957</tr> 958<tr> 959<td><p><span class="term">Throws:</span></p></td> 960<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> 961</tr> 962<tr> 963<td><p><span class="term">Notes:</span></p></td> 964<td> 965<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 key. </p> 966<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> 967<p>Pointers and references to elements are never invalidated.</p> 968</td> 969</tr> 970</tbody> 971</table></div> 972</li> 973<li class="listitem"> 974<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../InputIterator.html" title="Concept InputIterator">InputIterator</a><span class="special">></span> 975 <span class="keyword">void</span> <a name="id-1_3_45_10_2_1_2_41_7-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> 976<p>Inserts a range of elements into the container. 977 </p> 978<div class="variablelist"><table border="0" class="variablelist compact"> 979<colgroup> 980<col align="left" valign="top"> 981<col> 982</colgroup> 983<tbody> 984<tr> 985<td><p><span class="term">Requires:</span></p></td> 986<td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">EmplaceConstructible</code> into 987 <code class="computeroutput">X</code> from <code class="computeroutput">*first</code>.</p></td> 988</tr> 989<tr> 990<td><p><span class="term">Throws:</span></p></td> 991<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> 992</tr> 993<tr> 994<td><p><span class="term">Notes:</span></p></td> 995<td> 996<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> 997<p>Pointers and references to elements are never invalidated.</p> 998</td> 999</tr> 1000</tbody> 1001</table></div> 1002</li> 1003<li class="listitem"> 1004<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_45_10_2_1_2_41_8-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">initializer_list</span><span class="special"><</span><span class="identifier">value_type</span><span class="special">></span> il<span class="special">)</span><span class="special">;</span></pre> 1005<p>Inserts a range of elements into the container. 1006 </p> 1007<div class="variablelist"><table border="0" class="variablelist compact"> 1008<colgroup> 1009<col align="left" valign="top"> 1010<col> 1011</colgroup> 1012<tbody> 1013<tr> 1014<td><p><span class="term">Requires:</span></p></td> 1015<td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">EmplaceConstructible</code> into 1016 <code class="computeroutput">X</code> from <code class="computeroutput">*first</code>.</p></td> 1017</tr> 1018<tr> 1019<td><p><span class="term">Throws:</span></p></td> 1020<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> 1021</tr> 1022<tr> 1023<td><p><span class="term">Notes:</span></p></td> 1024<td> 1025<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> 1026<p>Pointers and references to elements are never invalidated.</p> 1027</td> 1028</tr> 1029</tbody> 1030</table></div> 1031</li> 1032<li class="listitem"> 1033<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_45_10_2_1_2_41_9-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">initializer_list</span><span class="special"><</span><span class="identifier">value_type</span><span class="special">></span> il<span class="special">)</span><span class="special">;</span></pre> 1034<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 key.</p> 1035<div class="variablelist"><table border="0" class="variablelist compact"> 1036<colgroup> 1037<col align="left" valign="top"> 1038<col> 1039</colgroup> 1040<tbody> 1041<tr> 1042<td><p><span class="term">Requires:</span></p></td> 1043<td><p><code class="computeroutput">value_type</code> is <code class="computeroutput">EmplaceConstructible</code> into 1044 <code class="computeroutput">X</code> from <code class="computeroutput">*first</code>.</p></td> 1045</tr> 1046<tr> 1047<td><p><span class="term">Throws:</span></p></td> 1048<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> 1049</tr> 1050<tr> 1051<td><p><span class="term">Notes:</span></p></td> 1052<td> 1053<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> 1054<p>Pointers and references to elements are never invalidated.</p> 1055</td> 1056</tr> 1057</tbody> 1058</table></div> 1059</li> 1060<li class="listitem"> 1061<pre class="literallayout"><span class="identifier">node_type</span> <a name="id-1_3_45_10_2_1_2_41_10-bb"></a><span class="identifier">extract</span><span class="special">(</span><span class="identifier">const_iterator</span> position<span class="special">)</span><span class="special">;</span></pre> 1062<p>Removes the element pointed to by <code class="computeroutput">position</code>.</p> 1063<div class="variablelist"><table border="0" class="variablelist compact"> 1064<colgroup> 1065<col align="left" valign="top"> 1066<col> 1067</colgroup> 1068<tbody> 1069<tr> 1070<td><p><span class="term">Returns:</span></p></td> 1071<td><p>A <code class="computeroutput">node_type</code> owning the element.</p></td> 1072</tr> 1073<tr> 1074<td><p><span class="term">Notes:</span></p></td> 1075<td><p> 1076 In C++17 a node extracted using this method can be inserted into a compatible <code class="computeroutput">unordered_map</code>, 1077 but that is not supported yet. 1078 </p></td> 1079</tr> 1080</tbody> 1081</table></div> 1082</li> 1083<li class="listitem"> 1084<pre class="literallayout"><span class="identifier">node_type</span> <a name="id-1_3_45_10_2_1_2_41_11-bb"></a><span class="identifier">extract</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> 1085<p>Removes an element with key equivalent to <code class="computeroutput">k</code>.</p> 1086<div class="variablelist"><table border="0" class="variablelist compact"> 1087<colgroup> 1088<col align="left" valign="top"> 1089<col> 1090</colgroup> 1091<tbody> 1092<tr> 1093<td><p><span class="term">Returns:</span></p></td> 1094<td><p>A <code class="computeroutput">node_type</code> owning the element if found, otherwise an empty <code class="computeroutput">node_type</code>.</p></td> 1095</tr> 1096<tr> 1097<td><p><span class="term">Throws:</span></p></td> 1098<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> 1099</tr> 1100<tr> 1101<td><p><span class="term">Notes:</span></p></td> 1102<td><p> 1103 In C++17 a node extracted using this method can be inserted into a compatible <code class="computeroutput">unordered_map</code>, 1104 but that is not supported yet. 1105 </p></td> 1106</tr> 1107</tbody> 1108</table></div> 1109</li> 1110<li class="listitem"> 1111<pre class="literallayout"><span class="identifier">iterator</span> <a name="id-1_3_45_10_2_1_2_41_12-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">node_type</span><span class="special">&&</span> nh<span class="special">)</span><span class="special">;</span></pre> 1112<p>If <code class="computeroutput">nh</code> is empty, has no affect.</p> 1113<p>Otherwise inserts the element owned by <code class="computeroutput">nh</code></p> 1114<div class="variablelist"><table border="0" class="variablelist compact"> 1115<colgroup> 1116<col align="left" valign="top"> 1117<col> 1118</colgroup> 1119<tbody> 1120<tr> 1121<td><p><span class="term">Requires:</span></p></td> 1122<td><p><code class="computeroutput">nh</code> is empty or <code class="computeroutput">nh.get_allocator()</code> is equal to the container's allocator.</p></td> 1123</tr> 1124<tr> 1125<td><p><span class="term">Returns:</span></p></td> 1126<td> 1127<p>If <code class="computeroutput">nh</code> was empty, returns <code class="computeroutput">end()</code>.</p> 1128<p>Otherwise returns an iterator pointing to the newly inserted element.</p> 1129</td> 1130</tr> 1131<tr> 1132<td><p><span class="term">Throws:</span></p></td> 1133<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> 1134</tr> 1135<tr> 1136<td><p><span class="term">Notes:</span></p></td> 1137<td> 1138<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> 1139<p>Pointers and references to elements are never invalidated.</p> 1140<p>In C++17 this can be used to insert a node extracted from a compatible <code class="computeroutput">unordered_map</code>, 1141 but that is not supported yet.</p> 1142</td> 1143</tr> 1144</tbody> 1145</table></div> 1146</li> 1147<li class="listitem"> 1148<pre class="literallayout"><span class="identifier">iterator</span> <a name="id-1_3_45_10_2_1_2_41_13-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">node_type</span><span class="special">&&</span> nh<span class="special">)</span><span class="special">;</span></pre> 1149<p>If <code class="computeroutput">nh</code> is empty, has no affect.</p> 1150<p>Otherwise inserts the element owned by <code class="computeroutput">nh</code></p> 1151<p>hint is a suggestion to where the element should be inserted.</p> 1152<div class="variablelist"><table border="0" class="variablelist compact"> 1153<colgroup> 1154<col align="left" valign="top"> 1155<col> 1156</colgroup> 1157<tbody> 1158<tr> 1159<td><p><span class="term">Requires:</span></p></td> 1160<td><p><code class="computeroutput">nh</code> is empty or <code class="computeroutput">nh.get_allocator()</code> is equal to the container's allocator.</p></td> 1161</tr> 1162<tr> 1163<td><p><span class="term">Returns:</span></p></td> 1164<td> 1165<p>If <code class="computeroutput">nh</code> was empty, returns <code class="computeroutput">end()</code>.</p> 1166<p>Otherwise returns an iterator pointing to the newly inserted element.</p> 1167</td> 1168</tr> 1169<tr> 1170<td><p><span class="term">Throws:</span></p></td> 1171<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> 1172</tr> 1173<tr> 1174<td><p><span class="term">Notes:</span></p></td> 1175<td> 1176<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 key. </p> 1177<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> 1178<p>Pointers and references to elements are never invalidated.</p> 1179<p>In C++17 this can be used to insert a node extracted from a compatible <code class="computeroutput">unordered_map</code>, 1180 but that is not supported yet.</p> 1181</td> 1182</tr> 1183</tbody> 1184</table></div> 1185</li> 1186<li class="listitem"> 1187<pre class="literallayout"><span class="identifier">iterator</span> <a name="id-1_3_45_10_2_1_2_41_14-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> 1188<p>Erase the element pointed to by <code class="computeroutput">position</code>.</p> 1189<div class="variablelist"><table border="0" class="variablelist compact"> 1190<colgroup> 1191<col align="left" valign="top"> 1192<col> 1193</colgroup> 1194<tbody> 1195<tr> 1196<td><p><span class="term">Returns:</span></p></td> 1197<td><p>The iterator following <code class="computeroutput">position</code> before the erasure.</p></td> 1198</tr> 1199<tr> 1200<td><p><span class="term">Throws:</span></p></td> 1201<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> 1202</tr> 1203<tr> 1204<td><p><span class="term">Notes:</span></p></td> 1205<td><p> 1206 In older versions this could be inefficient because it had to search 1207 through several buckets to find the position of the returned iterator. 1208 The data structure has been changed so that this is no longer the case, 1209 and the alternative erase methods have been deprecated. 1210 </p></td> 1211</tr> 1212</tbody> 1213</table></div> 1214</li> 1215<li class="listitem"> 1216<pre class="literallayout"><span class="identifier">size_type</span> <a name="id-1_3_45_10_2_1_2_41_15-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> 1217<p>Erase all elements with key equivalent to <code class="computeroutput">k</code>.</p> 1218<div class="variablelist"><table border="0" class="variablelist compact"> 1219<colgroup> 1220<col align="left" valign="top"> 1221<col> 1222</colgroup> 1223<tbody> 1224<tr> 1225<td><p><span class="term">Returns:</span></p></td> 1226<td><p>The number of elements erased.</p></td> 1227</tr> 1228<tr> 1229<td><p><span class="term">Throws:</span></p></td> 1230<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> 1231</tr> 1232</tbody> 1233</table></div> 1234</li> 1235<li class="listitem"> 1236<pre class="literallayout"><span class="identifier">iterator</span> <a name="id-1_3_45_10_2_1_2_41_16-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> 1237<p>Erases the elements in the range from <code class="computeroutput">first</code> to <code class="computeroutput">last</code>.</p> 1238<div class="variablelist"><table border="0" class="variablelist compact"> 1239<colgroup> 1240<col align="left" valign="top"> 1241<col> 1242</colgroup> 1243<tbody> 1244<tr> 1245<td><p><span class="term">Returns:</span></p></td> 1246<td><p>The iterator following the erased elements - i.e. <code class="computeroutput">last</code>.</p></td> 1247</tr> 1248<tr> 1249<td><p><span class="term">Throws:</span></p></td> 1250<td> 1251<p>Only throws an exception if it is thrown by <code class="computeroutput">hasher</code> or <code class="computeroutput">key_equal</code>.</p> 1252<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> 1253</td> 1254</tr> 1255</tbody> 1256</table></div> 1257</li> 1258<li class="listitem"> 1259<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_45_10_2_1_2_41_17-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> 1260<p>Erase the element pointed to by <code class="computeroutput">position</code>.</p> 1261<div class="variablelist"><table border="0" class="variablelist compact"> 1262<colgroup> 1263<col align="left" valign="top"> 1264<col> 1265</colgroup> 1266<tbody> 1267<tr> 1268<td><p><span class="term">Throws:</span></p></td> 1269<td> 1270<p>Only throws an exception if it is thrown by <code class="computeroutput">hasher</code> or <code class="computeroutput">key_equal</code>.</p> 1271<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> 1272</td> 1273</tr> 1274<tr> 1275<td><p><span class="term">Notes:</span></p></td> 1276<td><p> 1277 This method was implemented because returning an iterator to 1278 the next element from <code class="computeroutput">erase</code> was expensive, but 1279 the container has been redesigned so that is no longer the 1280 case. So this method is now deprecated. 1281 </p></td> 1282</tr> 1283</tbody> 1284</table></div> 1285</li> 1286<li class="listitem"> 1287<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_45_10_2_1_2_41_18-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> 1288<p>Erase the element pointed to by <code class="computeroutput">position</code>.</p> 1289<div class="variablelist"><table border="0" class="variablelist compact"> 1290<colgroup> 1291<col align="left" valign="top"> 1292<col> 1293</colgroup> 1294<tbody> 1295<tr> 1296<td><p><span class="term">Throws:</span></p></td> 1297<td> 1298<p>Only throws an exception if it is thrown by <code class="computeroutput">hasher</code> or <code class="computeroutput">key_equal</code>.</p> 1299<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> 1300</td> 1301</tr> 1302<tr> 1303<td><p><span class="term">Notes:</span></p></td> 1304<td><p> 1305 This method was implemented because returning an iterator to 1306 the next element from <code class="computeroutput">erase</code> was expensive, but 1307 the container has been redesigned so that is no longer the 1308 case. So this method is now deprecated. 1309 </p></td> 1310</tr> 1311</tbody> 1312</table></div> 1313</li> 1314<li class="listitem"> 1315<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_45_10_2_1_2_41_19-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 1316<p>Erases all elements in the container.</p> 1317<div class="variablelist"><table border="0" class="variablelist compact"> 1318<colgroup> 1319<col align="left" valign="top"> 1320<col> 1321</colgroup> 1322<tbody> 1323<tr> 1324<td><p><span class="term">Postconditions:</span></p></td> 1325<td><p><code class="computeroutput"><a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_39_2-bb">size</a>() == 0</code></p></td> 1326</tr> 1327<tr> 1328<td><p><span class="term">Throws:</span></p></td> 1329<td><p>Never throws an exception.</p></td> 1330</tr> 1331</tbody> 1332</table></div> 1333</li> 1334<li class="listitem"> 1335<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_45_10_2_1_2_41_20-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">unordered_multimap</span><span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> 1336<p>Swaps the contents of the container with the parameter.</p> 1337<p>If <code class="computeroutput">Allocator::propagate_on_container_swap</code> is declared and 1338 <code class="computeroutput">Allocator::propagate_on_container_swap::value</code> is true then the 1339 containers' allocators are swapped. Otherwise, swapping with unequal allocators 1340 results in undefined behavior.</p> 1341<div class="variablelist"><table border="0" class="variablelist compact"> 1342<colgroup> 1343<col align="left" valign="top"> 1344<col> 1345</colgroup> 1346<tbody> 1347<tr> 1348<td><p><span class="term">Throws:</span></p></td> 1349<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> 1350</tr> 1351<tr> 1352<td><p><span class="term">Notes:</span></p></td> 1353<td><p>The exception specifications aren't quite the same as the C++11 standard, as 1354 the equality predieate and hash function are swapped using their copy constructors.</p></td> 1355</tr> 1356</tbody> 1357</table></div> 1358</li> 1359<li class="listitem"> 1360<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> H2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">></span> 1361 <a name="id-1_3_45_10_2_1_2_41_21-bb"></a><span class="identifier">merge</span><span class="special">(</span><span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</span><span class="special">,</span> <span class="identifier">H2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">Alloc</span><span class="special">></span><span class="special">&</span> source<span class="special">)</span><span class="special">;</span></pre> 1362<div class="variablelist"><table border="0" class="variablelist compact"> 1363<colgroup> 1364<col align="left" valign="top"> 1365<col> 1366</colgroup> 1367<tbody><tr> 1368<td><p><span class="term">Notes:</span></p></td> 1369<td><p>Does not support merging with a compatible <code class="computeroutput">unordered_map</code> yet.</p></td> 1370</tr></tbody> 1371</table></div> 1372</li> 1373<li class="listitem"> 1374<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> H2<span class="special">,</span> <span class="keyword">typename</span> P2<span class="special">></span> 1375 <a name="id-1_3_45_10_2_1_2_41_22-bb"></a><span class="identifier">merge</span><span class="special">(</span><span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</span><span class="special">,</span> <span class="identifier">H2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">Alloc</span><span class="special">></span><span class="special">&&</span> source<span class="special">)</span><span class="special">;</span></pre> 1376<div class="variablelist"><table border="0" class="variablelist compact"> 1377<colgroup> 1378<col align="left" valign="top"> 1379<col> 1380</colgroup> 1381<tbody><tr> 1382<td><p><span class="term">Notes:</span></p></td> 1383<td><p>Does not support merging with a compatible <code class="computeroutput">unordered_map</code> yet.</p></td> 1384</tr></tbody> 1385</table></div> 1386</li> 1387</ol></div> 1388</div> 1389<div class="refsect2"> 1390<a name="id-1.3.45.10.3.5.4.22"></a><h3> 1391<a name="id-1_3_45_10_2_1_2_42-bb"></a><code class="computeroutput">unordered_multimap</code> observers</h3> 1392<div class="orderedlist"><ol class="orderedlist" type="1"> 1393<li class="listitem"> 1394<pre class="literallayout"><span class="identifier">hasher</span> <a name="id-1_3_45_10_2_1_2_42_1-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> 1395<div class="variablelist"><table border="0" class="variablelist compact"> 1396<colgroup> 1397<col align="left" valign="top"> 1398<col> 1399</colgroup> 1400<tbody><tr> 1401<td><p><span class="term">Returns:</span></p></td> 1402<td>The container's hash function. 1403 </td> 1404</tr></tbody> 1405</table></div> 1406</li> 1407<li class="listitem"> 1408<pre class="literallayout"><span class="identifier">key_equal</span> <a name="id-1_3_45_10_2_1_2_42_2-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> 1409<div class="variablelist"><table border="0" class="variablelist compact"> 1410<colgroup> 1411<col align="left" valign="top"> 1412<col> 1413</colgroup> 1414<tbody><tr> 1415<td><p><span class="term">Returns:</span></p></td> 1416<td>The container's key equality predicate. 1417 </td> 1418</tr></tbody> 1419</table></div> 1420</li> 1421</ol></div> 1422</div> 1423<div class="refsect2"> 1424<a name="id-1.3.45.10.3.5.4.23"></a><h3> 1425<a name="id-1_3_45_10_2_1_2_43-bb"></a><code class="computeroutput">unordered_multimap</code> lookup</h3> 1426<div class="orderedlist"><ol class="orderedlist" type="1"> 1427<li class="listitem"> 1428<pre class="literallayout"><a name="id-1_3_45_10_2_1_2_43_1-bb"></a><span class="identifier">iterator</span> <a name="id-1_3_45_10_2_1_2_43_1_1-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> 1429<span class="identifier">const_iterator</span> <a name="id-1_3_45_10_2_1_2_43_1_2-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> 1430<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> 1431 <span class="keyword">typename</span> CompatiblePredicate<span class="special">></span> 1432 <span class="identifier">iterator</span> <a name="id-1_3_45_10_2_1_2_43_1_3-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> 1433 <span class="identifier">CompatiblePredicate</span> <span class="keyword">const</span><span class="special">&</span> eq<span class="special">)</span><span class="special">;</span> 1434<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> 1435 <span class="keyword">typename</span> CompatiblePredicate<span class="special">></span> 1436 <span class="identifier">const_iterator</span> 1437 <a name="id-1_3_45_10_2_1_2_43_1_4-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> 1438 <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> 1439<div class="variablelist"><table border="0" class="variablelist compact"> 1440<colgroup> 1441<col align="left" valign="top"> 1442<col> 1443</colgroup> 1444<tbody> 1445<tr> 1446<td><p><span class="term">Returns:</span></p></td> 1447<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> 1448</tr> 1449<tr> 1450<td><p><span class="term">Notes:</span></p></td> 1451<td><p> 1452 The templated overloads are a non-standard extensions which 1453 allows you to use a compatible hash function and equality 1454 predicate for a key of a different type in order to avoid 1455 an expensive type cast. In general, its use is not encouraged. 1456 </p></td> 1457</tr> 1458</tbody> 1459</table></div> 1460</li> 1461<li class="listitem"> 1462<pre class="literallayout"><span class="identifier">size_type</span> <a name="id-1_3_45_10_2_1_2_43_2-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> 1463<div class="variablelist"><table border="0" class="variablelist compact"> 1464<colgroup> 1465<col align="left" valign="top"> 1466<col> 1467</colgroup> 1468<tbody><tr> 1469<td><p><span class="term">Returns:</span></p></td> 1470<td><p>The number of elements with key equivalent to <code class="computeroutput">k</code>.</p></td> 1471</tr></tbody> 1472</table></div> 1473</li> 1474<li class="listitem"> 1475<pre class="literallayout"><a name="id-1_3_45_10_2_1_2_43_3-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="id-1_3_45_10_2_1_2_43_3_1-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> 1476<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="id-1_3_45_10_2_1_2_43_3_2-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> 1477<div class="variablelist"><table border="0" class="variablelist compact"> 1478<colgroup> 1479<col align="left" valign="top"> 1480<col> 1481</colgroup> 1482<tbody><tr> 1483<td><p><span class="term">Returns:</span></p></td> 1484<td><p>A range containing all elements with key equivalent to <code class="computeroutput">k</code>. 1485 If the container doesn't container any such elements, returns 1486 <code class="computeroutput">std::make_pair(b.end(),b.end())</code>. 1487 </p></td> 1488</tr></tbody> 1489</table></div> 1490</li> 1491</ol></div> 1492</div> 1493<div class="refsect2"> 1494<a name="id-1.3.45.10.3.5.4.24"></a><h3> 1495<a name="id-1_3_45_10_2_1_2_44-bb"></a><code class="computeroutput">unordered_multimap</code> bucket interface</h3> 1496<div class="orderedlist"><ol class="orderedlist" type="1"> 1497<li class="listitem"> 1498<pre class="literallayout"><span class="identifier">size_type</span> <a name="id-1_3_45_10_2_1_2_44_1-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> 1499<div class="variablelist"><table border="0" class="variablelist compact"> 1500<colgroup> 1501<col align="left" valign="top"> 1502<col> 1503</colgroup> 1504<tbody><tr> 1505<td><p><span class="term">Returns:</span></p></td> 1506<td><p>The number of buckets.</p></td> 1507</tr></tbody> 1508</table></div> 1509</li> 1510<li class="listitem"> 1511<pre class="literallayout"><span class="identifier">size_type</span> <a name="id-1_3_45_10_2_1_2_44_2-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> 1512<div class="variablelist"><table border="0" class="variablelist compact"> 1513<colgroup> 1514<col align="left" valign="top"> 1515<col> 1516</colgroup> 1517<tbody><tr> 1518<td><p><span class="term">Returns:</span></p></td> 1519<td><p>An upper bound on the number of buckets.</p></td> 1520</tr></tbody> 1521</table></div> 1522</li> 1523<li class="listitem"> 1524<pre class="literallayout"><span class="identifier">size_type</span> <a name="id-1_3_45_10_2_1_2_44_3-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> 1525<div class="variablelist"><table border="0" class="variablelist compact"> 1526<colgroup> 1527<col align="left" valign="top"> 1528<col> 1529</colgroup> 1530<tbody> 1531<tr> 1532<td><p><span class="term">Requires:</span></p></td> 1533<td><p><code class="computeroutput">n < <a class="link" href="unordered_multimap.html#id-1_3_45_10_2_1_2_44_1-bb">bucket_count</a>()</code></p></td> 1534</tr> 1535<tr> 1536<td><p><span class="term">Returns:</span></p></td> 1537<td><p>The number of elements in bucket <code class="computeroutput">n</code>.</p></td> 1538</tr> 1539</tbody> 1540</table></div> 1541</li> 1542<li class="listitem"> 1543<pre class="literallayout"><span class="identifier">size_type</span> <a name="id-1_3_45_10_2_1_2_44_4-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> 1544<div class="variablelist"><table border="0" class="variablelist compact"> 1545<colgroup> 1546<col align="left" valign="top"> 1547<col> 1548</colgroup> 1549<tbody> 1550<tr> 1551<td><p><span class="term">Returns:</span></p></td> 1552<td><p>The index of the bucket which would contain an element with key <code class="computeroutput">k</code>.</p></td> 1553</tr> 1554<tr> 1555<td><p><span class="term">Postconditions:</span></p></td> 1556<td><p>The return value is less than <code class="computeroutput">bucket_count()</code></p></td> 1557</tr> 1558</tbody> 1559</table></div> 1560</li> 1561<li class="listitem"> 1562<pre class="literallayout"><a name="id-1_3_45_10_2_1_2_44_5-bb"></a><span class="identifier">local_iterator</span> <a name="id-1_3_45_10_2_1_2_44_5_1-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> 1563<span class="identifier">const_local_iterator</span> <a name="id-1_3_45_10_2_1_2_44_5_2-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> 1564<div class="variablelist"><table border="0" class="variablelist compact"> 1565<colgroup> 1566<col align="left" valign="top"> 1567<col> 1568</colgroup> 1569<tbody> 1570<tr> 1571<td><p><span class="term">Requires:</span></p></td> 1572<td><p><code class="computeroutput">n</code> shall be in the range <code class="computeroutput">[0, bucket_count())</code>.</p></td> 1573</tr> 1574<tr> 1575<td><p><span class="term">Returns:</span></p></td> 1576<td><p>A local iterator pointing the first element in the bucket with index <code class="computeroutput">n</code>.</p></td> 1577</tr> 1578</tbody> 1579</table></div> 1580</li> 1581<li class="listitem"> 1582<pre class="literallayout"><a name="id-1_3_45_10_2_1_2_44_6-bb"></a><span class="identifier">local_iterator</span> <a name="id-1_3_45_10_2_1_2_44_6_1-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> 1583<span class="identifier">const_local_iterator</span> <a name="id-1_3_45_10_2_1_2_44_6_2-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> 1584<div class="variablelist"><table border="0" class="variablelist compact"> 1585<colgroup> 1586<col align="left" valign="top"> 1587<col> 1588</colgroup> 1589<tbody> 1590<tr> 1591<td><p><span class="term">Requires:</span></p></td> 1592<td><p><code class="computeroutput">n</code> shall be in the range <code class="computeroutput">[0, bucket_count())</code>.</p></td> 1593</tr> 1594<tr> 1595<td><p><span class="term">Returns:</span></p></td> 1596<td><p>A local iterator pointing the 'one past the end' element in the bucket with index <code class="computeroutput">n</code>.</p></td> 1597</tr> 1598</tbody> 1599</table></div> 1600</li> 1601<li class="listitem"> 1602<pre class="literallayout"><span class="identifier">const_local_iterator</span> <a name="id-1_3_45_10_2_1_2_44_7-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> 1603<div class="variablelist"><table border="0" class="variablelist compact"> 1604<colgroup> 1605<col align="left" valign="top"> 1606<col> 1607</colgroup> 1608<tbody> 1609<tr> 1610<td><p><span class="term">Requires:</span></p></td> 1611<td><p><code class="computeroutput">n</code> shall be in the range <code class="computeroutput">[0, bucket_count())</code>.</p></td> 1612</tr> 1613<tr> 1614<td><p><span class="term">Returns:</span></p></td> 1615<td><p>A constant local iterator pointing the first element in the bucket with index <code class="computeroutput">n</code>.</p></td> 1616</tr> 1617</tbody> 1618</table></div> 1619</li> 1620<li class="listitem"> 1621<pre class="literallayout"><span class="identifier">const_local_iterator</span> <a name="id-1_3_45_10_2_1_2_44_8-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> 1622<div class="variablelist"><table border="0" class="variablelist compact"> 1623<colgroup> 1624<col align="left" valign="top"> 1625<col> 1626</colgroup> 1627<tbody> 1628<tr> 1629<td><p><span class="term">Requires:</span></p></td> 1630<td><p><code class="computeroutput">n</code> shall be in the range <code class="computeroutput">[0, bucket_count())</code>.</p></td> 1631</tr> 1632<tr> 1633<td><p><span class="term">Returns:</span></p></td> 1634<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> 1635</tr> 1636</tbody> 1637</table></div> 1638</li> 1639</ol></div> 1640</div> 1641<div class="refsect2"> 1642<a name="id-1.3.45.10.3.5.4.25"></a><h3> 1643<a name="id-1_3_45_10_2_1_2_45-bb"></a><code class="computeroutput">unordered_multimap</code> hash policy</h3> 1644<div class="orderedlist"><ol class="orderedlist" type="1"> 1645<li class="listitem"> 1646<pre class="literallayout"><span class="keyword">float</span> <a name="id-1_3_45_10_2_1_2_45_1-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> 1647<div class="variablelist"><table border="0" class="variablelist compact"> 1648<colgroup> 1649<col align="left" valign="top"> 1650<col> 1651</colgroup> 1652<tbody><tr> 1653<td><p><span class="term">Returns:</span></p></td> 1654<td><p>The average number of elements per bucket.</p></td> 1655</tr></tbody> 1656</table></div> 1657</li> 1658<li class="listitem"> 1659<pre class="literallayout"><span class="keyword">float</span> <a name="id-1_3_45_10_2_1_2_45_2-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> 1660<div class="variablelist"><table border="0" class="variablelist compact"> 1661<colgroup> 1662<col align="left" valign="top"> 1663<col> 1664</colgroup> 1665<tbody><tr> 1666<td><p><span class="term">Returns:</span></p></td> 1667<td><p>Returns the current maximum load factor.</p></td> 1668</tr></tbody> 1669</table></div> 1670</li> 1671<li class="listitem"> 1672<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_45_10_2_1_2_45_3-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> 1673<div class="variablelist"><table border="0" class="variablelist compact"> 1674<colgroup> 1675<col align="left" valign="top"> 1676<col> 1677</colgroup> 1678<tbody><tr> 1679<td><p><span class="term">Effects:</span></p></td> 1680<td><p>Changes the container's maximum load factor, using <code class="computeroutput">z</code> as a hint.</p></td> 1681</tr></tbody> 1682</table></div> 1683</li> 1684<li class="listitem"> 1685<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_45_10_2_1_2_45_4-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> 1686<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> 1687<p>Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated.</p> 1688<div class="variablelist"><table border="0" class="variablelist compact"> 1689<colgroup> 1690<col align="left" valign="top"> 1691<col> 1692</colgroup> 1693<tbody><tr> 1694<td><p><span class="term">Throws:</span></p></td> 1695<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> 1696</tr></tbody> 1697</table></div> 1698</li> 1699<li class="listitem"> 1700<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_45_10_2_1_2_45_5-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> 1701<p>Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated.</p> 1702<div class="variablelist"><table border="0" class="variablelist compact"> 1703<colgroup> 1704<col align="left" valign="top"> 1705<col> 1706</colgroup> 1707<tbody><tr> 1708<td><p><span class="term">Throws:</span></p></td> 1709<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> 1710</tr></tbody> 1711</table></div> 1712</li> 1713</ol></div> 1714</div> 1715<div class="refsect2"> 1716<a name="id-1.3.45.10.3.5.4.26"></a><h3> 1717<a name="id-1_3_45_10_2_1_2_46-bb"></a><code class="computeroutput">unordered_multimap</code> Equality Comparisons</h3> 1718<div class="orderedlist"><ol class="orderedlist" type="1"> 1719<li class="listitem"> 1720<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> Mapped<span class="special">,</span> <span class="keyword">typename</span> Hash<span class="special">,</span> <span class="keyword">typename</span> Pred<span class="special">,</span> 1721 <span class="keyword">typename</span> Alloc<span class="special">></span> 1722 <span class="keyword">bool</span> <a name="boost.unordered_multimap.operator=="></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</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> 1723 <span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</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> 1724<p>Return <code class="computeroutput">true</code> if <code class="computeroutput">x.size() == 1725 y.size</code> and for every equivalent key group in 1726 <code class="computeroutput">x</code>, there is a group in <code class="computeroutput">y</code> 1727 for the same key, which is a permutation (using 1728 <code class="computeroutput">operator==</code> to compare the value types). 1729 </p> 1730<div class="variablelist"><table border="0" class="variablelist compact"> 1731<colgroup> 1732<col align="left" valign="top"> 1733<col> 1734</colgroup> 1735<tbody><tr> 1736<td><p><span class="term">Notes:</span></p></td> 1737<td> 1738<p>The behavior of this function was changed to match 1739 the C++11 standard in Boost 1.48.</p> 1740<p>Behavior is undefined if the two containers don't have 1741 equivalent equality predicates.</p> 1742</td> 1743</tr></tbody> 1744</table></div> 1745</li> 1746<li class="listitem"> 1747<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> Mapped<span class="special">,</span> <span class="keyword">typename</span> Hash<span class="special">,</span> <span class="keyword">typename</span> Pred<span class="special">,</span> 1748 <span class="keyword">typename</span> Alloc<span class="special">></span> 1749 <span class="keyword">bool</span> <a name="boost.unordered_multimap.operator!="></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</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> 1750 <span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</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> 1751<p>Return <code class="computeroutput">false</code> if <code class="computeroutput">x.size() == 1752 y.size</code> and for every equivalent key group in 1753 <code class="computeroutput">x</code>, there is a group in <code class="computeroutput">y</code> 1754 for the same key, which is a permutation (using 1755 <code class="computeroutput">operator==</code> to compare the value types). 1756 </p> 1757<div class="variablelist"><table border="0" class="variablelist compact"> 1758<colgroup> 1759<col align="left" valign="top"> 1760<col> 1761</colgroup> 1762<tbody><tr> 1763<td><p><span class="term">Notes:</span></p></td> 1764<td> 1765<p>The behavior of this function was changed to match 1766 the C++11 standard in Boost 1.48.</p> 1767<p>Behavior is undefined if the two containers don't have 1768 equivalent equality predicates.</p> 1769</td> 1770</tr></tbody> 1771</table></div> 1772</li> 1773</ol></div> 1774</div> 1775<div class="refsect2"> 1776<a name="id-1.3.45.10.3.5.4.27"></a><h3> 1777<a name="id-1_3_45_10_2_1_2_47-bb"></a><code class="computeroutput">unordered_multimap</code> swap</h3> 1778<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 1779<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> Mapped<span class="special">,</span> <span class="keyword">typename</span> Hash<span class="special">,</span> <span class="keyword">typename</span> Pred<span class="special">,</span> 1780 <span class="keyword">typename</span> Alloc<span class="special">></span> 1781 <span class="keyword">void</span> <a name="boost.unordered_multimap.swap"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</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> 1782 <span class="identifier">unordered_multimap</span><span class="special"><</span><span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Mapped</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> 1783<p>Swaps the contents of <code class="computeroutput">x</code> and <code class="computeroutput">y</code>.</p> 1784<p>If <code class="computeroutput">Allocator::propagate_on_container_swap</code> is declared and 1785 <code class="computeroutput">Allocator::propagate_on_container_swap::value</code> is true then the 1786 containers' allocators are swapped. Otherwise, swapping with unequal allocators 1787 results in undefined behavior.</p> 1788<div class="variablelist"><table border="0" class="variablelist compact"> 1789<colgroup> 1790<col align="left" valign="top"> 1791<col> 1792</colgroup> 1793<tbody> 1794<tr> 1795<td><p><span class="term">Effects:</span></p></td> 1796<td><p><code class="computeroutput">x.swap(y)</code></p></td> 1797</tr> 1798<tr> 1799<td><p><span class="term">Throws:</span></p></td> 1800<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> 1801</tr> 1802<tr> 1803<td><p><span class="term">Notes:</span></p></td> 1804<td><p>The exception specifications aren't quite the same as the C++11 standard, as 1805 the equality predieate and hash function are swapped using their copy constructors.</p></td> 1806</tr> 1807</tbody> 1808</table></div> 1809</li></ol></div> 1810</div> 1811</div> 1812</div> 1813<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 1814<td align="left"></td> 1815<td align="right"><div class="copyright-footer">Copyright © 2003, 2004 Jeremy B. Maitin-Shepard<br>Copyright © 2005-2008 Daniel 1816 James<p> 1817 Distributed under the Boost Software License, Version 1.0. (See accompanying 1818 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>) 1819 </p> 1820</div></td> 1821</tr></table> 1822<hr> 1823<div class="spirit-nav"> 1824<a accesskey="p" href="unordered_map.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../unordered/reference.html#header.boost.unordered_map_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../unordered/bibliography.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> 1825</div> 1826</body> 1827</html> 1828
