5890 lines
280 KiB
XML
5890 lines
280 KiB
XML
<!--
|
|
Copyright Daniel James 2006-2009
|
|
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
--><library-reference>
|
|
<header name="boost/unordered_set.hpp">
|
|
<namespace name="boost">
|
|
<class name="unordered_set">
|
|
<template>
|
|
<template-type-parameter name="Value">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
<default><type>boost::hash<Value></type></default>
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
<default><type>std::equal_to<Value></type></default>
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
<default><type>std::allocator<Value></type></default>
|
|
</template-type-parameter>
|
|
</template>
|
|
<purpose><simpara>
|
|
An unordered associative container that stores unique values.
|
|
</simpara></purpose>
|
|
<description>
|
|
<para><emphasis role="bold">Template Parameters</emphasis>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<tbody>
|
|
<row>
|
|
<entry><emphasis>Value</emphasis></entry>
|
|
<entry><code>Value</code> must be <code>Erasable</code> from the container
|
|
(i.e. <code>allocator_traits</code> can <code>destroy</code> it).
|
|
</entry></row>
|
|
<row>
|
|
<entry><emphasis>Hash</emphasis></entry>
|
|
<entry>A unary function object type that acts a hash function for a <code>Value</code>. It takes a single argument of type <code>Value</code> and returns a value of type std::size_t.</entry></row>
|
|
<row>
|
|
<entry><emphasis>Pred</emphasis></entry>
|
|
<entry>A binary function object that implements an equivalence relation on values of type <code>Value</code>.
|
|
A binary function object that induces an equivalence relation on values of type <code>Value</code>.
|
|
It takes two arguments of type <code>Value</code> and returns a value of type bool.</entry></row>
|
|
<row>
|
|
<entry><emphasis>Alloc</emphasis></entry>
|
|
<entry>An allocator whose value type is the same as the container's value type.</entry></row></tbody></tgroup></informaltable></para>
|
|
<para>The elements are organized into buckets. Keys with the same hash code are stored in the same bucket.</para>
|
|
<para>The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash.</para>
|
|
</description>
|
|
<typedef name="key_type">
|
|
<type>Value</type>
|
|
</typedef>
|
|
<typedef name="value_type">
|
|
<type>Value</type>
|
|
</typedef>
|
|
<typedef name="hasher">
|
|
<type>Hash</type>
|
|
</typedef>
|
|
<typedef name="key_equal">
|
|
<type>Pred</type>
|
|
</typedef>
|
|
<typedef name="allocator_type">
|
|
<type>Alloc</type>
|
|
</typedef>
|
|
<typedef name="pointer">
|
|
<type>typename allocator_type::pointer</type>
|
|
<description>
|
|
<para>
|
|
<code>value_type*</code> if
|
|
<code>allocator_type::pointer</code> is not defined.
|
|
</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="const_pointer">
|
|
<type>typename allocator_type::const_pointer</type>
|
|
<description>
|
|
<para>
|
|
<code>boost::pointer_to_other<pointer, value_type>::type</code>
|
|
if <code>allocator_type::const_pointer</code> is not defined.
|
|
</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="reference">
|
|
<type>value_type&</type>
|
|
<purpose><simpara>lvalue of <type>value_type</type>.</simpara></purpose>
|
|
</typedef>
|
|
<typedef name="const_reference">
|
|
<type>value_type const&</type>
|
|
<purpose><simpara>const lvalue of <type>value_type</type>.</simpara></purpose>
|
|
</typedef>
|
|
<typedef name="size_type">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>An unsigned integral type.</para>
|
|
<para><type>size_type</type> can represent any non-negative value of <type>difference_type</type>.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="difference_type">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>A signed integral type.</para>
|
|
<para>Is identical to the difference type of <type>iterator</type> and <type>const_iterator</type>.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>A constant iterator whose value type is <type>value_type</type>. </para>
|
|
<para>The iterator category is at least a forward iterator.</para>
|
|
<para>Convertible to <type>const_iterator</type>.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="const_iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>A constant iterator whose value type is <type>value_type</type>. </para>
|
|
<para>The iterator category is at least a forward iterator.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="local_iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>An iterator with the same value type, difference type and pointer and reference type as <type>iterator</type>.</para>
|
|
<para>A local_iterator object can be used to iterate through a single bucket.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="const_local_iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>A constant iterator with the same value type, difference type and pointer and reference type as <type>const_iterator</type>.</para>
|
|
<para>A const_local_iterator object can be used to iterate through a single bucket.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="node_type">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>See <classname>node_handle_set</classname> for details.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="insert_return_type">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
Structure returned by inserting <code>node_type</code>.
|
|
</description>
|
|
</typedef>
|
|
<constructor>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>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.</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor specifiers="explicit">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
<default>hasher()</default>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>key_equal const&</paramtype>
|
|
<default>key_equal()</default>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
<default>allocator_type()</default>
|
|
</parameter>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>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.</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="f">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="l">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
<default><emphasis>implementation-defined</emphasis></default>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
<default>hasher()</default>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>key_equal const&</paramtype>
|
|
<default>key_equal()</default>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
<default>allocator_type()</default>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
<code>eq</code> as the key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0
|
|
and inserts the elements from [f, l) into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter>
|
|
<paramtype>unordered_set const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator.</para>
|
|
<para>If <code>Allocator::select_on_container_copy_construction</code>
|
|
exists and has the right signature, the allocator will be
|
|
constructed from its result.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is copy constructible</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter>
|
|
<paramtype>unordered_set &&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>The move constructor.</para>
|
|
</description>
|
|
<notes>
|
|
<para>This is implemented using Boost.Move.</para>
|
|
</notes>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is move constructible.
|
|
</para>
|
|
<para>
|
|
On compilers without rvalue reference support the
|
|
emulation does not support moving without calling
|
|
<code>boost::move</code> if <code>value_type</code> is
|
|
not copyable. So, for example, you can't return the
|
|
container from a function.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor specifiers="explicit">
|
|
<parameter name="a">
|
|
<paramtype>Allocator const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container, using allocator <code>a</code>.</para>
|
|
</description>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="x">
|
|
<paramtype>unordered_set const&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>Allocator const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an container, copying <code>x</code>'s contained elements, hash function, predicate, maximum load factor, but using allocator <code>a</code>.</para>
|
|
</description>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="x">
|
|
<paramtype>unordered_set &&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>Allocator const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Construct a container moving <code>x</code>'s contained elements, and having the hash function, predicate and maximum load factor, but using allocate <code>a</code>.</para>
|
|
</description>
|
|
<notes>
|
|
<para>This is implemented using Boost.Move.</para>
|
|
</notes>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is move insertable.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="il">
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
<default><emphasis>implementation-defined</emphasis></default>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
<default>hasher()</default>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>key_equal const&</paramtype>
|
|
<default>key_equal()</default>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
<default>allocator_type()</default>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
<code>eq</code> as the key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0
|
|
and inserts the elements from <code>il</code> into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
the default hash function and key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>hasher</code> and <code>key_equal</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
the default key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>key_equal</code> needs to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="f">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="l">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>a</code> as the allocator, with the
|
|
default hash function and key equality predicate
|
|
and a maximum load factor of 1.0
|
|
and inserts the elements from [f, l) into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>hasher</code>, <code>key_equal</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="f">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="l">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
<code>a</code> as the allocator, with the
|
|
default key equality predicate
|
|
and a maximum load factor of 1.0
|
|
and inserts the elements from [f, l) into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>key_equal</code> needs to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<destructor>
|
|
<notes>
|
|
<para>The destructor is applied to every element, and all memory is deallocated</para>
|
|
</notes>
|
|
</destructor>
|
|
<method name="operator=">
|
|
<parameter>
|
|
<paramtype>unordered_set const&</paramtype>
|
|
</parameter>
|
|
<type>unordered_set&</type>
|
|
<description>
|
|
<para>The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator.</para>
|
|
<para>If <code>Alloc::propagate_on_container_copy_assignment</code>
|
|
exists and <code>Alloc::propagate_on_container_copy_assignment::value
|
|
</code> is true, the allocator is overwritten, if not the
|
|
copied elements are created using the existing
|
|
allocator.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is copy constructible</para>
|
|
</requires>
|
|
</method>
|
|
<method name="operator=">
|
|
<parameter>
|
|
<paramtype>unordered_set &&</paramtype>
|
|
</parameter>
|
|
<type>unordered_set&</type>
|
|
<description>
|
|
<para>The move assignment operator.</para>
|
|
<para>If <code>Alloc::propagate_on_container_move_assignment</code>
|
|
exists and <code>Alloc::propagate_on_container_move_assignment::value
|
|
</code> is true, the allocator is overwritten, if not the
|
|
moved elements are created using the existing
|
|
allocator.</para>
|
|
</description>
|
|
<notes>
|
|
<para>
|
|
On compilers without rvalue references, this is emulated using
|
|
Boost.Move. Note that on some compilers the copy assignment
|
|
operator may be used in some circumstances.
|
|
</para>
|
|
</notes>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is move constructible.
|
|
</para>
|
|
</requires>
|
|
</method>
|
|
<method name="operator=">
|
|
<parameter>
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<type>unordered_set&</type>
|
|
<description>
|
|
<para>Assign from values in initializer list. All existing elements are either overwritten by the new elements or destroyed.</para>
|
|
</description>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is <code>CopyInsertable</code> into the container and
|
|
<code>CopyAssignable</code>.
|
|
</para>
|
|
</requires>
|
|
</method>
|
|
<method name="get_allocator" cv="const">
|
|
<type>allocator_type</type>
|
|
</method>
|
|
<method-group name="size and capacity">
|
|
<method name="empty" cv="const">
|
|
<type>bool</type>
|
|
<returns>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</returns>
|
|
</method>
|
|
<method name="size" cv="const">
|
|
<type>size_type</type>
|
|
<returns>
|
|
<code>std::distance(<methodname>begin</methodname>(), <methodname>end</methodname>())</code>
|
|
</returns>
|
|
</method>
|
|
<method name="max_size" cv="const">
|
|
<type>size_type</type>
|
|
<returns><code><methodname>size</methodname>()</code> of the largest possible container.
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="iterators">
|
|
<overloaded-method name="begin">
|
|
<signature><type>iterator</type></signature>
|
|
<signature cv="const"><type>const_iterator</type></signature>
|
|
<returns>An iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container.
|
|
</returns>
|
|
</overloaded-method>
|
|
<overloaded-method name="end">
|
|
<signature>
|
|
<type>iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<type>const_iterator</type>
|
|
</signature>
|
|
<returns>An iterator which refers to the past-the-end value for the container.
|
|
</returns>
|
|
</overloaded-method>
|
|
<method name="cbegin" cv="const">
|
|
<type>const_iterator</type>
|
|
<returns>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.
|
|
</returns>
|
|
</method>
|
|
<method name="cend" cv="const">
|
|
<type>const_iterator</type>
|
|
<returns>A constant iterator which refers to the past-the-end value for the container.
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="modifiers">
|
|
<method name="emplace">
|
|
<template>
|
|
<template-type-parameter name="Args" pack="1">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="args" pack="1">
|
|
<paramtype>Args&&</paramtype>
|
|
</parameter>
|
|
<type>std::pair<iterator, bool></type>
|
|
<description>
|
|
<para>Inserts an object, constructed with the arguments <code>args</code>, in the container if and only if there is no element in the container with an equivalent value.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>args</code>.
|
|
</para>
|
|
</requires>
|
|
<returns>
|
|
<para>The bool component of the return type is true if an insert took place.</para>
|
|
<para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent value.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>If the compiler doesn't support variadic template arguments or rvalue
|
|
references, this is emulated for up to 10 arguments, with no support
|
|
for rvalue references or move semantics.</para>
|
|
<para>Since existing <code>std::pair</code> implementations don't support
|
|
<code>std::piecewise_construct</code> this emulates it,
|
|
but using <code>boost::unordered::piecewise_construct</code>.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="emplace_hint">
|
|
<template>
|
|
<template-type-parameter name="Args" pack="1">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="args" pack="1">
|
|
<paramtype>Args&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts an object, constructed with the arguments <code>args</code>, in the container if and only if there is no element in the container with an equivalent value.</para>
|
|
<para><code>hint</code> is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>args</code>.
|
|
</para>
|
|
</requires>
|
|
<returns>
|
|
<para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent value.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same value. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>If the compiler doesn't support variadic template arguments or rvalue
|
|
references, this is emulated for up to 10 arguments, with no support
|
|
for rvalue references or move semantics.</para>
|
|
<para>Since existing <code>std::pair</code> implementations don't support
|
|
<code>std::piecewise_construct</code> this emulates it,
|
|
but using <code>boost::unordered::piecewise_construct</code>.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="obj">
|
|
<paramtype>value_type const&</paramtype>
|
|
</parameter>
|
|
<type>std::pair<iterator, bool></type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container if and only if there is no element in the container with an equivalent value.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>CopyInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>The bool component of the return type is true if an insert took place.</para>
|
|
<para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent value.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="obj">
|
|
<paramtype>value_type&&</paramtype>
|
|
</parameter>
|
|
<type>std::pair<iterator, bool></type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container if and only if there is no element in the container with an equivalent value.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>MoveInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>The bool component of the return type is true if an insert took place.</para>
|
|
<para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent value.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="obj">
|
|
<paramtype>value_type const&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container if and only if there is no element in the container with an equivalent value.</para>
|
|
<para>hint is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>CopyInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent value.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same value. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="obj">
|
|
<paramtype>value_type&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container if and only if there is no element in the container with an equivalent value.</para>
|
|
<para>hint is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>MoveInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent value.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same value. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="first">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="last">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Inserts a range of elements into the container.
|
|
Elements are inserted if and only if there is no element in the container with an equivalent value.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>*first</code>.</para>
|
|
</requires>
|
|
<throws>
|
|
<para>When inserting a single element, if an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="il">
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Inserts a range of elements into the container.
|
|
Elements are inserted if and only if there is no element in the container with an equivalent value.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>*first</code>.</para>
|
|
</requires>
|
|
<throws>
|
|
<para>When inserting a single element, if an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="il">
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Inserts a range of elements into the container. Elements are inserted if and only if there is no element in the container with an equivalent value.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>*first</code>.</para>
|
|
</requires>
|
|
<throws>
|
|
<para>When inserting a single element, if an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="extract">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>node_type</type>
|
|
<description>
|
|
<para>Removes the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>A <code>node_type</code> owning the element.</para>
|
|
</returns>
|
|
<notes>
|
|
<para>
|
|
In C++17 a node extracted using this method can be inserted into a compatible <code>unordered_multiset</code>,
|
|
but that is not supported yet.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="extract">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>node_type</type>
|
|
<description>
|
|
<para>Removes an element with key equivalent to <code>k</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>A <code>node_type</code> owning the element if found, otherwise an empty <code>node_type</code>.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
In C++17 a node extracted using this method can be inserted into a compatible <code>unordered_multiset</code>,
|
|
but that is not supported yet.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="nh">
|
|
<paramtype>node_type&&</paramtype>
|
|
</parameter>
|
|
<type>insert_return_type</type>
|
|
<description>
|
|
<para>If <code>nh</code> is empty, has no affect.</para>
|
|
<para>Otherwise inserts the element owned by <code>nh</code>
|
|
if and only if there is no element in the container with an equivalent value.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>nh</code> is empty or <code>nh.get_allocator()</code> is equal to the container's allocator.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>If <code>nh</code> was empty, returns an <code>insert_return_type</code> with:
|
|
<code>inserted</code> equal to <code>false</code>,
|
|
<code>position</code> equal to <code>end()</code> and
|
|
<code>node</code> empty.</para>
|
|
<para>Otherwise if there was already an element with an equivalent key, returns an <code>insert_return_type</code> with:
|
|
<code>inserted</code> equal to <code>false</code>,
|
|
<code>position</code> pointing to a matching element and
|
|
<code>node</code> contains the node from <code>nh</code>.</para>
|
|
<para>Otherwise if the insertion succeeded, returns an <code>insert_return_type</code> with:
|
|
<code>inserted</code> equal to <code>true</code>,
|
|
<code>position</code> pointing to the newly inserted element and
|
|
<code>node</code> empty.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>In C++17 this can be used to insert a node extracted from a compatible <code>unordered_multiset</code>,
|
|
but that is not supported yet.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="nh">
|
|
<paramtype>node_type&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>If <code>nh</code> is empty, has no affect.</para>
|
|
<para>Otherwise inserts the element owned by <code>nh</code>
|
|
if and only if there is no element in the container with an equivalent value.
|
|
</para>
|
|
<para>If there is already an element in the container with an equivalent value has no effect on <code>nh</code> (i.e. <code>nh</code> still contains the node.)</para>
|
|
<para>hint is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>nh</code> is empty or <code>nh.get_allocator()</code> is equal to the container's allocator.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>If <code>nh</code> was empty returns <code>end()</code>.</para>
|
|
<para>If there was already an element in the container with an equivalent value returns an iterator pointing to that.</para>
|
|
<para>Otherwise returns an iterator pointing to the newly inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same value. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>In C++17 this can be used to insert a node extracted from a compatible <code>unordered_multiset</code>,
|
|
but that is not supported yet.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="erase">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Erase the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>The iterator following <code>position</code> before the erasure.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
In older versions this could be inefficient because it had to search
|
|
through several buckets to find the position of the returned iterator.
|
|
The data structure has been changed so that this is no longer the case,
|
|
and the alternative erase methods have been deprecated.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="erase">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<description>
|
|
<para>Erase all elements with key equivalent to <code>k</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>The number of elements erased.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="erase">
|
|
<parameter name="first">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="last">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Erases the elements in the range from <code>first</code> to <code>last</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>The iterator following the erased elements - i.e. <code>last</code>.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
<para>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.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="quick_erase">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Erase the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
<para>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.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
This method was implemented because returning an iterator to
|
|
the next element from <code>erase</code> was expensive, but
|
|
the container has been redesigned so that is no longer the
|
|
case. So this method is now deprecated.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="erase_return_void">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Erase the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
<para>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.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
This method was implemented because returning an iterator to
|
|
the next element from <code>erase</code> was expensive, but
|
|
the container has been redesigned so that is no longer the
|
|
case. So this method is now deprecated.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="clear">
|
|
<type>void</type>
|
|
<description>
|
|
<para>Erases all elements in the container.</para>
|
|
</description>
|
|
<postconditions>
|
|
<para><code><methodname>size</methodname>() == 0</code></para>
|
|
</postconditions>
|
|
<throws>
|
|
<para>Never throws an exception.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="swap">
|
|
<parameter>
|
|
<paramtype>unordered_set&</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Swaps the contents of the container with the parameter.</para>
|
|
<para>If <code>Allocator::propagate_on_container_swap</code> is declared and
|
|
<code>Allocator::propagate_on_container_swap::value</code> is true then the
|
|
containers' allocators are swapped. Otherwise, swapping with unequal allocators
|
|
results in undefined behavior.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>key_equal</code> or <code>hasher</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The exception specifications aren't quite the same as the C++11 standard, as
|
|
the equality predieate and hash function are swapped using their copy constructors.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="merge">
|
|
<template>
|
|
<template-type-parameter name="H2">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="P2">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="source">
|
|
<paramtype>unordered_set<Value, H2, P2, Alloc>&</paramtype>
|
|
</parameter>
|
|
<notes>
|
|
<para>Does not support merging with a compatible <code>unordered_multiset</code> yet.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="merge">
|
|
<template>
|
|
<template-type-parameter name="H2">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="P2">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="source">
|
|
<paramtype>unordered_set<Value, H2, P2, Alloc>&&</paramtype>
|
|
</parameter>
|
|
<notes>
|
|
<para>Does not support merging with a compatible <code>unordered_multiset</code> yet.</para>
|
|
</notes>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="observers">
|
|
<method name="hash_function" cv="const">
|
|
<type>hasher</type>
|
|
<returns>The container's hash function.
|
|
</returns>
|
|
</method>
|
|
<method name="key_eq" cv="const">
|
|
<type>key_equal</type>
|
|
<returns>The container's key equality predicate.
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="lookup">
|
|
<overloaded-method name="find">
|
|
<signature>
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>const_iterator</type>
|
|
</signature>
|
|
<signature>
|
|
<template>
|
|
<template-type-parameter name="CompatibleKey"/>
|
|
<template-type-parameter name="CompatibleHash"/>
|
|
<template-type-parameter name="CompatiblePredicate"/>
|
|
</template>
|
|
<parameter name="k">
|
|
<paramtype>CompatibleKey const&</paramtype>
|
|
</parameter>
|
|
<parameter name="hash">
|
|
<paramtype>CompatibleHash const&</paramtype>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>CompatiblePredicate const&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<template>
|
|
<template-type-parameter name="CompatibleKey"/>
|
|
<template-type-parameter name="CompatibleHash"/>
|
|
<template-type-parameter name="CompatiblePredicate"/>
|
|
</template>
|
|
<parameter name="k">
|
|
<paramtype>CompatibleKey const&</paramtype>
|
|
</parameter>
|
|
<parameter name="hash">
|
|
<paramtype>CompatibleHash const&</paramtype>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>CompatiblePredicate const&</paramtype>
|
|
</parameter>
|
|
<type>const_iterator</type>
|
|
</signature>
|
|
<returns>
|
|
<para>An iterator pointing to an element with key equivalent to <code>k</code>, or <code>b.end()</code> if no such element exists.</para>
|
|
</returns>
|
|
<notes><para>
|
|
The templated overloads are a non-standard extensions which
|
|
allows you to use a compatible hash function and equality
|
|
predicate for a key of a different type in order to avoid
|
|
an expensive type cast. In general, its use is not encouraged.
|
|
</para></notes>
|
|
</overloaded-method>
|
|
<method name="count" cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>The number of elements with key equivalent to <code>k</code>.</para>
|
|
</returns>
|
|
</method>
|
|
<overloaded-method name="equal_range">
|
|
<signature>
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>std::pair<iterator, iterator></type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>std::pair<const_iterator, const_iterator></type>
|
|
</signature>
|
|
<returns>
|
|
<para>A range containing all elements with key equivalent to <code>k</code>.
|
|
If the container doesn't container any such elements, returns
|
|
<code><functionname>std::make_pair</functionname>(<methodname>b.end</methodname>(),<methodname>b.end</methodname>())</code>.
|
|
</para>
|
|
</returns>
|
|
</overloaded-method>
|
|
</method-group>
|
|
<method-group name="bucket interface">
|
|
<method name="bucket_count" cv="const">
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>The number of buckets.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="max_bucket_count" cv="const">
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>An upper bound on the number of buckets.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="bucket_size" cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<requires>
|
|
<para><code>n < <methodname>bucket_count</methodname>()</code></para>
|
|
</requires>
|
|
<returns>
|
|
<para>The number of elements in bucket <code>n</code>.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="bucket" cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>The index of the bucket which would contain an element with key <code>k</code>.</para>
|
|
</returns>
|
|
<postconditions>
|
|
<para>The return value is less than <code>bucket_count()</code></para>
|
|
</postconditions>
|
|
</method>
|
|
<overloaded-method name="begin">
|
|
<signature>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>local_iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
</signature>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A local iterator pointing the first element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</overloaded-method>
|
|
<overloaded-method name="end">
|
|
<signature>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>local_iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
</signature>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A local iterator pointing the 'one past the end' element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</overloaded-method>
|
|
<method name="cbegin" cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A constant local iterator pointing the first element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="cend">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A constant local iterator pointing the 'one past the end' element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="hash policy">
|
|
<method name="load_factor" cv="const">
|
|
<type>float</type>
|
|
<returns>
|
|
<para>The average number of elements per bucket.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="max_load_factor" cv="const">
|
|
<type>float</type>
|
|
<returns>
|
|
<para>Returns the current maximum load factor.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="max_load_factor">
|
|
<parameter name="z">
|
|
<paramtype>float</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<effects>
|
|
<para>Changes the container's maximum load factor, using <code>z</code> as a hint.</para>
|
|
</effects>
|
|
</method>
|
|
<method name="rehash">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Changes the number of buckets so that there at least <code>n</code> buckets, and so that the load factor is less than the maximum load factor.</para>
|
|
<para>Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated.</para>
|
|
</description>
|
|
<throws>
|
|
<para>The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="reserve">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated.</para>
|
|
</description>
|
|
<throws>
|
|
<para>The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function.</para>
|
|
</throws>
|
|
</method>
|
|
</method-group>
|
|
<free-function-group name="Equality Comparisons">
|
|
<function name="operator==">
|
|
<template>
|
|
<template-type-parameter name="Value">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="x">
|
|
<paramtype>unordered_set<Value, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<parameter name="y">
|
|
<paramtype>unordered_set<Value, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<type>bool</type>
|
|
<description>
|
|
<para>Return <code>true</code> if <code>x.size() ==
|
|
y.size</code> and for every element in <code>x</code>,
|
|
there is an element in <code>y</code> with the same
|
|
for the same key, with an equal value (using
|
|
<code>operator==</code> to compare the value types).
|
|
</para>
|
|
</description>
|
|
<notes>
|
|
<para>The behavior of this function was changed to match
|
|
the C++11 standard in Boost 1.48.</para>
|
|
<para>Behavior is undefined if the two containers don't have
|
|
equivalent equality predicates.</para>
|
|
</notes>
|
|
</function>
|
|
<function name="operator!=">
|
|
<template>
|
|
<template-type-parameter name="Value">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="x">
|
|
<paramtype>unordered_set<Value, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<parameter name="y">
|
|
<paramtype>unordered_set<Value, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<type>bool</type>
|
|
<description>
|
|
<para>Return <code>false</code> if <code>x.size() ==
|
|
y.size</code> and for every element in <code>x</code>,
|
|
there is an element in <code>y</code> with the same
|
|
for the same key, with an equal value (using
|
|
<code>operator==</code> to compare the value types).
|
|
</para>
|
|
</description>
|
|
<notes>
|
|
<para>The behavior of this function was changed to match
|
|
the C++11 standard in Boost 1.48.</para>
|
|
<para>Behavior is undefined if the two containers don't have
|
|
equivalent equality predicates.</para>
|
|
</notes>
|
|
</function>
|
|
</free-function-group>
|
|
<free-function-group name="swap">
|
|
<function name="swap">
|
|
<template>
|
|
<template-type-parameter name="Value">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="x">
|
|
<paramtype>unordered_set<Value, Hash, Pred, Alloc>&</paramtype>
|
|
</parameter>
|
|
<parameter name="y">
|
|
<paramtype>unordered_set<Value, Hash, Pred, Alloc>&</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<effects>
|
|
<para><code>x.swap(y)</code></para>
|
|
</effects>
|
|
<description>
|
|
<para>Swaps the contents of <code>x</code> and <code>y</code>.</para>
|
|
<para>If <code>Allocator::propagate_on_container_swap</code> is declared and
|
|
<code>Allocator::propagate_on_container_swap::value</code> is true then the
|
|
containers' allocators are swapped. Otherwise, swapping with unequal allocators
|
|
results in undefined behavior.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>key_equal</code> or <code>hasher</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The exception specifications aren't quite the same as the C++11 standard, as
|
|
the equality predieate and hash function are swapped using their copy constructors.</para>
|
|
</notes>
|
|
</function>
|
|
</free-function-group>
|
|
</class>
|
|
<class name="unordered_multiset">
|
|
<template>
|
|
<template-type-parameter name="Value">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
<default><type>boost::hash<Value></type></default>
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
<default><type>std::equal_to<Value></type></default>
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
<default><type>std::allocator<Value></type></default>
|
|
</template-type-parameter>
|
|
</template>
|
|
<purpose><simpara>
|
|
An unordered associative container that stores values. The same key can be stored multiple times.
|
|
</simpara></purpose>
|
|
<description>
|
|
<para><emphasis role="bold">Template Parameters</emphasis>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<tbody>
|
|
<row>
|
|
<entry><emphasis>Value</emphasis></entry>
|
|
<entry><code>Value</code> must be <code>Erasable</code> from the container
|
|
(i.e. <code>allocator_traits</code> can <code>destroy</code> it).
|
|
</entry></row>
|
|
<row>
|
|
<entry><emphasis>Hash</emphasis></entry>
|
|
<entry>A unary function object type that acts a hash function for a <code>Value</code>. It takes a single argument of type <code>Value</code> and returns a value of type std::size_t.</entry></row>
|
|
<row>
|
|
<entry><emphasis>Pred</emphasis></entry>
|
|
<entry>A binary function object that implements an equivalence relation on values of type <code>Value</code>.
|
|
A binary function object that induces an equivalence relation on values of type <code>Value</code>.
|
|
It takes two arguments of type <code>Value</code> and returns a value of type bool.</entry></row>
|
|
<row>
|
|
<entry><emphasis>Alloc</emphasis></entry>
|
|
<entry>An allocator whose value type is the same as the container's value type.</entry></row></tbody></tgroup></informaltable></para>
|
|
<para>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.</para>
|
|
<para>The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash.</para>
|
|
</description>
|
|
<typedef name="key_type">
|
|
<type>Value</type>
|
|
</typedef>
|
|
<typedef name="value_type">
|
|
<type>Value</type>
|
|
</typedef>
|
|
<typedef name="hasher">
|
|
<type>Hash</type>
|
|
</typedef>
|
|
<typedef name="key_equal">
|
|
<type>Pred</type>
|
|
</typedef>
|
|
<typedef name="allocator_type">
|
|
<type>Alloc</type>
|
|
</typedef>
|
|
<typedef name="pointer">
|
|
<type>typename allocator_type::pointer</type>
|
|
<description>
|
|
<para>
|
|
<code>value_type*</code> if
|
|
<code>allocator_type::pointer</code> is not defined.
|
|
</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="const_pointer">
|
|
<type>typename allocator_type::const_pointer</type>
|
|
<description>
|
|
<para>
|
|
<code>boost::pointer_to_other<pointer, value_type>::type</code>
|
|
if <code>allocator_type::const_pointer</code> is not defined.
|
|
</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="reference">
|
|
<type>value_type&</type>
|
|
<purpose><simpara>lvalue of <type>value_type</type>.</simpara></purpose>
|
|
</typedef>
|
|
<typedef name="const_reference">
|
|
<type>value_type const&</type>
|
|
<purpose><simpara>const lvalue of <type>value_type</type>.</simpara></purpose>
|
|
</typedef>
|
|
<typedef name="size_type">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>An unsigned integral type.</para>
|
|
<para><type>size_type</type> can represent any non-negative value of <type>difference_type</type>.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="difference_type">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>A signed integral type.</para>
|
|
<para>Is identical to the difference type of <type>iterator</type> and <type>const_iterator</type>.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>A constant iterator whose value type is <type>value_type</type>. </para>
|
|
<para>The iterator category is at least a forward iterator.</para>
|
|
<para>Convertible to <type>const_iterator</type>.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="const_iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>A constant iterator whose value type is <type>value_type</type>. </para>
|
|
<para>The iterator category is at least a forward iterator.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="local_iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>An iterator with the same value type, difference type and pointer and reference type as <type>iterator</type>.</para>
|
|
<para>A local_iterator object can be used to iterate through a single bucket.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="const_local_iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>A constant iterator with the same value type, difference type and pointer and reference type as <type>const_iterator</type>.</para>
|
|
<para>A const_local_iterator object can be used to iterate through a single bucket.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="node_type">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>See <classname>node_handle_set</classname> for details.</para>
|
|
</description>
|
|
</typedef>
|
|
<constructor>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>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.</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor specifiers="explicit">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
<default>hasher()</default>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>key_equal const&</paramtype>
|
|
<default>key_equal()</default>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
<default>allocator_type()</default>
|
|
</parameter>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>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.</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="f">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="l">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
<default><emphasis>implementation-defined</emphasis></default>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
<default>hasher()</default>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>key_equal const&</paramtype>
|
|
<default>key_equal()</default>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
<default>allocator_type()</default>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
<code>eq</code> as the key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0
|
|
and inserts the elements from [f, l) into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter>
|
|
<paramtype>unordered_multiset const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator.</para>
|
|
<para>If <code>Allocator::select_on_container_copy_construction</code>
|
|
exists and has the right signature, the allocator will be
|
|
constructed from its result.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is copy constructible</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter>
|
|
<paramtype>unordered_multiset &&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>The move constructor.</para>
|
|
</description>
|
|
<notes>
|
|
<para>This is implemented using Boost.Move.</para>
|
|
</notes>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is move constructible.
|
|
</para>
|
|
<para>
|
|
On compilers without rvalue reference support the
|
|
emulation does not support moving without calling
|
|
<code>boost::move</code> if <code>value_type</code> is
|
|
not copyable. So, for example, you can't return the
|
|
container from a function.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor specifiers="explicit">
|
|
<parameter name="a">
|
|
<paramtype>Allocator const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container, using allocator <code>a</code>.</para>
|
|
</description>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="x">
|
|
<paramtype>unordered_multiset const&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>Allocator const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an container, copying <code>x</code>'s contained elements, hash function, predicate, maximum load factor, but using allocator <code>a</code>.</para>
|
|
</description>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="x">
|
|
<paramtype>unordered_multiset &&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>Allocator const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Construct a container moving <code>x</code>'s contained elements, and having the hash function, predicate and maximum load factor, but using allocate <code>a</code>.</para>
|
|
</description>
|
|
<notes>
|
|
<para>This is implemented using Boost.Move.</para>
|
|
</notes>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is move insertable.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="il">
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
<default><emphasis>implementation-defined</emphasis></default>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
<default>hasher()</default>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>key_equal const&</paramtype>
|
|
<default>key_equal()</default>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
<default>allocator_type()</default>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
<code>eq</code> as the key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0
|
|
and inserts the elements from <code>il</code> into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
the default hash function and key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>hasher</code> and <code>key_equal</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
the default key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>key_equal</code> needs to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="f">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="l">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>a</code> as the allocator, with the
|
|
default hash function and key equality predicate
|
|
and a maximum load factor of 1.0
|
|
and inserts the elements from [f, l) into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>hasher</code>, <code>key_equal</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="f">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="l">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
<code>a</code> as the allocator, with the
|
|
default key equality predicate
|
|
and a maximum load factor of 1.0
|
|
and inserts the elements from [f, l) into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>key_equal</code> needs to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<destructor>
|
|
<notes>
|
|
<para>The destructor is applied to every element, and all memory is deallocated</para>
|
|
</notes>
|
|
</destructor>
|
|
<method name="operator=">
|
|
<parameter>
|
|
<paramtype>unordered_multiset const&</paramtype>
|
|
</parameter>
|
|
<type>unordered_multiset&</type>
|
|
<description>
|
|
<para>The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator.</para>
|
|
<para>If <code>Alloc::propagate_on_container_copy_assignment</code>
|
|
exists and <code>Alloc::propagate_on_container_copy_assignment::value
|
|
</code> is true, the allocator is overwritten, if not the
|
|
copied elements are created using the existing
|
|
allocator.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is copy constructible</para>
|
|
</requires>
|
|
</method>
|
|
<method name="operator=">
|
|
<parameter>
|
|
<paramtype>unordered_multiset &&</paramtype>
|
|
</parameter>
|
|
<type>unordered_multiset&</type>
|
|
<description>
|
|
<para>The move assignment operator.</para>
|
|
<para>If <code>Alloc::propagate_on_container_move_assignment</code>
|
|
exists and <code>Alloc::propagate_on_container_move_assignment::value
|
|
</code> is true, the allocator is overwritten, if not the
|
|
moved elements are created using the existing
|
|
allocator.</para>
|
|
</description>
|
|
<notes>
|
|
<para>
|
|
On compilers without rvalue references, this is emulated using
|
|
Boost.Move. Note that on some compilers the copy assignment
|
|
operator may be used in some circumstances.
|
|
</para>
|
|
</notes>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is move constructible.
|
|
</para>
|
|
</requires>
|
|
</method>
|
|
<method name="operator=">
|
|
<parameter>
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<type>unordered_multiset&</type>
|
|
<description>
|
|
<para>Assign from values in initializer list. All existing elements are either overwritten by the new elements or destroyed.</para>
|
|
</description>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is <code>CopyInsertable</code> into the container and
|
|
<code>CopyAssignable</code>.
|
|
</para>
|
|
</requires>
|
|
</method>
|
|
<method name="get_allocator" cv="const">
|
|
<type>allocator_type</type>
|
|
</method>
|
|
<method-group name="size and capacity">
|
|
<method name="empty" cv="const">
|
|
<type>bool</type>
|
|
<returns>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</returns>
|
|
</method>
|
|
<method name="size" cv="const">
|
|
<type>size_type</type>
|
|
<returns>
|
|
<code>std::distance(<methodname>begin</methodname>(), <methodname>end</methodname>())</code>
|
|
</returns>
|
|
</method>
|
|
<method name="max_size" cv="const">
|
|
<type>size_type</type>
|
|
<returns><code><methodname>size</methodname>()</code> of the largest possible container.
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="iterators">
|
|
<overloaded-method name="begin">
|
|
<signature><type>iterator</type></signature>
|
|
<signature cv="const"><type>const_iterator</type></signature>
|
|
<returns>An iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container.
|
|
</returns>
|
|
</overloaded-method>
|
|
<overloaded-method name="end">
|
|
<signature>
|
|
<type>iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<type>const_iterator</type>
|
|
</signature>
|
|
<returns>An iterator which refers to the past-the-end value for the container.
|
|
</returns>
|
|
</overloaded-method>
|
|
<method name="cbegin" cv="const">
|
|
<type>const_iterator</type>
|
|
<returns>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.
|
|
</returns>
|
|
</method>
|
|
<method name="cend" cv="const">
|
|
<type>const_iterator</type>
|
|
<returns>A constant iterator which refers to the past-the-end value for the container.
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="modifiers">
|
|
<method name="emplace">
|
|
<template>
|
|
<template-type-parameter name="Args" pack="1">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="args" pack="1">
|
|
<paramtype>Args&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts an object, constructed with the arguments <code>args</code>, in the container.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>args</code>.
|
|
</para>
|
|
</requires>
|
|
<returns>
|
|
<para>An iterator pointing to the inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>If the compiler doesn't support variadic template arguments or rvalue
|
|
references, this is emulated for up to 10 arguments, with no support
|
|
for rvalue references or move semantics.</para>
|
|
<para>Since existing <code>std::pair</code> implementations don't support
|
|
<code>std::piecewise_construct</code> this emulates it,
|
|
but using <code>boost::unordered::piecewise_construct</code>.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="emplace_hint">
|
|
<template>
|
|
<template-type-parameter name="Args" pack="1">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="args" pack="1">
|
|
<paramtype>Args&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts an object, constructed with the arguments <code>args</code>, in the container.</para>
|
|
<para><code>hint</code> is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>args</code>.
|
|
</para>
|
|
</requires>
|
|
<returns>
|
|
<para>An iterator pointing to the inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same value. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>If the compiler doesn't support variadic template arguments or rvalue
|
|
references, this is emulated for up to 10 arguments, with no support
|
|
for rvalue references or move semantics.</para>
|
|
<para>Since existing <code>std::pair</code> implementations don't support
|
|
<code>std::piecewise_construct</code> this emulates it,
|
|
but using <code>boost::unordered::piecewise_construct</code>.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="obj">
|
|
<paramtype>value_type const&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>CopyInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>An iterator pointing to the inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="obj">
|
|
<paramtype>value_type&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>MoveInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>An iterator pointing to the inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="obj">
|
|
<paramtype>value_type const&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container.</para>
|
|
<para>hint is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>CopyInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>An iterator pointing to the inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same value. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="obj">
|
|
<paramtype>value_type&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container.</para>
|
|
<para>hint is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>MoveInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>An iterator pointing to the inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same value. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="first">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="last">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Inserts a range of elements into the container.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>*first</code>.</para>
|
|
</requires>
|
|
<throws>
|
|
<para>When inserting a single element, if an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="il">
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Inserts a range of elements into the container.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>*first</code>.</para>
|
|
</requires>
|
|
<throws>
|
|
<para>When inserting a single element, if an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="il">
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Inserts a range of elements into the container. Elements are inserted if and only if there is no element in the container with an equivalent value.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>*first</code>.</para>
|
|
</requires>
|
|
<throws>
|
|
<para>When inserting a single element, if an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="extract">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>node_type</type>
|
|
<description>
|
|
<para>Removes the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>A <code>node_type</code> owning the element.</para>
|
|
</returns>
|
|
<notes>
|
|
<para>
|
|
In C++17 a node extracted using this method can be inserted into a compatible <code>unordered_set</code>,
|
|
but that is not supported yet.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="extract">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>node_type</type>
|
|
<description>
|
|
<para>Removes an element with key equivalent to <code>k</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>A <code>node_type</code> owning the element if found, otherwise an empty <code>node_type</code>.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
In C++17 a node extracted using this method can be inserted into a compatible <code>unordered_set</code>,
|
|
but that is not supported yet.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="nh">
|
|
<paramtype>node_type&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>If <code>nh</code> is empty, has no affect.</para>
|
|
<para>Otherwise inserts the element owned by <code>nh</code></para>
|
|
</description>
|
|
<requires>
|
|
<para><code>nh</code> is empty or <code>nh.get_allocator()</code> is equal to the container's allocator.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>If <code>nh</code> was empty, returns <code>end()</code>.</para>
|
|
<para>Otherwise returns an iterator pointing to the newly inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>In C++17 this can be used to insert a node extracted from a compatible <code>unordered_set</code>,
|
|
but that is not supported yet.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="nh">
|
|
<paramtype>node_type&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>If <code>nh</code> is empty, has no affect.</para>
|
|
<para>Otherwise inserts the element owned by <code>nh</code></para>
|
|
<para>hint is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>nh</code> is empty or <code>nh.get_allocator()</code> is equal to the container's allocator.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>If <code>nh</code> was empty, returns <code>end()</code>.</para>
|
|
<para>Otherwise returns an iterator pointing to the newly inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same value. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>In C++17 this can be used to insert a node extracted from a compatible <code>unordered_set</code>,
|
|
but that is not supported yet.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="erase">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Erase the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>The iterator following <code>position</code> before the erasure.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
In older versions this could be inefficient because it had to search
|
|
through several buckets to find the position of the returned iterator.
|
|
The data structure has been changed so that this is no longer the case,
|
|
and the alternative erase methods have been deprecated.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="erase">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<description>
|
|
<para>Erase all elements with key equivalent to <code>k</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>The number of elements erased.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="erase">
|
|
<parameter name="first">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="last">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Erases the elements in the range from <code>first</code> to <code>last</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>The iterator following the erased elements - i.e. <code>last</code>.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
<para>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.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="quick_erase">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Erase the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
<para>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.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
This method was implemented because returning an iterator to
|
|
the next element from <code>erase</code> was expensive, but
|
|
the container has been redesigned so that is no longer the
|
|
case. So this method is now deprecated.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="erase_return_void">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Erase the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
<para>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.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
This method was implemented because returning an iterator to
|
|
the next element from <code>erase</code> was expensive, but
|
|
the container has been redesigned so that is no longer the
|
|
case. So this method is now deprecated.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="clear">
|
|
<type>void</type>
|
|
<description>
|
|
<para>Erases all elements in the container.</para>
|
|
</description>
|
|
<postconditions>
|
|
<para><code><methodname>size</methodname>() == 0</code></para>
|
|
</postconditions>
|
|
<throws>
|
|
<para>Never throws an exception.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="swap">
|
|
<parameter>
|
|
<paramtype>unordered_multiset&</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Swaps the contents of the container with the parameter.</para>
|
|
<para>If <code>Allocator::propagate_on_container_swap</code> is declared and
|
|
<code>Allocator::propagate_on_container_swap::value</code> is true then the
|
|
containers' allocators are swapped. Otherwise, swapping with unequal allocators
|
|
results in undefined behavior.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>key_equal</code> or <code>hasher</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The exception specifications aren't quite the same as the C++11 standard, as
|
|
the equality predieate and hash function are swapped using their copy constructors.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="merge">
|
|
<template>
|
|
<template-type-parameter name="H2">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="P2">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="source">
|
|
<paramtype>unordered_multiset<Value, H2, P2, Alloc>&</paramtype>
|
|
</parameter>
|
|
<notes>
|
|
<para>Does not support merging with a compatible <code>unordered_set</code> yet.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="merge">
|
|
<template>
|
|
<template-type-parameter name="H2">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="P2">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="source">
|
|
<paramtype>unordered_multiset<Value, H2, P2, Alloc>&&</paramtype>
|
|
</parameter>
|
|
<notes>
|
|
<para>Does not support merging with a compatible <code>unordered_set</code> yet.</para>
|
|
</notes>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="observers">
|
|
<method name="hash_function" cv="const">
|
|
<type>hasher</type>
|
|
<returns>The container's hash function.
|
|
</returns>
|
|
</method>
|
|
<method name="key_eq" cv="const">
|
|
<type>key_equal</type>
|
|
<returns>The container's key equality predicate.
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="lookup">
|
|
<overloaded-method name="find">
|
|
<signature>
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>const_iterator</type>
|
|
</signature>
|
|
<signature>
|
|
<template>
|
|
<template-type-parameter name="CompatibleKey"/>
|
|
<template-type-parameter name="CompatibleHash"/>
|
|
<template-type-parameter name="CompatiblePredicate"/>
|
|
</template>
|
|
<parameter name="k">
|
|
<paramtype>CompatibleKey const&</paramtype>
|
|
</parameter>
|
|
<parameter name="hash">
|
|
<paramtype>CompatibleHash const&</paramtype>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>CompatiblePredicate const&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<template>
|
|
<template-type-parameter name="CompatibleKey"/>
|
|
<template-type-parameter name="CompatibleHash"/>
|
|
<template-type-parameter name="CompatiblePredicate"/>
|
|
</template>
|
|
<parameter name="k">
|
|
<paramtype>CompatibleKey const&</paramtype>
|
|
</parameter>
|
|
<parameter name="hash">
|
|
<paramtype>CompatibleHash const&</paramtype>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>CompatiblePredicate const&</paramtype>
|
|
</parameter>
|
|
<type>const_iterator</type>
|
|
</signature>
|
|
<returns>
|
|
<para>An iterator pointing to an element with key equivalent to <code>k</code>, or <code>b.end()</code> if no such element exists.</para>
|
|
</returns>
|
|
<notes><para>
|
|
The templated overloads are a non-standard extensions which
|
|
allows you to use a compatible hash function and equality
|
|
predicate for a key of a different type in order to avoid
|
|
an expensive type cast. In general, its use is not encouraged.
|
|
</para></notes>
|
|
</overloaded-method>
|
|
<method name="count" cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>The number of elements with key equivalent to <code>k</code>.</para>
|
|
</returns>
|
|
</method>
|
|
<overloaded-method name="equal_range">
|
|
<signature>
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>std::pair<iterator, iterator></type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>std::pair<const_iterator, const_iterator></type>
|
|
</signature>
|
|
<returns>
|
|
<para>A range containing all elements with key equivalent to <code>k</code>.
|
|
If the container doesn't container any such elements, returns
|
|
<code><functionname>std::make_pair</functionname>(<methodname>b.end</methodname>(),<methodname>b.end</methodname>())</code>.
|
|
</para>
|
|
</returns>
|
|
</overloaded-method>
|
|
</method-group>
|
|
<method-group name="bucket interface">
|
|
<method name="bucket_count" cv="const">
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>The number of buckets.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="max_bucket_count" cv="const">
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>An upper bound on the number of buckets.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="bucket_size" cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<requires>
|
|
<para><code>n < <methodname>bucket_count</methodname>()</code></para>
|
|
</requires>
|
|
<returns>
|
|
<para>The number of elements in bucket <code>n</code>.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="bucket" cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>The index of the bucket which would contain an element with key <code>k</code>.</para>
|
|
</returns>
|
|
<postconditions>
|
|
<para>The return value is less than <code>bucket_count()</code></para>
|
|
</postconditions>
|
|
</method>
|
|
<overloaded-method name="begin">
|
|
<signature>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>local_iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
</signature>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A local iterator pointing the first element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</overloaded-method>
|
|
<overloaded-method name="end">
|
|
<signature>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>local_iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
</signature>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A local iterator pointing the 'one past the end' element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</overloaded-method>
|
|
<method name="cbegin" cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A constant local iterator pointing the first element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="cend">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A constant local iterator pointing the 'one past the end' element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="hash policy">
|
|
<method name="load_factor" cv="const">
|
|
<type>float</type>
|
|
<returns>
|
|
<para>The average number of elements per bucket.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="max_load_factor" cv="const">
|
|
<type>float</type>
|
|
<returns>
|
|
<para>Returns the current maximum load factor.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="max_load_factor">
|
|
<parameter name="z">
|
|
<paramtype>float</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<effects>
|
|
<para>Changes the container's maximum load factor, using <code>z</code> as a hint.</para>
|
|
</effects>
|
|
</method>
|
|
<method name="rehash">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Changes the number of buckets so that there at least <code>n</code> buckets, and so that the load factor is less than the maximum load factor.</para>
|
|
<para>Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated.</para>
|
|
</description>
|
|
<throws>
|
|
<para>The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="reserve">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated.</para>
|
|
</description>
|
|
<throws>
|
|
<para>The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function.</para>
|
|
</throws>
|
|
</method>
|
|
</method-group>
|
|
<free-function-group name="Equality Comparisons">
|
|
<function name="operator==">
|
|
<template>
|
|
<template-type-parameter name="Value">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="x">
|
|
<paramtype>unordered_multiset<Value, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<parameter name="y">
|
|
<paramtype>unordered_multiset<Value, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<type>bool</type>
|
|
<description>
|
|
<para>Return <code>true</code> if <code>x.size() ==
|
|
y.size</code> and for every equivalent key group in
|
|
<code>x</code>, there is a group in <code>y</code>
|
|
for the same key, which is a permutation (using
|
|
<code>operator==</code> to compare the value types).
|
|
</para>
|
|
</description>
|
|
<notes>
|
|
<para>The behavior of this function was changed to match
|
|
the C++11 standard in Boost 1.48.</para>
|
|
<para>Behavior is undefined if the two containers don't have
|
|
equivalent equality predicates.</para>
|
|
</notes>
|
|
</function>
|
|
<function name="operator!=">
|
|
<template>
|
|
<template-type-parameter name="Value">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="x">
|
|
<paramtype>unordered_multiset<Value, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<parameter name="y">
|
|
<paramtype>unordered_multiset<Value, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<type>bool</type>
|
|
<description>
|
|
<para>Return <code>false</code> if <code>x.size() ==
|
|
y.size</code> and for every equivalent key group in
|
|
<code>x</code>, there is a group in <code>y</code>
|
|
for the same key, which is a permutation (using
|
|
<code>operator==</code> to compare the value types).
|
|
</para>
|
|
</description>
|
|
<notes>
|
|
<para>The behavior of this function was changed to match
|
|
the C++11 standard in Boost 1.48.</para>
|
|
<para>Behavior is undefined if the two containers don't have
|
|
equivalent equality predicates.</para>
|
|
</notes>
|
|
</function>
|
|
</free-function-group>
|
|
<free-function-group name="swap">
|
|
<function name="swap">
|
|
<template>
|
|
<template-type-parameter name="Value">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="x">
|
|
<paramtype>unordered_multiset<Value, Hash, Pred, Alloc>&</paramtype>
|
|
</parameter>
|
|
<parameter name="y">
|
|
<paramtype>unordered_multiset<Value, Hash, Pred, Alloc>&</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<effects>
|
|
<para><code>x.swap(y)</code></para>
|
|
</effects>
|
|
<description>
|
|
<para>Swaps the contents of <code>x</code> and <code>y</code>.</para>
|
|
<para>If <code>Allocator::propagate_on_container_swap</code> is declared and
|
|
<code>Allocator::propagate_on_container_swap::value</code> is true then the
|
|
containers' allocators are swapped. Otherwise, swapping with unequal allocators
|
|
results in undefined behavior.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>key_equal</code> or <code>hasher</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The exception specifications aren't quite the same as the C++11 standard, as
|
|
the equality predieate and hash function are swapped using their copy constructors.</para>
|
|
</notes>
|
|
</function>
|
|
</free-function-group>
|
|
</class>
|
|
<namespace name="unordered">
|
|
<class name="node_handle_set">
|
|
<template pack="true">
|
|
<template-type-parameter name="ImplementationDefined"/>
|
|
</template>
|
|
<purpose>
|
|
<para>
|
|
An object that owns a single element extracted from an
|
|
<classname>unordered_set</classname> or an
|
|
<classname>unordered_multiset</classname>, that
|
|
can then be inserted into a compatible container type.
|
|
</para>
|
|
<para>
|
|
The name and template parameters of this type are implementation
|
|
defined, and should be obtained using the <code>node_type</code>
|
|
member typedef from the appropriate container.
|
|
</para>
|
|
</purpose>
|
|
<typedef name="value_type">
|
|
<type>typename Container::value_type></type>
|
|
</typedef>
|
|
<typedef name="allocator_type">
|
|
<type>typename Container::allocator_type></type>
|
|
</typedef>
|
|
<constructor specifiers="constexpr" cv="noexcept">
|
|
</constructor>
|
|
<destructor/>
|
|
<constructor cv="noexcept">
|
|
<parameter>
|
|
<paramtype>node_handle_set &&</paramtype>
|
|
</parameter>
|
|
</constructor>
|
|
<method name="operator=">
|
|
<parameter>
|
|
<paramtype>node_handle_set&&</paramtype>
|
|
</parameter>
|
|
<type>node_handle_set&</type>
|
|
</method>
|
|
<method name="value" cv="const">
|
|
<type>value_type&</type>
|
|
</method>
|
|
<method name="get_allocator" cv="const">
|
|
<type>allocator_type</type>
|
|
</method>
|
|
<method name="operator bool" specifiers="explicit" cv="const noexcept">
|
|
</method>
|
|
<method name="empty" cv="const noexcept">
|
|
<type>bool</type>
|
|
</method>
|
|
<method name="swap" cv="noexcept(ator_traits::propagate_on_container_swap::value)">
|
|
<parameter>
|
|
<paramtype>node_handle_set&</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<notes>
|
|
<para>
|
|
In C++17 is also <code>noexcept</code> if <code>ator_traits::is_always_equal::value</code> is true.
|
|
But we don't support that trait yet.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<free-function-group name="swap" cv="noexcept(noexcept(x.swap(y)))">
|
|
<function name="swap">
|
|
<template pack="true">
|
|
<template-type-parameter name="ImplementationDefined"/>
|
|
</template>
|
|
<parameter name="x">
|
|
<paramtype>node_handle_set<ImplementationDefined>&</paramtype>
|
|
</parameter>
|
|
<parameter name="y">
|
|
<paramtype>node_handle_set<ImplementationDefined>&</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<effects>
|
|
<para><code>x.swap(y)</code></para>
|
|
</effects>
|
|
</function>
|
|
</free-function-group>
|
|
</class>
|
|
</namespace>
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/unordered_map.hpp">
|
|
<namespace name="boost">
|
|
<class name="unordered_map">
|
|
<template>
|
|
<template-type-parameter name="Key">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Mapped">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
<default><type>boost::hash<Key></type></default>
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
<default><type>std::equal_to<Key></type></default>
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
<default><type>std::allocator<std::pair<Key const, Mapped>></type></default>
|
|
</template-type-parameter>
|
|
</template>
|
|
<purpose><simpara>
|
|
An unordered associative container that associates unique keys with another value.
|
|
</simpara></purpose>
|
|
<description>
|
|
<para><emphasis role="bold">Template Parameters</emphasis>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<tbody>
|
|
<row>
|
|
<entry><emphasis>Key</emphasis></entry>
|
|
<entry><code>Key</code> must be <code>Erasable</code> from the container
|
|
(i.e. <code>allocator_traits</code> can <code>destroy</code> it).
|
|
</entry></row>
|
|
<row>
|
|
<entry><emphasis>Mapped</emphasis></entry>
|
|
<entry><code>Mapped</code> must be <code>Erasable</code> from the container
|
|
(i.e. <code>allocator_traits</code> can <code>destroy</code> it).
|
|
</entry></row>
|
|
<row>
|
|
<entry><emphasis>Hash</emphasis></entry>
|
|
<entry>A unary function object type that acts a hash function for a <code>Key</code>. It takes a single argument of type <code>Key</code> and returns a value of type std::size_t.</entry></row>
|
|
<row>
|
|
<entry><emphasis>Pred</emphasis></entry>
|
|
<entry>A binary function object that implements an equivalence relation on values of type <code>Key</code>.
|
|
A binary function object that induces an equivalence relation on values of type <code>Key</code>.
|
|
It takes two arguments of type <code>Key</code> and returns a value of type bool.</entry></row>
|
|
<row>
|
|
<entry><emphasis>Alloc</emphasis></entry>
|
|
<entry>An allocator whose value type is the same as the container's value type.</entry></row></tbody></tgroup></informaltable></para>
|
|
<para>The elements are organized into buckets. Keys with the same hash code are stored in the same bucket.</para>
|
|
<para>The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash.</para>
|
|
</description>
|
|
<typedef name="key_type">
|
|
<type>Key</type>
|
|
</typedef>
|
|
<typedef name="value_type">
|
|
<type>std::pair<Key const, Mapped></type>
|
|
</typedef>
|
|
<typedef name="mapped_type">
|
|
<type>Mapped</type>
|
|
</typedef>
|
|
<typedef name="hasher">
|
|
<type>Hash</type>
|
|
</typedef>
|
|
<typedef name="key_equal">
|
|
<type>Pred</type>
|
|
</typedef>
|
|
<typedef name="allocator_type">
|
|
<type>Alloc</type>
|
|
</typedef>
|
|
<typedef name="pointer">
|
|
<type>typename allocator_type::pointer</type>
|
|
<description>
|
|
<para>
|
|
<code>value_type*</code> if
|
|
<code>allocator_type::pointer</code> is not defined.
|
|
</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="const_pointer">
|
|
<type>typename allocator_type::const_pointer</type>
|
|
<description>
|
|
<para>
|
|
<code>boost::pointer_to_other<pointer, value_type>::type</code>
|
|
if <code>allocator_type::const_pointer</code> is not defined.
|
|
</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="reference">
|
|
<type>value_type&</type>
|
|
<purpose><simpara>lvalue of <type>value_type</type>.</simpara></purpose>
|
|
</typedef>
|
|
<typedef name="const_reference">
|
|
<type>value_type const&</type>
|
|
<purpose><simpara>const lvalue of <type>value_type</type>.</simpara></purpose>
|
|
</typedef>
|
|
<typedef name="size_type">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>An unsigned integral type.</para>
|
|
<para><type>size_type</type> can represent any non-negative value of <type>difference_type</type>.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="difference_type">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>A signed integral type.</para>
|
|
<para>Is identical to the difference type of <type>iterator</type> and <type>const_iterator</type>.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>An iterator whose value type is <type>value_type</type>. </para>
|
|
<para>The iterator category is at least a forward iterator.</para>
|
|
<para>Convertible to <type>const_iterator</type>.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="const_iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>A constant iterator whose value type is <type>value_type</type>. </para>
|
|
<para>The iterator category is at least a forward iterator.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="local_iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>An iterator with the same value type, difference type and pointer and reference type as <type>iterator</type>.</para>
|
|
<para>A local_iterator object can be used to iterate through a single bucket.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="const_local_iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>A constant iterator with the same value type, difference type and pointer and reference type as <type>const_iterator</type>.</para>
|
|
<para>A const_local_iterator object can be used to iterate through a single bucket.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="node_type">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>See <classname>node_handle_map</classname> for details.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="insert_return_type">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
Structure returned by inserting <code>node_type</code>.
|
|
</description>
|
|
</typedef>
|
|
<constructor>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>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.</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor specifiers="explicit">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
<default>hasher()</default>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>key_equal const&</paramtype>
|
|
<default>key_equal()</default>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
<default>allocator_type()</default>
|
|
</parameter>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>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.</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="f">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="l">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
<default><emphasis>implementation-defined</emphasis></default>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
<default>hasher()</default>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>key_equal const&</paramtype>
|
|
<default>key_equal()</default>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
<default>allocator_type()</default>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
<code>eq</code> as the key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0
|
|
and inserts the elements from [f, l) into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter>
|
|
<paramtype>unordered_map const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator.</para>
|
|
<para>If <code>Allocator::select_on_container_copy_construction</code>
|
|
exists and has the right signature, the allocator will be
|
|
constructed from its result.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is copy constructible</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter>
|
|
<paramtype>unordered_map &&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>The move constructor.</para>
|
|
</description>
|
|
<notes>
|
|
<para>This is implemented using Boost.Move.</para>
|
|
</notes>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is move constructible.
|
|
</para>
|
|
<para>
|
|
On compilers without rvalue reference support the
|
|
emulation does not support moving without calling
|
|
<code>boost::move</code> if <code>value_type</code> is
|
|
not copyable. So, for example, you can't return the
|
|
container from a function.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor specifiers="explicit">
|
|
<parameter name="a">
|
|
<paramtype>Allocator const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container, using allocator <code>a</code>.</para>
|
|
</description>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="x">
|
|
<paramtype>unordered_map const&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>Allocator const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an container, copying <code>x</code>'s contained elements, hash function, predicate, maximum load factor, but using allocator <code>a</code>.</para>
|
|
</description>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="x">
|
|
<paramtype>unordered_map &&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>Allocator const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Construct a container moving <code>x</code>'s contained elements, and having the hash function, predicate and maximum load factor, but using allocate <code>a</code>.</para>
|
|
</description>
|
|
<notes>
|
|
<para>This is implemented using Boost.Move.</para>
|
|
</notes>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is move insertable.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="il">
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
<default><emphasis>implementation-defined</emphasis></default>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
<default>hasher()</default>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>key_equal const&</paramtype>
|
|
<default>key_equal()</default>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
<default>allocator_type()</default>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
<code>eq</code> as the key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0
|
|
and inserts the elements from <code>il</code> into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
the default hash function and key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>hasher</code> and <code>key_equal</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
the default key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>key_equal</code> needs to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="f">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="l">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>a</code> as the allocator, with the
|
|
default hash function and key equality predicate
|
|
and a maximum load factor of 1.0
|
|
and inserts the elements from [f, l) into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>hasher</code>, <code>key_equal</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="f">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="l">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
<code>a</code> as the allocator, with the
|
|
default key equality predicate
|
|
and a maximum load factor of 1.0
|
|
and inserts the elements from [f, l) into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>key_equal</code> needs to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<destructor>
|
|
<notes>
|
|
<para>The destructor is applied to every element, and all memory is deallocated</para>
|
|
</notes>
|
|
</destructor>
|
|
<method name="operator=">
|
|
<parameter>
|
|
<paramtype>unordered_map const&</paramtype>
|
|
</parameter>
|
|
<type>unordered_map&</type>
|
|
<description>
|
|
<para>The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator.</para>
|
|
<para>If <code>Alloc::propagate_on_container_copy_assignment</code>
|
|
exists and <code>Alloc::propagate_on_container_copy_assignment::value
|
|
</code> is true, the allocator is overwritten, if not the
|
|
copied elements are created using the existing
|
|
allocator.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is copy constructible</para>
|
|
</requires>
|
|
</method>
|
|
<method name="operator=">
|
|
<parameter>
|
|
<paramtype>unordered_map &&</paramtype>
|
|
</parameter>
|
|
<type>unordered_map&</type>
|
|
<description>
|
|
<para>The move assignment operator.</para>
|
|
<para>If <code>Alloc::propagate_on_container_move_assignment</code>
|
|
exists and <code>Alloc::propagate_on_container_move_assignment::value
|
|
</code> is true, the allocator is overwritten, if not the
|
|
moved elements are created using the existing
|
|
allocator.</para>
|
|
</description>
|
|
<notes>
|
|
<para>
|
|
On compilers without rvalue references, this is emulated using
|
|
Boost.Move. Note that on some compilers the copy assignment
|
|
operator may be used in some circumstances.
|
|
</para>
|
|
</notes>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is move constructible.
|
|
</para>
|
|
</requires>
|
|
</method>
|
|
<method name="operator=">
|
|
<parameter>
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<type>unordered_map&</type>
|
|
<description>
|
|
<para>Assign from values in initializer list. All existing elements are either overwritten by the new elements or destroyed.</para>
|
|
</description>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is <code>CopyInsertable</code> into the container and
|
|
<code>CopyAssignable</code>.
|
|
</para>
|
|
</requires>
|
|
</method>
|
|
<method name="get_allocator" cv="const">
|
|
<type>allocator_type</type>
|
|
</method>
|
|
<method-group name="size and capacity">
|
|
<method name="empty" cv="const">
|
|
<type>bool</type>
|
|
<returns>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</returns>
|
|
</method>
|
|
<method name="size" cv="const">
|
|
<type>size_type</type>
|
|
<returns>
|
|
<code>std::distance(<methodname>begin</methodname>(), <methodname>end</methodname>())</code>
|
|
</returns>
|
|
</method>
|
|
<method name="max_size" cv="const">
|
|
<type>size_type</type>
|
|
<returns><code><methodname>size</methodname>()</code> of the largest possible container.
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="iterators">
|
|
<overloaded-method name="begin">
|
|
<signature><type>iterator</type></signature>
|
|
<signature cv="const"><type>const_iterator</type></signature>
|
|
<returns>An iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container.
|
|
</returns>
|
|
</overloaded-method>
|
|
<overloaded-method name="end">
|
|
<signature>
|
|
<type>iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<type>const_iterator</type>
|
|
</signature>
|
|
<returns>An iterator which refers to the past-the-end value for the container.
|
|
</returns>
|
|
</overloaded-method>
|
|
<method name="cbegin" cv="const">
|
|
<type>const_iterator</type>
|
|
<returns>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.
|
|
</returns>
|
|
</method>
|
|
<method name="cend" cv="const">
|
|
<type>const_iterator</type>
|
|
<returns>A constant iterator which refers to the past-the-end value for the container.
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="modifiers">
|
|
<method name="emplace">
|
|
<template>
|
|
<template-type-parameter name="Args" pack="1">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="args" pack="1">
|
|
<paramtype>Args&&</paramtype>
|
|
</parameter>
|
|
<type>std::pair<iterator, bool></type>
|
|
<description>
|
|
<para>Inserts an object, constructed with the arguments <code>args</code>, in the container if and only if there is no element in the container with an equivalent key.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>args</code>.
|
|
</para>
|
|
</requires>
|
|
<returns>
|
|
<para>The bool component of the return type is true if an insert took place.</para>
|
|
<para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>If the compiler doesn't support variadic template arguments or rvalue
|
|
references, this is emulated for up to 10 arguments, with no support
|
|
for rvalue references or move semantics.</para>
|
|
<para>Since existing <code>std::pair</code> implementations don't support
|
|
<code>std::piecewise_construct</code> this emulates it,
|
|
but using <code>boost::unordered::piecewise_construct</code>.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="emplace_hint">
|
|
<template>
|
|
<template-type-parameter name="Args" pack="1">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="args" pack="1">
|
|
<paramtype>Args&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts an object, constructed with the arguments <code>args</code>, in the container if and only if there is no element in the container with an equivalent key.</para>
|
|
<para><code>hint</code> is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>args</code>.
|
|
</para>
|
|
</requires>
|
|
<returns>
|
|
<para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>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. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>If the compiler doesn't support variadic template arguments or rvalue
|
|
references, this is emulated for up to 10 arguments, with no support
|
|
for rvalue references or move semantics.</para>
|
|
<para>Since existing <code>std::pair</code> implementations don't support
|
|
<code>std::piecewise_construct</code> this emulates it,
|
|
but using <code>boost::unordered::piecewise_construct</code>.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="obj">
|
|
<paramtype>value_type const&</paramtype>
|
|
</parameter>
|
|
<type>std::pair<iterator, bool></type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container if and only if there is no element in the container with an equivalent key.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>CopyInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>The bool component of the return type is true if an insert took place.</para>
|
|
<para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="obj">
|
|
<paramtype>value_type&&</paramtype>
|
|
</parameter>
|
|
<type>std::pair<iterator, bool></type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container if and only if there is no element in the container with an equivalent key.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>MoveInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>The bool component of the return type is true if an insert took place.</para>
|
|
<para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="obj">
|
|
<paramtype>value_type const&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container if and only if there is no element in the container with an equivalent key.</para>
|
|
<para>hint is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>CopyInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>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. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="obj">
|
|
<paramtype>value_type&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container if and only if there is no element in the container with an equivalent key.</para>
|
|
<para>hint is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>MoveInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>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. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="first">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="last">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>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.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>*first</code>.</para>
|
|
</requires>
|
|
<throws>
|
|
<para>When inserting a single element, if an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="il">
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>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.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>*first</code>.</para>
|
|
</requires>
|
|
<throws>
|
|
<para>When inserting a single element, if an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="il">
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>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.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>*first</code>.</para>
|
|
</requires>
|
|
<throws>
|
|
<para>When inserting a single element, if an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="extract">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>node_type</type>
|
|
<description>
|
|
<para>Removes the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>A <code>node_type</code> owning the element.</para>
|
|
</returns>
|
|
<notes>
|
|
<para>
|
|
In C++17 a node extracted using this method can be inserted into a compatible <code>unordered_multimap</code>,
|
|
but that is not supported yet.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="extract">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>node_type</type>
|
|
<description>
|
|
<para>Removes an element with key equivalent to <code>k</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>A <code>node_type</code> owning the element if found, otherwise an empty <code>node_type</code>.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
In C++17 a node extracted using this method can be inserted into a compatible <code>unordered_multimap</code>,
|
|
but that is not supported yet.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="nh">
|
|
<paramtype>node_type&&</paramtype>
|
|
</parameter>
|
|
<type>insert_return_type</type>
|
|
<description>
|
|
<para>If <code>nh</code> is empty, has no affect.</para>
|
|
<para>Otherwise inserts the element owned by <code>nh</code>
|
|
if and only if there is no element in the container with an equivalent key.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>nh</code> is empty or <code>nh.get_allocator()</code> is equal to the container's allocator.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>If <code>nh</code> was empty, returns an <code>insert_return_type</code> with:
|
|
<code>inserted</code> equal to <code>false</code>,
|
|
<code>position</code> equal to <code>end()</code> and
|
|
<code>node</code> empty.</para>
|
|
<para>Otherwise if there was already an element with an equivalent key, returns an <code>insert_return_type</code> with:
|
|
<code>inserted</code> equal to <code>false</code>,
|
|
<code>position</code> pointing to a matching element and
|
|
<code>node</code> contains the node from <code>nh</code>.</para>
|
|
<para>Otherwise if the insertion succeeded, returns an <code>insert_return_type</code> with:
|
|
<code>inserted</code> equal to <code>true</code>,
|
|
<code>position</code> pointing to the newly inserted element and
|
|
<code>node</code> empty.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>In C++17 this can be used to insert a node extracted from a compatible <code>unordered_multimap</code>,
|
|
but that is not supported yet.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="nh">
|
|
<paramtype>node_type&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>If <code>nh</code> is empty, has no affect.</para>
|
|
<para>Otherwise inserts the element owned by <code>nh</code>
|
|
if and only if there is no element in the container with an equivalent key.
|
|
</para>
|
|
<para>If there is already an element in the container with an equivalent key has no effect on <code>nh</code> (i.e. <code>nh</code> still contains the node.)</para>
|
|
<para>hint is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>nh</code> is empty or <code>nh.get_allocator()</code> is equal to the container's allocator.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>If <code>nh</code> was empty returns <code>end()</code>.</para>
|
|
<para>If there was already an element in the container with an equivalent key returns an iterator pointing to that.</para>
|
|
<para>Otherwise returns an iterator pointing to the newly inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>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. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>In C++17 this can be used to insert a node extracted from a compatible <code>unordered_multimap</code>,
|
|
but that is not supported yet.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="erase">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Erase the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>The iterator following <code>position</code> before the erasure.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
In older versions this could be inefficient because it had to search
|
|
through several buckets to find the position of the returned iterator.
|
|
The data structure has been changed so that this is no longer the case,
|
|
and the alternative erase methods have been deprecated.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="erase">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<description>
|
|
<para>Erase all elements with key equivalent to <code>k</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>The number of elements erased.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="erase">
|
|
<parameter name="first">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="last">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Erases the elements in the range from <code>first</code> to <code>last</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>The iterator following the erased elements - i.e. <code>last</code>.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
<para>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.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="quick_erase">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Erase the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
<para>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.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
This method was implemented because returning an iterator to
|
|
the next element from <code>erase</code> was expensive, but
|
|
the container has been redesigned so that is no longer the
|
|
case. So this method is now deprecated.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="erase_return_void">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Erase the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
<para>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.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
This method was implemented because returning an iterator to
|
|
the next element from <code>erase</code> was expensive, but
|
|
the container has been redesigned so that is no longer the
|
|
case. So this method is now deprecated.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="clear">
|
|
<type>void</type>
|
|
<description>
|
|
<para>Erases all elements in the container.</para>
|
|
</description>
|
|
<postconditions>
|
|
<para><code><methodname>size</methodname>() == 0</code></para>
|
|
</postconditions>
|
|
<throws>
|
|
<para>Never throws an exception.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="swap">
|
|
<parameter>
|
|
<paramtype>unordered_map&</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Swaps the contents of the container with the parameter.</para>
|
|
<para>If <code>Allocator::propagate_on_container_swap</code> is declared and
|
|
<code>Allocator::propagate_on_container_swap::value</code> is true then the
|
|
containers' allocators are swapped. Otherwise, swapping with unequal allocators
|
|
results in undefined behavior.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>key_equal</code> or <code>hasher</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The exception specifications aren't quite the same as the C++11 standard, as
|
|
the equality predieate and hash function are swapped using their copy constructors.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="merge">
|
|
<template>
|
|
<template-type-parameter name="H2">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="P2">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="source">
|
|
<paramtype>unordered_map<Key, Mapped, H2, P2, Alloc>&</paramtype>
|
|
</parameter>
|
|
<notes>
|
|
<para>Does not support merging with a compatible <code>unordered_multimap</code> yet.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="merge">
|
|
<template>
|
|
<template-type-parameter name="H2">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="P2">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="source">
|
|
<paramtype>unordered_map<Key, Mapped, H2, P2, Alloc>&&</paramtype>
|
|
</parameter>
|
|
<notes>
|
|
<para>Does not support merging with a compatible <code>unordered_multimap</code> yet.</para>
|
|
</notes>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="observers">
|
|
<method name="hash_function" cv="const">
|
|
<type>hasher</type>
|
|
<returns>The container's hash function.
|
|
</returns>
|
|
</method>
|
|
<method name="key_eq" cv="const">
|
|
<type>key_equal</type>
|
|
<returns>The container's key equality predicate.
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="lookup">
|
|
<overloaded-method name="find">
|
|
<signature>
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>const_iterator</type>
|
|
</signature>
|
|
<signature>
|
|
<template>
|
|
<template-type-parameter name="CompatibleKey"/>
|
|
<template-type-parameter name="CompatibleHash"/>
|
|
<template-type-parameter name="CompatiblePredicate"/>
|
|
</template>
|
|
<parameter name="k">
|
|
<paramtype>CompatibleKey const&</paramtype>
|
|
</parameter>
|
|
<parameter name="hash">
|
|
<paramtype>CompatibleHash const&</paramtype>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>CompatiblePredicate const&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<template>
|
|
<template-type-parameter name="CompatibleKey"/>
|
|
<template-type-parameter name="CompatibleHash"/>
|
|
<template-type-parameter name="CompatiblePredicate"/>
|
|
</template>
|
|
<parameter name="k">
|
|
<paramtype>CompatibleKey const&</paramtype>
|
|
</parameter>
|
|
<parameter name="hash">
|
|
<paramtype>CompatibleHash const&</paramtype>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>CompatiblePredicate const&</paramtype>
|
|
</parameter>
|
|
<type>const_iterator</type>
|
|
</signature>
|
|
<returns>
|
|
<para>An iterator pointing to an element with key equivalent to <code>k</code>, or <code>b.end()</code> if no such element exists.</para>
|
|
</returns>
|
|
<notes><para>
|
|
The templated overloads are a non-standard extensions which
|
|
allows you to use a compatible hash function and equality
|
|
predicate for a key of a different type in order to avoid
|
|
an expensive type cast. In general, its use is not encouraged.
|
|
</para></notes>
|
|
</overloaded-method>
|
|
<method name="count" cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>The number of elements with key equivalent to <code>k</code>.</para>
|
|
</returns>
|
|
</method>
|
|
<overloaded-method name="equal_range">
|
|
<signature>
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>std::pair<iterator, iterator></type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>std::pair<const_iterator, const_iterator></type>
|
|
</signature>
|
|
<returns>
|
|
<para>A range containing all elements with key equivalent to <code>k</code>.
|
|
If the container doesn't container any such elements, returns
|
|
<code><functionname>std::make_pair</functionname>(<methodname>b.end</methodname>(),<methodname>b.end</methodname>())</code>.
|
|
</para>
|
|
</returns>
|
|
</overloaded-method>
|
|
<method name="operator[]">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>mapped_type&</type>
|
|
<effects>
|
|
<para>If the container does not already contain an elements with a key equivalent to <code>k</code>, inserts the value <code>std::pair<key_type const, mapped_type>(k, mapped_type())</code></para>
|
|
</effects>
|
|
<returns>
|
|
<para>A reference to <code>x.second</code> where x is the element already in the container, or the newly inserted element with a key equivalent to <code>k</code></para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<overloaded-method name="at">
|
|
<signature><type>Mapped&</type>
|
|
<parameter name="k"><paramtype>key_type const&</paramtype></parameter></signature>
|
|
<signature cv="const"><type>Mapped const&</type>
|
|
<parameter name="k"><paramtype>key_type const&</paramtype></parameter></signature>
|
|
<returns>
|
|
<para>A reference to <code>x.second</code> where <code>x</code> is the (unique) element whose key is equivalent to <code>k</code>.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>An exception object of type <code>std::out_of_range</code> if no such element is present.</para>
|
|
</throws>
|
|
</overloaded-method>
|
|
</method-group>
|
|
<method-group name="bucket interface">
|
|
<method name="bucket_count" cv="const">
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>The number of buckets.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="max_bucket_count" cv="const">
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>An upper bound on the number of buckets.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="bucket_size" cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<requires>
|
|
<para><code>n < <methodname>bucket_count</methodname>()</code></para>
|
|
</requires>
|
|
<returns>
|
|
<para>The number of elements in bucket <code>n</code>.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="bucket" cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>The index of the bucket which would contain an element with key <code>k</code>.</para>
|
|
</returns>
|
|
<postconditions>
|
|
<para>The return value is less than <code>bucket_count()</code></para>
|
|
</postconditions>
|
|
</method>
|
|
<overloaded-method name="begin">
|
|
<signature>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>local_iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
</signature>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A local iterator pointing the first element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</overloaded-method>
|
|
<overloaded-method name="end">
|
|
<signature>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>local_iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
</signature>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A local iterator pointing the 'one past the end' element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</overloaded-method>
|
|
<method name="cbegin" cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A constant local iterator pointing the first element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="cend">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A constant local iterator pointing the 'one past the end' element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="hash policy">
|
|
<method name="load_factor" cv="const">
|
|
<type>float</type>
|
|
<returns>
|
|
<para>The average number of elements per bucket.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="max_load_factor" cv="const">
|
|
<type>float</type>
|
|
<returns>
|
|
<para>Returns the current maximum load factor.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="max_load_factor">
|
|
<parameter name="z">
|
|
<paramtype>float</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<effects>
|
|
<para>Changes the container's maximum load factor, using <code>z</code> as a hint.</para>
|
|
</effects>
|
|
</method>
|
|
<method name="rehash">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Changes the number of buckets so that there at least <code>n</code> buckets, and so that the load factor is less than the maximum load factor.</para>
|
|
<para>Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated.</para>
|
|
</description>
|
|
<throws>
|
|
<para>The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="reserve">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated.</para>
|
|
</description>
|
|
<throws>
|
|
<para>The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function.</para>
|
|
</throws>
|
|
</method>
|
|
</method-group>
|
|
<free-function-group name="Equality Comparisons">
|
|
<function name="operator==">
|
|
<template>
|
|
<template-type-parameter name="Key">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Mapped">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="x">
|
|
<paramtype>unordered_map<Key, Mapped, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<parameter name="y">
|
|
<paramtype>unordered_map<Key, Mapped, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<type>bool</type>
|
|
<description>
|
|
<para>Return <code>true</code> if <code>x.size() ==
|
|
y.size</code> and for every element in <code>x</code>,
|
|
there is an element in <code>y</code> with the same
|
|
for the same key, with an equal value (using
|
|
<code>operator==</code> to compare the value types).
|
|
</para>
|
|
</description>
|
|
<notes>
|
|
<para>The behavior of this function was changed to match
|
|
the C++11 standard in Boost 1.48.</para>
|
|
<para>Behavior is undefined if the two containers don't have
|
|
equivalent equality predicates.</para>
|
|
</notes>
|
|
</function>
|
|
<function name="operator!=">
|
|
<template>
|
|
<template-type-parameter name="Key">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Mapped">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="x">
|
|
<paramtype>unordered_map<Key, Mapped, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<parameter name="y">
|
|
<paramtype>unordered_map<Key, Mapped, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<type>bool</type>
|
|
<description>
|
|
<para>Return <code>false</code> if <code>x.size() ==
|
|
y.size</code> and for every element in <code>x</code>,
|
|
there is an element in <code>y</code> with the same
|
|
for the same key, with an equal value (using
|
|
<code>operator==</code> to compare the value types).
|
|
</para>
|
|
</description>
|
|
<notes>
|
|
<para>The behavior of this function was changed to match
|
|
the C++11 standard in Boost 1.48.</para>
|
|
<para>Behavior is undefined if the two containers don't have
|
|
equivalent equality predicates.</para>
|
|
</notes>
|
|
</function>
|
|
</free-function-group>
|
|
<free-function-group name="swap">
|
|
<function name="swap">
|
|
<template>
|
|
<template-type-parameter name="Key">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Mapped">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="x">
|
|
<paramtype>unordered_map<Key, Mapped, Hash, Pred, Alloc>&</paramtype>
|
|
</parameter>
|
|
<parameter name="y">
|
|
<paramtype>unordered_map<Key, Mapped, Hash, Pred, Alloc>&</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<effects>
|
|
<para><code>x.swap(y)</code></para>
|
|
</effects>
|
|
<description>
|
|
<para>Swaps the contents of <code>x</code> and <code>y</code>.</para>
|
|
<para>If <code>Allocator::propagate_on_container_swap</code> is declared and
|
|
<code>Allocator::propagate_on_container_swap::value</code> is true then the
|
|
containers' allocators are swapped. Otherwise, swapping with unequal allocators
|
|
results in undefined behavior.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>key_equal</code> or <code>hasher</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The exception specifications aren't quite the same as the C++11 standard, as
|
|
the equality predieate and hash function are swapped using their copy constructors.</para>
|
|
</notes>
|
|
</function>
|
|
</free-function-group>
|
|
</class>
|
|
<class name="unordered_multimap">
|
|
<template>
|
|
<template-type-parameter name="Key">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Mapped">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
<default><type>boost::hash<Key></type></default>
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
<default><type>std::equal_to<Key></type></default>
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
<default><type>std::allocator<std::pair<Key const, Mapped>></type></default>
|
|
</template-type-parameter>
|
|
</template>
|
|
<purpose><simpara>
|
|
An unordered associative container that associates keys with another value. The same key can be stored multiple times.
|
|
</simpara></purpose>
|
|
<description>
|
|
<para><emphasis role="bold">Template Parameters</emphasis>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<tbody>
|
|
<row>
|
|
<entry><emphasis>Key</emphasis></entry>
|
|
<entry><code>Key</code> must be <code>Erasable</code> from the container
|
|
(i.e. <code>allocator_traits</code> can <code>destroy</code> it).
|
|
</entry></row>
|
|
<row>
|
|
<entry><emphasis>Mapped</emphasis></entry>
|
|
<entry><code>Mapped</code> must be <code>Erasable</code> from the container
|
|
(i.e. <code>allocator_traits</code> can <code>destroy</code> it).
|
|
</entry></row>
|
|
<row>
|
|
<entry><emphasis>Hash</emphasis></entry>
|
|
<entry>A unary function object type that acts a hash function for a <code>Key</code>. It takes a single argument of type <code>Key</code> and returns a value of type std::size_t.</entry></row>
|
|
<row>
|
|
<entry><emphasis>Pred</emphasis></entry>
|
|
<entry>A binary function object that implements an equivalence relation on values of type <code>Key</code>.
|
|
A binary function object that induces an equivalence relation on values of type <code>Key</code>.
|
|
It takes two arguments of type <code>Key</code> and returns a value of type bool.</entry></row>
|
|
<row>
|
|
<entry><emphasis>Alloc</emphasis></entry>
|
|
<entry>An allocator whose value type is the same as the container's value type.</entry></row></tbody></tgroup></informaltable></para>
|
|
<para>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.</para>
|
|
<para>The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash.</para>
|
|
</description>
|
|
<typedef name="key_type">
|
|
<type>Key</type>
|
|
</typedef>
|
|
<typedef name="value_type">
|
|
<type>std::pair<Key const, Mapped></type>
|
|
</typedef>
|
|
<typedef name="mapped_type">
|
|
<type>Mapped</type>
|
|
</typedef>
|
|
<typedef name="hasher">
|
|
<type>Hash</type>
|
|
</typedef>
|
|
<typedef name="key_equal">
|
|
<type>Pred</type>
|
|
</typedef>
|
|
<typedef name="allocator_type">
|
|
<type>Alloc</type>
|
|
</typedef>
|
|
<typedef name="pointer">
|
|
<type>typename allocator_type::pointer</type>
|
|
<description>
|
|
<para>
|
|
<code>value_type*</code> if
|
|
<code>allocator_type::pointer</code> is not defined.
|
|
</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="const_pointer">
|
|
<type>typename allocator_type::const_pointer</type>
|
|
<description>
|
|
<para>
|
|
<code>boost::pointer_to_other<pointer, value_type>::type</code>
|
|
if <code>allocator_type::const_pointer</code> is not defined.
|
|
</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="reference">
|
|
<type>value_type&</type>
|
|
<purpose><simpara>lvalue of <type>value_type</type>.</simpara></purpose>
|
|
</typedef>
|
|
<typedef name="const_reference">
|
|
<type>value_type const&</type>
|
|
<purpose><simpara>const lvalue of <type>value_type</type>.</simpara></purpose>
|
|
</typedef>
|
|
<typedef name="size_type">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>An unsigned integral type.</para>
|
|
<para><type>size_type</type> can represent any non-negative value of <type>difference_type</type>.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="difference_type">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>A signed integral type.</para>
|
|
<para>Is identical to the difference type of <type>iterator</type> and <type>const_iterator</type>.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>An iterator whose value type is <type>value_type</type>. </para>
|
|
<para>The iterator category is at least a forward iterator.</para>
|
|
<para>Convertible to <type>const_iterator</type>.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="const_iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>A constant iterator whose value type is <type>value_type</type>. </para>
|
|
<para>The iterator category is at least a forward iterator.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="local_iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>An iterator with the same value type, difference type and pointer and reference type as <type>iterator</type>.</para>
|
|
<para>A local_iterator object can be used to iterate through a single bucket.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="const_local_iterator">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>A constant iterator with the same value type, difference type and pointer and reference type as <type>const_iterator</type>.</para>
|
|
<para>A const_local_iterator object can be used to iterate through a single bucket.</para>
|
|
</description>
|
|
</typedef>
|
|
<typedef name="node_type">
|
|
<type><emphasis>implementation-defined</emphasis></type>
|
|
<description>
|
|
<para>See <classname>node_handle_map</classname> for details.</para>
|
|
</description>
|
|
</typedef>
|
|
<constructor>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>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.</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor specifiers="explicit">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
<default>hasher()</default>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>key_equal const&</paramtype>
|
|
<default>key_equal()</default>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
<default>allocator_type()</default>
|
|
</parameter>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>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.</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="f">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="l">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
<default><emphasis>implementation-defined</emphasis></default>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
<default>hasher()</default>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>key_equal const&</paramtype>
|
|
<default>key_equal()</default>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
<default>allocator_type()</default>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
<code>eq</code> as the key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0
|
|
and inserts the elements from [f, l) into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter>
|
|
<paramtype>unordered_multimap const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator.</para>
|
|
<para>If <code>Allocator::select_on_container_copy_construction</code>
|
|
exists and has the right signature, the allocator will be
|
|
constructed from its result.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is copy constructible</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter>
|
|
<paramtype>unordered_multimap &&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>The move constructor.</para>
|
|
</description>
|
|
<notes>
|
|
<para>This is implemented using Boost.Move.</para>
|
|
</notes>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is move constructible.
|
|
</para>
|
|
<para>
|
|
On compilers without rvalue reference support the
|
|
emulation does not support moving without calling
|
|
<code>boost::move</code> if <code>value_type</code> is
|
|
not copyable. So, for example, you can't return the
|
|
container from a function.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor specifiers="explicit">
|
|
<parameter name="a">
|
|
<paramtype>Allocator const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container, using allocator <code>a</code>.</para>
|
|
</description>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="x">
|
|
<paramtype>unordered_multimap const&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>Allocator const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an container, copying <code>x</code>'s contained elements, hash function, predicate, maximum load factor, but using allocator <code>a</code>.</para>
|
|
</description>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="x">
|
|
<paramtype>unordered_multimap &&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>Allocator const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Construct a container moving <code>x</code>'s contained elements, and having the hash function, predicate and maximum load factor, but using allocate <code>a</code>.</para>
|
|
</description>
|
|
<notes>
|
|
<para>This is implemented using Boost.Move.</para>
|
|
</notes>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is move insertable.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="il">
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
<default><emphasis>implementation-defined</emphasis></default>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
<default>hasher()</default>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>key_equal const&</paramtype>
|
|
<default>key_equal()</default>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
<default>allocator_type()</default>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
<code>eq</code> as the key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0
|
|
and inserts the elements from <code>il</code> into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para>If the defaults are used, <code>hasher</code>, <code>key_equal</code> and
|
|
<code>allocator_type</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
the default hash function and key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>hasher</code> and <code>key_equal</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<postconditions>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</postconditions>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
the default key equality predicate,
|
|
<code>a</code> as the allocator and a maximum load factor of 1.0.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>key_equal</code> needs to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="f">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="l">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>a</code> as the allocator, with the
|
|
default hash function and key equality predicate
|
|
and a maximum load factor of 1.0
|
|
and inserts the elements from [f, l) into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>hasher</code>, <code>key_equal</code> need to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<constructor>
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="f">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="l">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<parameter name="hf">
|
|
<paramtype>hasher const&</paramtype>
|
|
</parameter>
|
|
<parameter name="a">
|
|
<paramtype>allocator_type const&</paramtype>
|
|
</parameter>
|
|
<description>
|
|
<para>Constructs an empty container with at least <code>n</code> buckets,
|
|
using <code>hf</code> as the hash function,
|
|
<code>a</code> as the allocator, with the
|
|
default key equality predicate
|
|
and a maximum load factor of 1.0
|
|
and inserts the elements from [f, l) into it.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>key_equal</code> needs to be <code>DefaultConstructible</code>.
|
|
</para>
|
|
</requires>
|
|
</constructor>
|
|
<destructor>
|
|
<notes>
|
|
<para>The destructor is applied to every element, and all memory is deallocated</para>
|
|
</notes>
|
|
</destructor>
|
|
<method name="operator=">
|
|
<parameter>
|
|
<paramtype>unordered_multimap const&</paramtype>
|
|
</parameter>
|
|
<type>unordered_multimap&</type>
|
|
<description>
|
|
<para>The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator.</para>
|
|
<para>If <code>Alloc::propagate_on_container_copy_assignment</code>
|
|
exists and <code>Alloc::propagate_on_container_copy_assignment::value
|
|
</code> is true, the allocator is overwritten, if not the
|
|
copied elements are created using the existing
|
|
allocator.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is copy constructible</para>
|
|
</requires>
|
|
</method>
|
|
<method name="operator=">
|
|
<parameter>
|
|
<paramtype>unordered_multimap &&</paramtype>
|
|
</parameter>
|
|
<type>unordered_multimap&</type>
|
|
<description>
|
|
<para>The move assignment operator.</para>
|
|
<para>If <code>Alloc::propagate_on_container_move_assignment</code>
|
|
exists and <code>Alloc::propagate_on_container_move_assignment::value
|
|
</code> is true, the allocator is overwritten, if not the
|
|
moved elements are created using the existing
|
|
allocator.</para>
|
|
</description>
|
|
<notes>
|
|
<para>
|
|
On compilers without rvalue references, this is emulated using
|
|
Boost.Move. Note that on some compilers the copy assignment
|
|
operator may be used in some circumstances.
|
|
</para>
|
|
</notes>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is move constructible.
|
|
</para>
|
|
</requires>
|
|
</method>
|
|
<method name="operator=">
|
|
<parameter>
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<type>unordered_multimap&</type>
|
|
<description>
|
|
<para>Assign from values in initializer list. All existing elements are either overwritten by the new elements or destroyed.</para>
|
|
</description>
|
|
<requires>
|
|
<para>
|
|
<code>value_type</code> is <code>CopyInsertable</code> into the container and
|
|
<code>CopyAssignable</code>.
|
|
</para>
|
|
</requires>
|
|
</method>
|
|
<method name="get_allocator" cv="const">
|
|
<type>allocator_type</type>
|
|
</method>
|
|
<method-group name="size and capacity">
|
|
<method name="empty" cv="const">
|
|
<type>bool</type>
|
|
<returns>
|
|
<code><methodname>size</methodname>() == 0</code>
|
|
</returns>
|
|
</method>
|
|
<method name="size" cv="const">
|
|
<type>size_type</type>
|
|
<returns>
|
|
<code>std::distance(<methodname>begin</methodname>(), <methodname>end</methodname>())</code>
|
|
</returns>
|
|
</method>
|
|
<method name="max_size" cv="const">
|
|
<type>size_type</type>
|
|
<returns><code><methodname>size</methodname>()</code> of the largest possible container.
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="iterators">
|
|
<overloaded-method name="begin">
|
|
<signature><type>iterator</type></signature>
|
|
<signature cv="const"><type>const_iterator</type></signature>
|
|
<returns>An iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container.
|
|
</returns>
|
|
</overloaded-method>
|
|
<overloaded-method name="end">
|
|
<signature>
|
|
<type>iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<type>const_iterator</type>
|
|
</signature>
|
|
<returns>An iterator which refers to the past-the-end value for the container.
|
|
</returns>
|
|
</overloaded-method>
|
|
<method name="cbegin" cv="const">
|
|
<type>const_iterator</type>
|
|
<returns>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.
|
|
</returns>
|
|
</method>
|
|
<method name="cend" cv="const">
|
|
<type>const_iterator</type>
|
|
<returns>A constant iterator which refers to the past-the-end value for the container.
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="modifiers">
|
|
<method name="emplace">
|
|
<template>
|
|
<template-type-parameter name="Args" pack="1">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="args" pack="1">
|
|
<paramtype>Args&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts an object, constructed with the arguments <code>args</code>, in the container.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>args</code>.
|
|
</para>
|
|
</requires>
|
|
<returns>
|
|
<para>An iterator pointing to the inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>If the compiler doesn't support variadic template arguments or rvalue
|
|
references, this is emulated for up to 10 arguments, with no support
|
|
for rvalue references or move semantics.</para>
|
|
<para>Since existing <code>std::pair</code> implementations don't support
|
|
<code>std::piecewise_construct</code> this emulates it,
|
|
but using <code>boost::unordered::piecewise_construct</code>.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="emplace_hint">
|
|
<template>
|
|
<template-type-parameter name="Args" pack="1">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="args" pack="1">
|
|
<paramtype>Args&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts an object, constructed with the arguments <code>args</code>, in the container.</para>
|
|
<para><code>hint</code> is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>args</code>.
|
|
</para>
|
|
</requires>
|
|
<returns>
|
|
<para>An iterator pointing to the inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>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. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>If the compiler doesn't support variadic template arguments or rvalue
|
|
references, this is emulated for up to 10 arguments, with no support
|
|
for rvalue references or move semantics.</para>
|
|
<para>Since existing <code>std::pair</code> implementations don't support
|
|
<code>std::piecewise_construct</code> this emulates it,
|
|
but using <code>boost::unordered::piecewise_construct</code>.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="obj">
|
|
<paramtype>value_type const&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>CopyInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>An iterator pointing to the inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="obj">
|
|
<paramtype>value_type&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>MoveInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>An iterator pointing to the inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="obj">
|
|
<paramtype>value_type const&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container.</para>
|
|
<para>hint is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>CopyInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>An iterator pointing to the inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>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. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="obj">
|
|
<paramtype>value_type&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Inserts <code>obj</code> in the container.</para>
|
|
<para>hint is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>MoveInsertable</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>An iterator pointing to the inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>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. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<template>
|
|
<template-type-parameter name="InputIterator">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="first">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<parameter name="last">
|
|
<paramtype>InputIterator</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Inserts a range of elements into the container.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>*first</code>.</para>
|
|
</requires>
|
|
<throws>
|
|
<para>When inserting a single element, if an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="il">
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Inserts a range of elements into the container.
|
|
</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>*first</code>.</para>
|
|
</requires>
|
|
<throws>
|
|
<para>When inserting a single element, if an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="il">
|
|
<paramtype>initializer_list<value_type></paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>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.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>value_type</code> is <code>EmplaceConstructible</code> into
|
|
<code>X</code> from <code>*first</code>.</para>
|
|
</requires>
|
|
<throws>
|
|
<para>When inserting a single element, if an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="extract">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>node_type</type>
|
|
<description>
|
|
<para>Removes the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>A <code>node_type</code> owning the element.</para>
|
|
</returns>
|
|
<notes>
|
|
<para>
|
|
In C++17 a node extracted using this method can be inserted into a compatible <code>unordered_map</code>,
|
|
but that is not supported yet.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="extract">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>node_type</type>
|
|
<description>
|
|
<para>Removes an element with key equivalent to <code>k</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>A <code>node_type</code> owning the element if found, otherwise an empty <code>node_type</code>.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
In C++17 a node extracted using this method can be inserted into a compatible <code>unordered_map</code>,
|
|
but that is not supported yet.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="nh">
|
|
<paramtype>node_type&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>If <code>nh</code> is empty, has no affect.</para>
|
|
<para>Otherwise inserts the element owned by <code>nh</code></para>
|
|
</description>
|
|
<requires>
|
|
<para><code>nh</code> is empty or <code>nh.get_allocator()</code> is equal to the container's allocator.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>If <code>nh</code> was empty, returns <code>end()</code>.</para>
|
|
<para>Otherwise returns an iterator pointing to the newly inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>In C++17 this can be used to insert a node extracted from a compatible <code>unordered_map</code>,
|
|
but that is not supported yet.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="insert">
|
|
<parameter name="hint">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="nh">
|
|
<paramtype>node_type&&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>If <code>nh</code> is empty, has no affect.</para>
|
|
<para>Otherwise inserts the element owned by <code>nh</code></para>
|
|
<para>hint is a suggestion to where the element should be inserted.</para>
|
|
</description>
|
|
<requires>
|
|
<para><code>nh</code> is empty or <code>nh.get_allocator()</code> is equal to the container's allocator.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>If <code>nh</code> was empty, returns <code>end()</code>.</para>
|
|
<para>Otherwise returns an iterator pointing to the newly inserted element.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>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. </para>
|
|
<para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
|
|
<para>Pointers and references to elements are never invalidated.</para>
|
|
<para>In C++17 this can be used to insert a node extracted from a compatible <code>unordered_map</code>,
|
|
but that is not supported yet.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="erase">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Erase the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>The iterator following <code>position</code> before the erasure.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
In older versions this could be inefficient because it had to search
|
|
through several buckets to find the position of the returned iterator.
|
|
The data structure has been changed so that this is no longer the case,
|
|
and the alternative erase methods have been deprecated.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="erase">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<description>
|
|
<para>Erase all elements with key equivalent to <code>k</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>The number of elements erased.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="erase">
|
|
<parameter name="first">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<parameter name="last">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
<description>
|
|
<para>Erases the elements in the range from <code>first</code> to <code>last</code>.</para>
|
|
</description>
|
|
<returns>
|
|
<para>The iterator following the erased elements - i.e. <code>last</code>.</para>
|
|
</returns>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
<para>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.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="quick_erase">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Erase the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
<para>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.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
This method was implemented because returning an iterator to
|
|
the next element from <code>erase</code> was expensive, but
|
|
the container has been redesigned so that is no longer the
|
|
case. So this method is now deprecated.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="erase_return_void">
|
|
<parameter name="position">
|
|
<paramtype>const_iterator</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Erase the element pointed to by <code>position</code>.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
|
|
<para>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.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>
|
|
This method was implemented because returning an iterator to
|
|
the next element from <code>erase</code> was expensive, but
|
|
the container has been redesigned so that is no longer the
|
|
case. So this method is now deprecated.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<method name="clear">
|
|
<type>void</type>
|
|
<description>
|
|
<para>Erases all elements in the container.</para>
|
|
</description>
|
|
<postconditions>
|
|
<para><code><methodname>size</methodname>() == 0</code></para>
|
|
</postconditions>
|
|
<throws>
|
|
<para>Never throws an exception.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="swap">
|
|
<parameter>
|
|
<paramtype>unordered_multimap&</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Swaps the contents of the container with the parameter.</para>
|
|
<para>If <code>Allocator::propagate_on_container_swap</code> is declared and
|
|
<code>Allocator::propagate_on_container_swap::value</code> is true then the
|
|
containers' allocators are swapped. Otherwise, swapping with unequal allocators
|
|
results in undefined behavior.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>key_equal</code> or <code>hasher</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The exception specifications aren't quite the same as the C++11 standard, as
|
|
the equality predieate and hash function are swapped using their copy constructors.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="merge">
|
|
<template>
|
|
<template-type-parameter name="H2">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="P2">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="source">
|
|
<paramtype>unordered_multimap<Key, Mapped, H2, P2, Alloc>&</paramtype>
|
|
</parameter>
|
|
<notes>
|
|
<para>Does not support merging with a compatible <code>unordered_map</code> yet.</para>
|
|
</notes>
|
|
</method>
|
|
<method name="merge">
|
|
<template>
|
|
<template-type-parameter name="H2">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="P2">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="source">
|
|
<paramtype>unordered_multimap<Key, Mapped, H2, P2, Alloc>&&</paramtype>
|
|
</parameter>
|
|
<notes>
|
|
<para>Does not support merging with a compatible <code>unordered_map</code> yet.</para>
|
|
</notes>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="observers">
|
|
<method name="hash_function" cv="const">
|
|
<type>hasher</type>
|
|
<returns>The container's hash function.
|
|
</returns>
|
|
</method>
|
|
<method name="key_eq" cv="const">
|
|
<type>key_equal</type>
|
|
<returns>The container's key equality predicate.
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="lookup">
|
|
<overloaded-method name="find">
|
|
<signature>
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>const_iterator</type>
|
|
</signature>
|
|
<signature>
|
|
<template>
|
|
<template-type-parameter name="CompatibleKey"/>
|
|
<template-type-parameter name="CompatibleHash"/>
|
|
<template-type-parameter name="CompatiblePredicate"/>
|
|
</template>
|
|
<parameter name="k">
|
|
<paramtype>CompatibleKey const&</paramtype>
|
|
</parameter>
|
|
<parameter name="hash">
|
|
<paramtype>CompatibleHash const&</paramtype>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>CompatiblePredicate const&</paramtype>
|
|
</parameter>
|
|
<type>iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<template>
|
|
<template-type-parameter name="CompatibleKey"/>
|
|
<template-type-parameter name="CompatibleHash"/>
|
|
<template-type-parameter name="CompatiblePredicate"/>
|
|
</template>
|
|
<parameter name="k">
|
|
<paramtype>CompatibleKey const&</paramtype>
|
|
</parameter>
|
|
<parameter name="hash">
|
|
<paramtype>CompatibleHash const&</paramtype>
|
|
</parameter>
|
|
<parameter name="eq">
|
|
<paramtype>CompatiblePredicate const&</paramtype>
|
|
</parameter>
|
|
<type>const_iterator</type>
|
|
</signature>
|
|
<returns>
|
|
<para>An iterator pointing to an element with key equivalent to <code>k</code>, or <code>b.end()</code> if no such element exists.</para>
|
|
</returns>
|
|
<notes><para>
|
|
The templated overloads are a non-standard extensions which
|
|
allows you to use a compatible hash function and equality
|
|
predicate for a key of a different type in order to avoid
|
|
an expensive type cast. In general, its use is not encouraged.
|
|
</para></notes>
|
|
</overloaded-method>
|
|
<method name="count" cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>The number of elements with key equivalent to <code>k</code>.</para>
|
|
</returns>
|
|
</method>
|
|
<overloaded-method name="equal_range">
|
|
<signature>
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>std::pair<iterator, iterator></type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>std::pair<const_iterator, const_iterator></type>
|
|
</signature>
|
|
<returns>
|
|
<para>A range containing all elements with key equivalent to <code>k</code>.
|
|
If the container doesn't container any such elements, returns
|
|
<code><functionname>std::make_pair</functionname>(<methodname>b.end</methodname>(),<methodname>b.end</methodname>())</code>.
|
|
</para>
|
|
</returns>
|
|
</overloaded-method>
|
|
</method-group>
|
|
<method-group name="bucket interface">
|
|
<method name="bucket_count" cv="const">
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>The number of buckets.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="max_bucket_count" cv="const">
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>An upper bound on the number of buckets.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="bucket_size" cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<requires>
|
|
<para><code>n < <methodname>bucket_count</methodname>()</code></para>
|
|
</requires>
|
|
<returns>
|
|
<para>The number of elements in bucket <code>n</code>.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="bucket" cv="const">
|
|
<parameter name="k">
|
|
<paramtype>key_type const&</paramtype>
|
|
</parameter>
|
|
<type>size_type</type>
|
|
<returns>
|
|
<para>The index of the bucket which would contain an element with key <code>k</code>.</para>
|
|
</returns>
|
|
<postconditions>
|
|
<para>The return value is less than <code>bucket_count()</code></para>
|
|
</postconditions>
|
|
</method>
|
|
<overloaded-method name="begin">
|
|
<signature>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>local_iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
</signature>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A local iterator pointing the first element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</overloaded-method>
|
|
<overloaded-method name="end">
|
|
<signature>
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>local_iterator</type>
|
|
</signature>
|
|
<signature cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
</signature>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A local iterator pointing the 'one past the end' element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</overloaded-method>
|
|
<method name="cbegin" cv="const">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A constant local iterator pointing the first element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="cend">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>const_local_iterator</type>
|
|
<requires>
|
|
<para><code>n</code> shall be in the range <code>[0, bucket_count())</code>.</para>
|
|
</requires>
|
|
<returns>
|
|
<para>A constant local iterator pointing the 'one past the end' element in the bucket with index <code>n</code>.</para>
|
|
</returns>
|
|
</method>
|
|
</method-group>
|
|
<method-group name="hash policy">
|
|
<method name="load_factor" cv="const">
|
|
<type>float</type>
|
|
<returns>
|
|
<para>The average number of elements per bucket.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="max_load_factor" cv="const">
|
|
<type>float</type>
|
|
<returns>
|
|
<para>Returns the current maximum load factor.</para>
|
|
</returns>
|
|
</method>
|
|
<method name="max_load_factor">
|
|
<parameter name="z">
|
|
<paramtype>float</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<effects>
|
|
<para>Changes the container's maximum load factor, using <code>z</code> as a hint.</para>
|
|
</effects>
|
|
</method>
|
|
<method name="rehash">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Changes the number of buckets so that there at least <code>n</code> buckets, and so that the load factor is less than the maximum load factor.</para>
|
|
<para>Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated.</para>
|
|
</description>
|
|
<throws>
|
|
<para>The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function.</para>
|
|
</throws>
|
|
</method>
|
|
<method name="reserve">
|
|
<parameter name="n">
|
|
<paramtype>size_type</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<description>
|
|
<para>Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated.</para>
|
|
</description>
|
|
<throws>
|
|
<para>The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function.</para>
|
|
</throws>
|
|
</method>
|
|
</method-group>
|
|
<free-function-group name="Equality Comparisons">
|
|
<function name="operator==">
|
|
<template>
|
|
<template-type-parameter name="Key">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Mapped">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="x">
|
|
<paramtype>unordered_multimap<Key, Mapped, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<parameter name="y">
|
|
<paramtype>unordered_multimap<Key, Mapped, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<type>bool</type>
|
|
<description>
|
|
<para>Return <code>true</code> if <code>x.size() ==
|
|
y.size</code> and for every equivalent key group in
|
|
<code>x</code>, there is a group in <code>y</code>
|
|
for the same key, which is a permutation (using
|
|
<code>operator==</code> to compare the value types).
|
|
</para>
|
|
</description>
|
|
<notes>
|
|
<para>The behavior of this function was changed to match
|
|
the C++11 standard in Boost 1.48.</para>
|
|
<para>Behavior is undefined if the two containers don't have
|
|
equivalent equality predicates.</para>
|
|
</notes>
|
|
</function>
|
|
<function name="operator!=">
|
|
<template>
|
|
<template-type-parameter name="Key">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Mapped">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="x">
|
|
<paramtype>unordered_multimap<Key, Mapped, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<parameter name="y">
|
|
<paramtype>unordered_multimap<Key, Mapped, Hash, Pred, Alloc> const&</paramtype>
|
|
</parameter>
|
|
<type>bool</type>
|
|
<description>
|
|
<para>Return <code>false</code> if <code>x.size() ==
|
|
y.size</code> and for every equivalent key group in
|
|
<code>x</code>, there is a group in <code>y</code>
|
|
for the same key, which is a permutation (using
|
|
<code>operator==</code> to compare the value types).
|
|
</para>
|
|
</description>
|
|
<notes>
|
|
<para>The behavior of this function was changed to match
|
|
the C++11 standard in Boost 1.48.</para>
|
|
<para>Behavior is undefined if the two containers don't have
|
|
equivalent equality predicates.</para>
|
|
</notes>
|
|
</function>
|
|
</free-function-group>
|
|
<free-function-group name="swap">
|
|
<function name="swap">
|
|
<template>
|
|
<template-type-parameter name="Key">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Mapped">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Hash">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Pred">
|
|
</template-type-parameter>
|
|
<template-type-parameter name="Alloc">
|
|
</template-type-parameter>
|
|
</template>
|
|
<parameter name="x">
|
|
<paramtype>unordered_multimap<Key, Mapped, Hash, Pred, Alloc>&</paramtype>
|
|
</parameter>
|
|
<parameter name="y">
|
|
<paramtype>unordered_multimap<Key, Mapped, Hash, Pred, Alloc>&</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<effects>
|
|
<para><code>x.swap(y)</code></para>
|
|
</effects>
|
|
<description>
|
|
<para>Swaps the contents of <code>x</code> and <code>y</code>.</para>
|
|
<para>If <code>Allocator::propagate_on_container_swap</code> is declared and
|
|
<code>Allocator::propagate_on_container_swap::value</code> is true then the
|
|
containers' allocators are swapped. Otherwise, swapping with unequal allocators
|
|
results in undefined behavior.</para>
|
|
</description>
|
|
<throws>
|
|
<para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>key_equal</code> or <code>hasher</code>.</para>
|
|
</throws>
|
|
<notes>
|
|
<para>The exception specifications aren't quite the same as the C++11 standard, as
|
|
the equality predieate and hash function are swapped using their copy constructors.</para>
|
|
</notes>
|
|
</function>
|
|
</free-function-group>
|
|
</class>
|
|
<namespace name="unordered">
|
|
<class name="node_handle_map">
|
|
<template pack="true">
|
|
<template-type-parameter name="ImplementationDefined"/>
|
|
</template>
|
|
<purpose>
|
|
<para>
|
|
An object that owns a single element extracted from an
|
|
<classname>unordered_map</classname> or an
|
|
<classname>unordered_multimap</classname>, that
|
|
can then be inserted into a compatible container type.
|
|
</para>
|
|
<para>
|
|
The name and template parameters of this type are implementation
|
|
defined, and should be obtained using the <code>node_type</code>
|
|
member typedef from the appropriate container.
|
|
</para>
|
|
</purpose>
|
|
<typedef name="key_type">
|
|
<type>typename Container::key_type</type>
|
|
</typedef>
|
|
<typedef name="mapped_type">
|
|
<type>typename Container::mapped_type</type>
|
|
</typedef>
|
|
<typedef name="allocator_type">
|
|
<type>typename Container::allocator_type></type>
|
|
</typedef>
|
|
<constructor specifiers="constexpr" cv="noexcept">
|
|
</constructor>
|
|
<destructor/>
|
|
<constructor cv="noexcept">
|
|
<parameter>
|
|
<paramtype>node_handle_map &&</paramtype>
|
|
</parameter>
|
|
</constructor>
|
|
<method name="operator=">
|
|
<parameter>
|
|
<paramtype>node_handle_map&&</paramtype>
|
|
</parameter>
|
|
<type>node_handle_map&</type>
|
|
</method>
|
|
<method name="key" cv="const">
|
|
<type>key_type&</type>
|
|
</method>
|
|
<method name="mapped" cv="const">
|
|
<type>mapped_type&</type>
|
|
</method>
|
|
<method name="get_allocator" cv="const">
|
|
<type>allocator_type</type>
|
|
</method>
|
|
<method name="operator bool" specifiers="explicit" cv="const noexcept">
|
|
</method>
|
|
<method name="empty" cv="const noexcept">
|
|
<type>bool</type>
|
|
</method>
|
|
<method name="swap" cv="noexcept(ator_traits::propagate_on_container_swap::value)">
|
|
<parameter>
|
|
<paramtype>node_handle_map&</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<notes>
|
|
<para>
|
|
In C++17 is also <code>noexcept</code> if <code>ator_traits::is_always_equal::value</code> is true.
|
|
But we don't support that trait yet.
|
|
</para>
|
|
</notes>
|
|
</method>
|
|
<free-function-group name="swap" cv="noexcept(noexcept(x.swap(y)))">
|
|
<function name="swap">
|
|
<template pack="true">
|
|
<template-type-parameter name="ImplementationDefined"/>
|
|
</template>
|
|
<parameter name="x">
|
|
<paramtype>node_handle_map<ImplementationDefined>&</paramtype>
|
|
</parameter>
|
|
<parameter name="y">
|
|
<paramtype>node_handle_map<ImplementationDefined>&</paramtype>
|
|
</parameter>
|
|
<type>void</type>
|
|
<effects>
|
|
<para><code>x.swap(y)</code></para>
|
|
</effects>
|
|
</function>
|
|
</free-function-group>
|
|
</class>
|
|
</namespace>
|
|
</namespace>
|
|
</header>
|
|
</library-reference>
|