boost-react-native-bundle

<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template unordered_multiset</title> <link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../unordered/reference.html#header.boost.unordered_set_hpp" title="Header <boost/unordered_set.hpp>"> <link rel="prev" href="unordered_set.html" title="Class template unordered_set"> <link rel="next" href="unordered_map.html" title="Class template unordered_map"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td> <td align="center"><a href="../../../index.html">Home</a></td> <td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> <td align="center"><a href="../../../more/index.htm">More</a></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="unordered_set.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../unordered/reference.html#header.boost.unordered_set_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="unordered_map.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.unordered_multiset"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Class template unordered_multiset</h2> boost::unordered_multiset — An unordered associative container that stores values. The same key can be stored multiple times. </div> <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">// In header: <<a class="link" href="../unordered/reference.html#header.boost.unordered_set_hpp" title="Header <boost/unordered_set.hpp>">boost/unordered_set.hpp</a>> template<typename Value, typename Hash = boost::hash<Value>, typename Pred = std::equal_to<Value>, typename Alloc = std::allocator<Value> > class <a class="link" href="unordered_multiset.html" title="Class template unordered_multiset">unordered_multiset</a> { public: // <a class="link" href="unordered_multiset.html#boost.unordered_multisettypes">types</a> typedef Value <a name="boost.unordered_multiset.key_type"></a>key_type; typedef Value <a name="boost.unordered_multiset.value_type"></a>value_type; typedef Hash <a name="boost.unordered_multiset.hasher"></a>hasher; typedef Pred <a name="boost.unordered_multiset.key_equal"></a>key_equal; typedef Alloc <a name="boost.unordered_multiset.allocator_type"></a>allocator_type; typedef typename allocator_type::pointer <a class="link" href="unordered_multiset.html#boost.unordered_multiset.pointer">pointer</a>; typedef typename allocator_type::const_pointer <a class="link" href="unordered_multiset.html#boost.unordered_multiset.const_pointer">const_pointer</a>; typedef value_type& <a name="boost.unordered_multiset.reference"></a>reference; // lvalue of value_type. typedef value_type const& <a name="boost.unordered_multiset.const_reference"></a>const_reference; // const lvalue of value_type. typedef implementation-defined <a class="link" href="unordered_multiset.html#boost.unordered_multiset.size_type">size_type</a>; typedef implementation-defined <a class="link" href="unordered_multiset.html#boost.unordered_multiset.difference_type">difference_type</a>; typedef implementation-defined <a class="link" href="unordered_multiset.html#boost.unordered_multiset.iterator">iterator</a>; typedef implementation-defined <a class="link" href="unordered_multiset.html#boost.unordered_multiset.const_iterator">const_iterator</a>; typedef implementation-defined <a class="link" href="unordered_multiset.html#boost.unordered_multiset.local_iterator">local_iterator</a>; typedef implementation-defined <a class="link" href="unordered_multiset.html#boost.unordered_multiset.const_local_iterator">const_local_iterator</a>; // <a class="link" href="unordered_multiset.html#boost.unordered_multisetconstruct-copy-destruct">construct/copy/destruct</a> explicit <a class="link" href="unordered_multiset.html#idp157047856-bb">unordered_multiset</a>(size_type = implementation-defined, hasher const& = hasher(), key_equal const& = key_equal(), allocator_type const& = allocator_type()); template<typename InputIterator> <a class="link" href="unordered_multiset.html#idp157060112-bb">unordered_multiset</a>(InputIterator, InputIterator, size_type = implementation-defined, hasher const& = hasher(), key_equal const& = key_equal(), allocator_type const& = allocator_type()); <a class="link" href="unordered_multiset.html#idp157074464-bb">unordered_multiset</a>(unordered_multiset const&); <a class="link" href="unordered_multiset.html#idp157078960-bb">unordered_multiset</a>(unordered_multiset &&); explicit <a class="link" href="unordered_multiset.html#idp157085056-bb">unordered_multiset</a>(Allocator const&); <a class="link" href="unordered_multiset.html#idp157088256-bb">unordered_multiset</a>(unordered_multiset const&, Allocator const&); <a class="link" href="unordered_multiset.html#idp157092944-bb">~unordered_multiset</a>(); unordered_multiset& <a class="link" href="unordered_multiset.html#idp157094256-bb">operator=</a>(unordered_multiset const&); unordered_multiset& <a class="link" href="unordered_multiset.html#idp157099952-bb">operator=</a>(unordered_multiset &&); allocator_type <a class="link" href="unordered_multiset.html#idp157106800-bb">get_allocator</a>() const; // <a class="link" href="unordered_multiset.html#idp157108240-bb">size and capacity</a> bool <a class="link" href="unordered_multiset.html#idp157108800-bb">empty</a>() const; size_type <a class="link" href="unordered_multiset.html#idp302576624-bb">size</a>() const; size_type <a class="link" href="unordered_multiset.html#idp302579856-bb">max_size</a>() const; // <a class="link" href="unordered_multiset.html#idp302582448-bb">iterators</a> iterator <a class="link" href="unordered_multiset.html#idp302583568-bb">begin</a>(); const_iterator <a class="link" href="unordered_multiset.html#idp302584144-bb">begin</a>() const; iterator <a class="link" href="unordered_multiset.html#idp302586288-bb">end</a>(); const_iterator <a class="link" href="unordered_multiset.html#idp302587184-bb">end</a>() const; const_iterator <a class="link" href="unordered_multiset.html#idp302588928-bb">cbegin</a>() const; const_iterator <a class="link" href="unordered_multiset.html#idp302590960-bb">cend</a>() const; // <a class="link" href="unordered_multiset.html#idp302593088-bb">modifiers</a> template<typename... Args> iterator <a class="link" href="unordered_multiset.html#idp302593648-bb">emplace</a>(Args&&...); template<typename... Args> iterator <a class="link" href="unordered_multiset.html#idp302607584-bb">emplace_hint</a>(const_iterator, Args&&...); iterator <a class="link" href="unordered_multiset.html#idp302624016-bb">insert</a>(value_type const&); iterator <a class="link" href="unordered_multiset.html#idp302632944-bb">insert</a>(value_type&&); iterator <a class="link" href="unordered_multiset.html#idp302641872-bb">insert</a>(const_iterator, value_type const&); iterator <a class="link" href="unordered_multiset.html#idp311918960-bb">insert</a>(const_iterator, value_type&&); template<typename InputIterator> void <a class="link" href="unordered_multiset.html#idp311930096-bb">insert</a>(InputIterator, InputIterator); iterator <a class="link" href="unordered_multiset.html#idp311941200-bb">erase</a>(const_iterator); size_type <a class="link" href="unordered_multiset.html#idp311949232-bb">erase</a>(key_type const&); iterator <a class="link" href="unordered_multiset.html#idp311955552-bb">erase</a>(const_iterator, const_iterator); void <a class="link" href="unordered_multiset.html#idp311964528-bb">quick_erase</a>(const_iterator); void <a class="link" href="unordered_multiset.html#idp311972192-bb">erase_return_void</a>(const_iterator); void <a class="link" href="unordered_multiset.html#idp311979856-bb">clear</a>(); void <a class="link" href="unordered_multiset.html#idp311984160-bb">swap</a>(unordered_multiset&); // <a class="link" href="unordered_multiset.html#idp303524640-bb">observers</a> hasher <a class="link" href="unordered_multiset.html#idp303525200-bb">hash_function</a>() const; key_equal <a class="link" href="unordered_multiset.html#idp303527056-bb">key_eq</a>() const; // <a class="link" href="unordered_multiset.html#idp303529072-bb">lookup</a> iterator <a class="link" href="unordered_multiset.html#idp303530192-bb">find</a>(key_type const&); const_iterator <a class="link" href="unordered_multiset.html#idp303532256-bb">find</a>(key_type const&) const; template<typename CompatibleKey, typename CompatibleHash, typename CompatiblePredicate> iterator <a class="link" href="unordered_multiset.html#idp303534592-bb">find</a>(CompatibleKey const&, CompatibleHash const&, CompatiblePredicate const&); template<typename CompatibleKey, typename CompatibleHash, typename CompatiblePredicate> const_iterator <a class="link" href="unordered_multiset.html#idp303541136-bb">find</a>(CompatibleKey const&, CompatibleHash const&, CompatiblePredicate const&) const; size_type <a class="link" href="unordered_multiset.html#idp303550768-bb">count</a>(key_type const&) const; std::pair<iterator, iterator> <a class="link" href="unordered_multiset.html#idp303555248-bb">equal_range</a>(key_type const&); std::pair<const_iterator, const_iterator> <a class="link" href="unordered_multiset.html#idp303557328-bb">equal_range</a>(key_type const&) const; // <a class="link" href="unordered_multiset.html#idp303562976-bb">bucket interface</a> size_type <a class="link" href="unordered_multiset.html#idp303563536-bb">bucket_count</a>() const; size_type <a class="link" href="unordered_multiset.html#idp303565872-bb">max_bucket_count</a>() const; size_type <a class="link" href="unordered_multiset.html#idp303568176-bb">bucket_size</a>(size_type) const; size_type <a class="link" href="unordered_multiset.html#idp303573616-bb">bucket</a>(key_type const&) const; local_iterator <a class="link" href="unordered_multiset.html#idp303579296-bb">begin</a>(size_type); const_local_iterator <a class="link" href="unordered_multiset.html#idp303581360-bb">begin</a>(size_type) const; local_iterator <a class="link" href="unordered_multiset.html#idp303587360-bb">end</a>(size_type); const_local_iterator <a class="link" href="unordered_multiset.html#idp303685520-bb">end</a>(size_type) const; const_local_iterator <a class="link" href="unordered_multiset.html#idp303690960-bb">cbegin</a>(size_type) const; const_local_iterator <a class="link" href="unordered_multiset.html#idp303696512-bb">cend</a>(size_type); // <a class="link" href="unordered_multiset.html#idp303702064-bb">hash policy</a> float <a class="link" href="unordered_multiset.html#idp303702624-bb">load_factor</a>() const; float <a class="link" href="unordered_multiset.html#idp303704928-bb">max_load_factor</a>() const; void <a class="link" href="unordered_multiset.html#idp303707232-bb">max_load_factor</a>(float); void <a class="link" href="unordered_multiset.html#idp303710880-bb">rehash</a>(size_type); void <a class="link" href="unordered_multiset.html#idp303716048-bb">reserve</a>(size_type); }; // <a class="link" href="unordered_multiset.html#idp303720544-bb">Equality Comparisons</a> template<typename Value, typename Hash, typename Pred, typename Alloc> bool <a class="link" href="unordered_multiset.html#boost.unordered_multiset.operator==_idp303721104">operator==</a>(unordered_multiset<Value, Hash, Pred, Alloc> const&, unordered_multiset<Value, Hash, Pred, Alloc> const&); template<typename Value, typename Hash, typename Pred, typename Alloc> bool <a class="link" href="unordered_multiset.html#boost.unordered_multiset.operator!=_idp303732448">operator!=</a>(unordered_multiset<Value, Hash, Pred, Alloc> const&, unordered_multiset<Value, Hash, Pred, Alloc> const&); // <a class="link" href="unordered_multiset.html#idp303743952-bb">swap</a> template<typename Value, typename Hash, typename Pred, typename Alloc> void <a class="link" href="unordered_multiset.html#boost.unordered_multiset.swap_idp303744512">swap</a>(unordered_multiset<Value, Hash, Pred, Alloc>&, unordered_multiset<Value, Hash, Pred, Alloc>&);</pre></div> <div class="refsect1"> <a name="idp518749680"></a><h2>Description</h2> Template Parameters <div class="informaltable"><table class="table"> <colgroup> <col> <col> </colgroup> <tbody> <tr> <td>Value</td> <td> <code class="computeroutput">Value</code> must be <code class="computeroutput">Erasable</code> from the container (i.e. <code class="computeroutput">allocator_traits</code> can <code class="computeroutput">destroy</code> it). </td> </tr> <tr> <td>Hash</td> <td>A unary function object type that acts a hash function for a <code class="computeroutput">Value</code>. It takes a single argument of type <code class="computeroutput">Value</code> and returns a value of type std::size_t.</td> </tr> <tr> <td>Pred</td> <td>A binary function object that implements an equivalence relation on values of type <code class="computeroutput">Value</code>. A binary function object that induces an equivalence relation on values of type <code class="computeroutput">Value</code>. It takes two arguments of type <code class="computeroutput">Value</code> and returns a value of type bool.</td> </tr> <tr> <td>Alloc</td> <td>An allocator whose value type is the same as the container's value type.</td> </tr> </tbody> </table></div> 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. The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash. <div class="refsect2"> <a name="idp518764672"></a><h3> <a name="boost.unordered_multisettypes"></a><code class="computeroutput">unordered_multiset</code> public types</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> typedef typename allocator_type::pointer <a name="boost.unordered_multiset.pointer"></a>pointer; <code class="computeroutput">value_type*</code> if <code class="computeroutput">allocator_type::pointer</code> is not defined. </li> <li class="listitem"> typedef typename allocator_type::const_pointer <a name="boost.unordered_multiset.const_pointer"></a>const_pointer; <code class="computeroutput">boost::pointer_to_other<pointer, value_type>::type</code> if <code class="computeroutput">allocator_type::const_pointer</code> is not defined. </li> <li class="listitem"> typedef implementation-defined <a name="boost.unordered_multiset.size_type"></a>size_type; An unsigned integral type. size_type can represent any non-negative value of difference_type. </li> <li class="listitem"> typedef implementation-defined <a name="boost.unordered_multiset.difference_type"></a>difference_type; A signed integral type. Is identical to the difference type of iterator and const_iterator. </li> <li class="listitem"> typedef implementation-defined <a name="boost.unordered_multiset.iterator"></a>iterator; A constant iterator whose value type is value_type. The iterator category is at least a forward iterator. Convertible to const_iterator. </li> <li class="listitem"> typedef implementation-defined <a name="boost.unordered_multiset.const_iterator"></a>const_iterator; A constant iterator whose value type is value_type. The iterator category is at least a forward iterator. </li> <li class="listitem"> typedef implementation-defined <a name="boost.unordered_multiset.local_iterator"></a>local_iterator; An iterator with the same value type, difference type and pointer and reference type as iterator. A local_iterator object can be used to iterate through a single bucket. </li> <li class="listitem"> typedef implementation-defined <a name="boost.unordered_multiset.const_local_iterator"></a>const_local_iterator; A constant iterator with the same value type, difference type and pointer and reference type as const_iterator. A const_local_iterator object can be used to iterate through a single bucket. </li> </ol></div> </div> <div class="refsect2"> <a name="idp518816128"></a><h3> <a name="boost.unordered_multisetconstruct-copy-destruct"></a><code class="computeroutput">unordered_multiset</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">explicit <a name="idp157047856-bb"></a>unordered_multiset(size_type n = implementation-defined, hasher const& hf = hasher(), key_equal const& eq = key_equal(), allocator_type const& a = allocator_type());</pre> 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. <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td>Postconditions:</td> <td><code class="computeroutput"><a class="link" href="unordered_multiset.html#idp302576624-bb">size</a>() == 0</code></td> </tr> <tr> <td>Requires:</td> <td>If the defaults are used, <code class="computeroutput">hasher</code>, <code class="computeroutput">key_equal</code> and <code class="computeroutput">allocator_type</code> need to be <code class="computeroutput">DefaultConstructible</code>. </td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout">template<typename InputIterator> <a name="idp157060112-bb"></a>unordered_multiset(InputIterator f, InputIterator l, size_type n = implementation-defined, hasher const& hf = hasher(), key_equal const& eq = key_equal(), allocator_type const& a = allocator_type());</pre> Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocator and a maximum load factor of 1.0 and inserts the elements from [f, l) into it. <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody><tr> <td>Requires:</td> <td>If the defaults are used, <code class="computeroutput">hasher</code>, <code class="computeroutput">key_equal</code> and <code class="computeroutput">allocator_type</code> need to be <code class="computeroutput">DefaultConstructible</code>. </td> </tr></tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><a name="idp157074464-bb"></a>unordered_multiset(unordered_multiset const&);</pre> The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator. If <code class="computeroutput">Allocator::select_on_container_copy_construction</code> exists and has the right signature, the allocator will be constructed from its result. <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody><tr> <td>Requires:</td> <td><code class="computeroutput">value_type</code> is copy