|
Boost-Commit : |
From: daniel_james_at_[hidden]
Date: 2007-08-27 19:00:31
Author: danieljames
Date: 2007-08-27 19:00:30 EDT (Mon, 27 Aug 2007)
New Revision: 39026
URL: http://svn.boost.org/trac/boost/changeset/39026
Log:
Slight improvement to the unordered containers boostbook code.
Text files modified:
sandbox/unordered/libs/unordered/doc/ref.xml | 1106 ++++++++++++---------------------------
1 files changed, 346 insertions(+), 760 deletions(-)
Modified: sandbox/unordered/libs/unordered/doc/ref.xml
==============================================================================
--- sandbox/unordered/libs/unordered/doc/ref.xml (original)
+++ sandbox/unordered/libs/unordered/doc/ref.xml 2007-08-27 19:00:30 EDT (Mon, 27 Aug 2007)
@@ -34,50 +34,27 @@
</purpose>
<description>
<para>For the normative reference see chapter 23 of
- <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2009.pdf">the working draft of the C++ standard [n2009].
- </ulink>
- </para>
- <para>
- <emphasis role="bold">Template Parameters</emphasis>
+ <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2009.pdf">the working draft of the C++ standard [n2009].</ulink></para>
+ <para><emphasis role="bold">Template Parameters</emphasis>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
- <entry>
- <emphasis>Value</emphasis>
- </entry>
- <entry>Value must be Assignable and CopyConstructible
- </entry>
- </row>
+ <entry><emphasis>Value</emphasis></entry>
+ <entry>Value must be Assignable and CopyConstructible</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>
+ <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 Key. It takes two arguments of type Key and returns a value of type bool.
- </entry>
- </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 Key.
+ It takes two arguments of type Key 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>
+ <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>
@@ -111,66 +88,44 @@
<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>
+ <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>
+ <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>Any iterator category except output iterator.
- </para>
- <para>Convertible to
- <type>const_iterator</type>.
- </para>
+ <para>A constant iterator whose value type is <type>value_type</type>. </para>
+ <para>Any iterator category except output 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>Any iterator category except output iterator.
- </para>
+ <para>A constant iterator whose value type is <type>value_type</type>. </para>
+ <para>Any iterator category except output 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>
+ <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>
+ <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>
<constructor>
@@ -194,8 +149,7 @@
<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 allocatorand a maximum load factor of 1.0.
- </para>
+ <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 allocatorand a maximum load factor of 1.0.</para>
</description>
</constructor>
<constructor>
@@ -226,8 +180,7 @@
<default>allocator_type()</default>
</parameter>
<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 and inserts the elements from [f, l) into it.
- </para>
+ <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 and inserts the elements from [f, l) into it.</para>
</description>
</constructor>
<constructor>
@@ -235,8 +188,7 @@
<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>The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator.</para>
</description>
</constructor>
<destructor>
@@ -247,8 +199,7 @@
</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>The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator.</para>
</description>
</method>
<method name="get_allocator" cv="const">
@@ -313,22 +264,17 @@
</parameter>
<type>std::pair<iterator, bool></type>
<description>
- <para>Inserts obj in the container if and only if there is no element in the container with an equivalent value.
- </para>
+ <para>Inserts obj in the container if and only if there is no element in the container with an equivalent value.</para>
</description>
<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 elment with equivalent value.
- </para>
+ <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 elment 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>
+ <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>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
</notes>
</method>
<overloaded-method name="insert">
@@ -351,26 +297,19 @@
<type>const_iterator</type>
</signature>
<description>
- <para>Inserts obj 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>
+ <para>Inserts obj 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>
<returns>
- <para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the elment with equivalent value.
- </para>
+ <para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the elment 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>
+ <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>In this implementation, <code>iterator</code> and <code>const_iterator</code> are the same type, so a single overload is defined to implement both signatures.
- </para>
+ <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>In this implementation, <code>iterator</code> and <code>const_iterator</code> are the same type, so a single overload is defined to implement both signatures.</para>
</notes>
</overloaded-method>
<method name="insert">
@@ -386,16 +325,13 @@
</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>
+ <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>
<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>
+ <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>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
</notes>
</method>
<overloaded-method name="erase">
@@ -412,22 +348,17 @@
<type>const_iterator</type>
</signature>
<description>
- <para>Erase the element pointed to by <code>position</code>.
- </para>
+ <para>Erase the element pointed to by <code>position</code>.</para>
</description>
<returns>
- <para>The iterator following <code>position</code> before the erasure.
- </para>
+ <para>The iterator following <code>position</code> before the erasure.</para>
</returns>
<throws>
- <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.
- </para>
- <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.
- </para>
+ <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.</para>
+ <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.</para>
</throws>
<notes>
- <para>In this implementation, <code>iterator</code> and <code>const_iterator</code> are the same type, so a single overload is defined to implement both signatures.
- </para>
+ <para>In this implementation, <code>iterator</code> and <code>const_iterator</code> are the same type, so a single overload is defined to implement both signatures.</para>
</notes>
</overloaded-method>
<overloaded-method name="erase">
@@ -438,16 +369,13 @@
<type>size_type</type>
</signature>
<description>
- <para>Erase all elements with key equivalent to <code>k</code>.
- </para>
+ <para>Erase all elements with key equivalent to <code>k</code>.</para>
</description>
<returns>
- <para>The number of elements erased.
- </para>
+ <para>The number of elements erased.</para>
</returns>
<throws>
- <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.
- </para>
+ <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.</para>
</throws>
</overloaded-method>
<overloaded-method name="erase">
@@ -470,33 +398,26 @@
<type>const_iterator</type>
</signature>
<descritpion>
- <para>Erases the elements in the range from <code>first</code> to <code>last</code>.
- </para>
+ <para>Erases the elements in the range from <code>first</code> to <code>last</code>.</para>
</descritpion>
<returns>
- <para>The iterator following the erased elements - i.e. <code>last</code>.
- </para>
+ <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 a call to <code>hasher</code> or <code>key_equal</code>.
- </para>
- <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.
- </para>
+ <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.</para>
+ <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.</para>
</throws>
</overloaded-method>
<method name="clear">
<type>void</type>
<description>
- <para>Erases all elements in the container.
- </para>
+ <para>Erases all elements in the container.</para>
</description>
<postconditions>
- <para><code><methodname>size</methodname>() == 0</code>
- </para>
+ <para><code><methodname>size</methodname>() == 0</code></para>
</postconditions>
<throws>
- <para>Never throws an exception.
- </para>
+ <para>Never throws an exception.</para>
</throws>
</method>
<method name="swap">
@@ -505,8 +426,7 @@
</parameter>
<type>void</type>
<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>
+ <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>
</method>
</method-group>
@@ -537,8 +457,7 @@
<type>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>
+ <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>
</overloaded-method>
<method name="count" cv="const">
@@ -547,8 +466,7 @@
</parameter>
<type>size_type</type>
<returns>
- <para>The number of elements with key equivalent to <code>k</code>.
- </para>
+ <para>The number of elements with key equivalent to <code>k</code>.</para>
</returns>
</method>
<overloaded-method name="equal_range">
@@ -565,8 +483,10 @@
<type>std::pair<iterator, iterator></type>
</signature>
<returns>
- <para>A range with 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>
+ <para>A range with 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>
@@ -574,15 +494,13 @@
<method name="bucket_count" cv="const">
<type>size_type</type>
<returns>
- <para>The number of buckets.
- </para>
+ <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>
+ <para>An upper bound on the number of buckets.</para>
</returns>
</method>
<method name="bucket_size" cv="const">
@@ -591,14 +509,10 @@
</parameter>
<type>size_type</type>
<requires>
- <para>
- <code>n < <methodname>bucket_count</methodname>()</code>
- </para>
+ <para><code>n < <methodname>bucket_count</methodname>()</code></para>
</requires>
<returns>
- <para>The number of elements in bucket
- <code>n</code>.
- </para>
+ <para>The number of elements in bucket <code>n</code>.</para>
</returns>
</method>
<method name="bucket" cv="const">
@@ -607,12 +521,10 @@
</parameter>
<type>size_type</type>
<returns>
- <para>The index of the bucket which would contain an element with key <code>k</code>.
- </para>
+ <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>
+ <para>The return value is less than <code>bucket_count()</code></para>
</postconditions>
</method>
<overloaded-method name="begin">
@@ -629,13 +541,10 @@
<type>const_local_iterator</type>
</signature>
<requires>
- <para><code>n</code> shall be in the range
- <code>[0, bucket_count())</code>.
- </para>
+ <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>
+ <para>A local iterator pointing the first element in the bucket with index <code>n</code>.</para>
</returns>
</overloaded-method>
<overloaded-method name="end">
@@ -652,13 +561,10 @@
<type>const_local_iterator</type>
</signature>
<requires>
- <para><code>n</code> shall be in the range
- <code>[0, bucket_count())</code>.
- </para>
+ <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>
+ <para>A local iterator pointing the 'one past the end' element in the bucket with index <code>n</code>.</para>
</returns>
</overloaded-method>
</method-group>
@@ -666,15 +572,13 @@
<method name="load_factor" cv="const">
<type>float</type>
<returns>
- <para>The average number of elements per bucket.
- </para>
+ <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>
+ <para>Returns the current maximum load factor.</para>
</returns>
</method>
<method name="max_load_factor">
@@ -683,8 +587,7 @@
</parameter>
<type>float</type>
<returns>
- <para>Changes the container's maximum load factor, using <code>z</code> as a hint.
- </para>
+ <para>Changes the container's maximum load factor, using <code>z</code> as a hint.</para>
</returns>
</method>
<method name="rehash">
@@ -693,14 +596,11 @@
</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
- </para>
+ <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</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>
+ <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>
@@ -724,12 +624,10 @@
</parameter>
<type>void</type>
<effects>
- <para><code>x.swap(y)</code>
- </para>
+ <para><code>x.swap(y)</code></para>
</effects>
<throws>
- <para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>Hash</code> or <code>Pred</code>.
- </para>
+ <para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>Hash</code> or <code>Pred</code>.</para>
</throws>
</function>
@@ -755,50 +653,27 @@
</purpose>
<description>
<para>For the normative reference see chapter 23 of
- <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2009.pdf">the working draft of the C++ standard [n2009].
- </ulink>
- </para>
- <para>
- <emphasis role="bold">Template Parameters</emphasis>
+ <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2009.pdf">the working draft of the C++ standard [n2009].</ulink></para>
+ <para><emphasis role="bold">Template Parameters</emphasis>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
- <entry>
- <emphasis>Value</emphasis>
- </entry>
- <entry>Value must be Assignable and CopyConstructible
- </entry>
- </row>
+ <entry><emphasis>Value</emphasis></entry>
+ <entry>Value must be Assignable and CopyConstructible</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>
+ <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 Key. It takes two arguments of type Key and returns a value of type bool.
- </entry>
- </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 Key.
+ It takes two arguments of type Key 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>
+ <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>
@@ -832,66 +707,44 @@
<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>
+ <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>
+ <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>Any iterator category except output iterator.
- </para>
- <para>Convertible to
- <type>const_iterator</type>.
- </para>
+ <para>A constant iterator whose value type is <type>value_type</type>. </para>
+ <para>Any iterator category except output 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>Any iterator category except output iterator.
- </para>
+ <para>A constant iterator whose value type is <type>value_type</type>. </para>
+ <para>Any iterator category except output 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>
+ <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>
+ <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>
<constructor>
@@ -915,8 +768,7 @@
<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 allocatorand a maximum load factor of 1.0.
- </para>
+ <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 allocatorand a maximum load factor of 1.0.</para>
</description>
</constructor>
<constructor>
@@ -947,8 +799,7 @@
<default>allocator_type()</default>
</parameter>
<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 and inserts the elements from [f, l) into it.
- </para>
+ <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 and inserts the elements from [f, l) into it.</para>
</description>
</constructor>
<constructor>
@@ -956,8 +807,7 @@
<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>The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator.</para>
</description>
</constructor>
<destructor>
@@ -968,8 +818,7 @@
</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>The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator.</para>
</description>
</method>
<method name="get_allocator" cv="const">
@@ -1034,20 +883,16 @@
</parameter>
<type>iterator</type>
<description>
- <para>Inserts obj in the container.
- </para>
+ <para>Inserts obj in the container.</para>
</description>
<returns>
- <para>An iterator pointing to the inserted element.
- </para>
+ <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>
+ <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>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
</notes>
</method>
<overloaded-method name="insert">
@@ -1070,24 +915,18 @@
<type>const_iterator</type>
</signature>
<description>
- <para>Inserts obj in the container.
- </para>
- <para>hint is a suggestion to where the element should be inserted.
- </para>
+ <para>Inserts obj in the container.</para>
+ <para>hint is a suggestion to where the element should be inserted.</para>
</description>
<returns>
- <para>An iterator pointing to the inserted element.
- </para>
+ <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>
+ <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>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>
</notes>
</overloaded-method>
<method name="insert">
@@ -1103,16 +942,13 @@
</parameter>
<type>void</type>
<description>
- <para>Inserts a range of elements into the container.
- </para>
+ <para>Inserts a range of elements into the container. </para>
</description>
<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>
+ <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>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
</notes>
</method>
<overloaded-method name="erase">
@@ -1129,18 +965,14 @@
<type>const_iterator</type>
</signature>
<description>
- <para>Erase the element pointed to by <code>position</code>.
- </para>
+ <para>Erase the element pointed to by <code>position</code>.</para>
</description>
<returns>
- <para>The iterator following <code>position</code> before the erasure.
- </para>
+ <para>The iterator following <code>position</code> before the erasure.</para>
</returns>
<throws>
- <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.
- </para>
- <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.
- </para>
+ <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.</para>
+ <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.</para>
</throws>
<notes>
</notes>
@@ -1153,16 +985,13 @@
<type>size_type</type>
</signature>
<description>
- <para>Erase all elements with key equivalent to <code>k</code>.
- </para>
+ <para>Erase all elements with key equivalent to <code>k</code>.</para>
</description>
<returns>
- <para>The number of elements erased.
- </para>
+ <para>The number of elements erased.</para>
</returns>
<throws>
- <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.
- </para>
+ <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.</para>
</throws>
</overloaded-method>
<overloaded-method name="erase">
@@ -1185,33 +1014,26 @@
<type>const_iterator</type>
</signature>
<descritpion>
- <para>Erases the elements in the range from <code>first</code> to <code>last</code>.
- </para>
+ <para>Erases the elements in the range from <code>first</code> to <code>last</code>.</para>
</descritpion>
<returns>
- <para>The iterator following the erased elements - i.e. <code>last</code>.
- </para>
+ <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 a call to <code>hasher</code> or <code>key_equal</code>.
- </para>
- <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.
- </para>
+ <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.</para>
+ <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.</para>
</throws>
</overloaded-method>
<method name="clear">
<type>void</type>
<description>
- <para>Erases all elements in the container.
- </para>
+ <para>Erases all elements in the container.</para>
</description>
<postconditions>
- <para><code><methodname>size</methodname>() == 0</code>
- </para>
+ <para><code><methodname>size</methodname>() == 0</code></para>
</postconditions>
<throws>
- <para>Never throws an exception.
- </para>
+ <para>Never throws an exception.</para>
</throws>
</method>
<method name="swap">
@@ -1220,8 +1042,7 @@
</parameter>
<type>void</type>
<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>
+ <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>
</method>
</method-group>
@@ -1252,8 +1073,7 @@
<type>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>
+ <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>
</overloaded-method>
<method name="count" cv="const">
@@ -1262,8 +1082,7 @@
</parameter>
<type>size_type</type>
<returns>
- <para>The number of elements with key equivalent to <code>k</code>.
- </para>
+ <para>The number of elements with key equivalent to <code>k</code>.</para>
</returns>
</method>
<overloaded-method name="equal_range">
@@ -1280,8 +1099,10 @@
<type>std::pair<iterator, iterator></type>
</signature>
<returns>
- <para>A range with 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>
+ <para>A range with 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>
@@ -1289,15 +1110,13 @@
<method name="bucket_count" cv="const">
<type>size_type</type>
<returns>
- <para>The number of buckets.
- </para>
+ <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>
+ <para>An upper bound on the number of buckets.</para>
</returns>
</method>
<method name="bucket_size" cv="const">
@@ -1306,14 +1125,10 @@
</parameter>
<type>size_type</type>
<requires>
- <para>
- <code>n < <methodname>bucket_count</methodname>()</code>
- </para>
+ <para><code>n < <methodname>bucket_count</methodname>()</code></para>
</requires>
<returns>
- <para>The number of elements in bucket
- <code>n</code>.
- </para>
+ <para>The number of elements in bucket <code>n</code>.</para>
</returns>
</method>
<method name="bucket" cv="const">
@@ -1322,12 +1137,10 @@
</parameter>
<type>size_type</type>
<returns>
- <para>The index of the bucket which would contain an element with key <code>k</code>.
- </para>
+ <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>
+ <para>The return value is less than <code>bucket_count()</code></para>
</postconditions>
</method>
<overloaded-method name="begin">
@@ -1344,13 +1157,10 @@
<type>const_local_iterator</type>
</signature>
<requires>
- <para><code>n</code> shall be in the range
- <code>[0, bucket_count())</code>.
- </para>
+ <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>
+ <para>A local iterator pointing the first element in the bucket with index <code>n</code>.</para>
</returns>
</overloaded-method>
<overloaded-method name="end">
@@ -1367,13 +1177,10 @@
<type>const_local_iterator</type>
</signature>
<requires>
- <para><code>n</code> shall be in the range
- <code>[0, bucket_count())</code>.
- </para>
+ <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>
+ <para>A local iterator pointing the 'one past the end' element in the bucket with index <code>n</code>.</para>
</returns>
</overloaded-method>
</method-group>
@@ -1381,15 +1188,13 @@
<method name="load_factor" cv="const">
<type>float</type>
<returns>
- <para>The average number of elements per bucket.
- </para>
+ <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>
+ <para>Returns the current maximum load factor.</para>
</returns>
</method>
<method name="max_load_factor">
@@ -1398,8 +1203,7 @@
</parameter>
<type>float</type>
<returns>
- <para>Changes the container's maximum load factor, using <code>z</code> as a hint.
- </para>
+ <para>Changes the container's maximum load factor, using <code>z</code> as a hint.</para>
</returns>
</method>
<method name="rehash">
@@ -1408,14 +1212,11 @@
</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
- </para>
+ <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</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>
+ <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>
@@ -1439,12 +1240,10 @@
</parameter>
<type>void</type>
<effects>
- <para><code>x.swap(y)</code>
- </para>
+ <para><code>x.swap(y)</code></para>
</effects>
<throws>
- <para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>Hash</code> or <code>Pred</code>.
- </para>
+ <para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>Hash</code> or <code>Pred</code>.</para>
</throws>
</function>
</namespace>
@@ -1480,57 +1279,30 @@
</purpose>
<description>
<para>For the normative reference see chapter 23 of
- <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2009.pdf">the working draft of the C++ standard [n2009].
- </ulink>
- </para>
- <para>
- <emphasis role="bold">Template Parameters</emphasis>
+ <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2009.pdf">the working draft of the C++ standard [n2009].</ulink></para>
+ <para><emphasis role="bold">Template Parameters</emphasis>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
- <entry>
- <emphasis>Key</emphasis>
- </entry>
- <entry>Key must be Assignable and CopyConstructible.
- </entry>
- </row>
+ <entry><emphasis>Key</emphasis></entry>
+ <entry>Key must be Assignable and CopyConstructible.</entry></row>
<row>
- <entry>
- <emphasis>T</emphasis>
- </entry>
- <entry>T must be CopyConstructible
- </entry>
- </row>
+ <entry><emphasis>T</emphasis></entry>
+ <entry>T must be CopyConstructible</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>
+ <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 Key. It takes two arguments of type Key and returns a value of type bool.
- </entry>
- </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 Key.
+ It takes two arguments of type Key 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>
+ <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>
@@ -1567,66 +1339,44 @@
<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>
+ <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>
+ <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 iterator whose value type is
- <type>value_type</type>.
- </para>
- <para>Any iterator category except output iterator.
- </para>
- <para>Convertible to
- <type>const_iterator</type>.
- </para>
+ <para>A iterator whose value type is <type>value_type</type>. </para>
+ <para>Any iterator category except output 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>Any iterator category except output iterator.
- </para>
+ <para>A constant iterator whose value type is <type>value_type</type>. </para>
+ <para>Any iterator category except output 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>
+ <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>
+ <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>
<constructor>
@@ -1650,8 +1400,7 @@
<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 allocatorand a maximum load factor of 1.0.
- </para>
+ <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 allocatorand a maximum load factor of 1.0.</para>
</description>
</constructor>
<constructor>
@@ -1682,8 +1431,7 @@
<default>allocator_type()</default>
</parameter>
<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 and inserts the elements from [f, l) into it.
- </para>
+ <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 and inserts the elements from [f, l) into it.</para>
</description>
</constructor>
<constructor>
@@ -1691,8 +1439,7 @@
<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>The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator.</para>
</description>
</constructor>
<destructor>
@@ -1703,8 +1450,7 @@
</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>The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator.</para>
</description>
</method>
<method name="get_allocator" cv="const">
@@ -1769,22 +1515,17 @@
</parameter>
<type>std::pair<iterator, bool></type>
<description>
- <para>Inserts obj in the container if and only if there is no element in the container with an equivalent key.
- </para>
+ <para>Inserts obj in the container if and only if there is no element in the container with an equivalent key.</para>
</description>
<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 elment with equivalent key.
- </para>
+ <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 elment 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>
+ <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>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
</notes>
</method>
<overloaded-method name="insert">
@@ -1807,26 +1548,19 @@
<type>const_iterator</type>
</signature>
<description>
- <para>Inserts obj 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>
+ <para>Inserts obj 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>
<returns>
- <para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the elment with equivalent key.
- </para>
+ <para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the elment 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>
+ <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>In this implementation, <code>iterator</code> and <code>const_iterator</code> are the same type, so a single overload is defined to implement both signatures.
- </para>
+ <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>In this implementation, <code>iterator</code> and <code>const_iterator</code> are the same type, so a single overload is defined to implement both signatures.</para>
</notes>
</overloaded-method>
<method name="insert">
@@ -1842,16 +1576,13 @@
</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>
+ <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>
<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>
+ <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>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
</notes>
</method>
<overloaded-method name="erase">
@@ -1868,22 +1599,17 @@
<type>const_iterator</type>
</signature>
<description>
- <para>Erase the element pointed to by <code>position</code>.
- </para>
+ <para>Erase the element pointed to by <code>position</code>.</para>
</description>
<returns>
- <para>The iterator following <code>position</code> before the erasure.
- </para>
+ <para>The iterator following <code>position</code> before the erasure.</para>
</returns>
<throws>
- <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.
- </para>
- <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.
- </para>
+ <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.</para>
+ <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.</para>
</throws>
<notes>
- <para>In this implementation, <code>iterator</code> and <code>const_iterator</code> are the same type, so a single overload is defined to implement both signatures.
- </para>
+ <para>In this implementation, <code>iterator</code> and <code>const_iterator</code> are the same type, so a single overload is defined to implement both signatures.</para>
</notes>
</overloaded-method>
<overloaded-method name="erase">
@@ -1894,16 +1620,13 @@
<type>size_type</type>
</signature>
<description>
- <para>Erase all elements with key equivalent to <code>k</code>.
- </para>
+ <para>Erase all elements with key equivalent to <code>k</code>.</para>
</description>
<returns>
- <para>The number of elements erased.
- </para>
+ <para>The number of elements erased.</para>
</returns>
<throws>
- <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.
- </para>
+ <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.</para>
</throws>
</overloaded-method>
<overloaded-method name="erase">
@@ -1926,33 +1649,26 @@
<type>const_iterator</type>
</signature>
<descritpion>
- <para>Erases the elements in the range from <code>first</code> to <code>last</code>.
- </para>
+ <para>Erases the elements in the range from <code>first</code> to <code>last</code>.</para>
</descritpion>
<returns>
- <para>The iterator following the erased elements - i.e. <code>last</code>.
- </para>
+ <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 a call to <code>hasher</code> or <code>key_equal</code>.
- </para>
- <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.
- </para>
+ <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.</para>
+ <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.</para>
</throws>
</overloaded-method>
<method name="clear">
<type>void</type>
<description>
- <para>Erases all elements in the container.
- </para>
+ <para>Erases all elements in the container.</para>
</description>
<postconditions>
- <para><code><methodname>size</methodname>() == 0</code>
- </para>
+ <para><code><methodname>size</methodname>() == 0</code></para>
</postconditions>
<throws>
- <para>Never throws an exception.
- </para>
+ <para>Never throws an exception.</para>
</throws>
</method>
<method name="swap">
@@ -1961,8 +1677,7 @@
</parameter>
<type>void</type>
<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>
+ <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>
</method>
</method-group>
@@ -1993,8 +1708,7 @@
<type>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>
+ <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>
</overloaded-method>
<method name="count" cv="const">
@@ -2003,8 +1717,7 @@
</parameter>
<type>size_type</type>
<returns>
- <para>The number of elements with key equivalent to <code>k</code>.
- </para>
+ <para>The number of elements with key equivalent to <code>k</code>.</para>
</returns>
</method>
<overloaded-method name="equal_range">
@@ -2021,8 +1734,10 @@
<type>std::pair<iterator, iterator></type>
</signature>
<returns>
- <para>A range with 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>
+ <para>A range with 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[]">
@@ -2031,20 +1746,16 @@
</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>
+ <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>
+ <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>
+ <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>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
</notes>
</method>
</method-group>
@@ -2052,15 +1763,13 @@
<method name="bucket_count" cv="const">
<type>size_type</type>
<returns>
- <para>The number of buckets.
- </para>
+ <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>
+ <para>An upper bound on the number of buckets.</para>
</returns>
</method>
<method name="bucket_size" cv="const">
@@ -2069,14 +1778,10 @@
</parameter>
<type>size_type</type>
<requires>
- <para>
- <code>n < <methodname>bucket_count</methodname>()</code>
- </para>
+ <para><code>n < <methodname>bucket_count</methodname>()</code></para>
</requires>
<returns>
- <para>The number of elements in bucket
- <code>n</code>.
- </para>
+ <para>The number of elements in bucket <code>n</code>.</para>
</returns>
</method>
<method name="bucket" cv="const">
@@ -2085,12 +1790,10 @@
</parameter>
<type>size_type</type>
<returns>
- <para>The index of the bucket which would contain an element with key <code>k</code>.
- </para>
+ <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>
+ <para>The return value is less than <code>bucket_count()</code></para>
</postconditions>
</method>
<overloaded-method name="begin">
@@ -2107,13 +1810,10 @@
<type>const_local_iterator</type>
</signature>
<requires>
- <para><code>n</code> shall be in the range
- <code>[0, bucket_count())</code>.
- </para>
+ <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>
+ <para>A local iterator pointing the first element in the bucket with index <code>n</code>.</para>
</returns>
</overloaded-method>
<overloaded-method name="end">
@@ -2130,13 +1830,10 @@
<type>const_local_iterator</type>
</signature>
<requires>
- <para><code>n</code> shall be in the range
- <code>[0, bucket_count())</code>.
- </para>
+ <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>
+ <para>A local iterator pointing the 'one past the end' element in the bucket with index <code>n</code>.</para>
</returns>
</overloaded-method>
</method-group>
@@ -2144,15 +1841,13 @@
<method name="load_factor" cv="const">
<type>float</type>
<returns>
- <para>The average number of elements per bucket.
- </para>
+ <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>
+ <para>Returns the current maximum load factor.</para>
</returns>
</method>
<method name="max_load_factor">
@@ -2161,8 +1856,7 @@
</parameter>
<type>float</type>
<returns>
- <para>Changes the container's maximum load factor, using <code>z</code> as a hint.
- </para>
+ <para>Changes the container's maximum load factor, using <code>z</code> as a hint.</para>
</returns>
</method>
<method name="rehash">
@@ -2171,14 +1865,11 @@
</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
- </para>
+ <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</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>
+ <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>
@@ -2204,12 +1895,10 @@
</parameter>
<type>void</type>
<effects>
- <para><code>x.swap(y)</code>
- </para>
+ <para><code>x.swap(y)</code></para>
</effects>
<throws>
- <para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>Hash</code> or <code>Pred</code>.
- </para>
+ <para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>Hash</code> or <code>Pred</code>.</para>
</throws>
</function>
@@ -2237,57 +1926,30 @@
</purpose>
<description>
<para>For the normative reference see chapter 23 of
- <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2009.pdf">the working draft of the C++ standard [n2009].
- </ulink>
- </para>
- <para>
- <emphasis role="bold">Template Parameters</emphasis>
+ <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2009.pdf">the working draft of the C++ standard [n2009].</ulink></para>
+ <para><emphasis role="bold">Template Parameters</emphasis>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
- <entry>
- <emphasis>Key</emphasis>
- </entry>
- <entry>Key must be Assignable and CopyConstructible.
- </entry>
- </row>
+ <entry><emphasis>Key</emphasis></entry>
+ <entry>Key must be Assignable and CopyConstructible.</entry></row>
<row>
- <entry>
- <emphasis>T</emphasis>
- </entry>
- <entry>T must be CopyConstructible
- </entry>
- </row>
+ <entry><emphasis>T</emphasis></entry>
+ <entry>T must be CopyConstructible</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>
+ <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 Key. It takes two arguments of type Key and returns a value of type bool.
- </entry>
- </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 Key.
+ It takes two arguments of type Key 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>
+ <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>
@@ -2324,66 +1986,44 @@
<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>
+ <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>
+ <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 iterator whose value type is
- <type>value_type</type>.
- </para>
- <para>Any iterator category except output iterator.
- </para>
- <para>Convertible to
- <type>const_iterator</type>.
- </para>
+ <para>A iterator whose value type is <type>value_type</type>. </para>
+ <para>Any iterator category except output 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>Any iterator category except output iterator.
- </para>
+ <para>A constant iterator whose value type is <type>value_type</type>. </para>
+ <para>Any iterator category except output 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>
+ <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>
+ <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>
<constructor>
@@ -2407,8 +2047,7 @@
<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 allocatorand a maximum load factor of 1.0.
- </para>
+ <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 allocatorand a maximum load factor of 1.0.</para>
</description>
</constructor>
<constructor>
@@ -2439,8 +2078,7 @@
<default>allocator_type()</default>
</parameter>
<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 and inserts the elements from [f, l) into it.
- </para>
+ <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 and inserts the elements from [f, l) into it.</para>
</description>
</constructor>
<constructor>
@@ -2448,8 +2086,7 @@
<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>The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator.</para>
</description>
</constructor>
<destructor>
@@ -2460,8 +2097,7 @@
</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>The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator.</para>
</description>
</method>
<method name="get_allocator" cv="const">
@@ -2526,20 +2162,16 @@
</parameter>
<type>iterator</type>
<description>
- <para>Inserts obj in the container.
- </para>
+ <para>Inserts obj in the container.</para>
</description>
<returns>
- <para>An iterator pointing to the inserted element.
- </para>
+ <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>
+ <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>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
</notes>
</method>
<overloaded-method name="insert">
@@ -2562,24 +2194,18 @@
<type>const_iterator</type>
</signature>
<description>
- <para>Inserts obj in the container.
- </para>
- <para>hint is a suggestion to where the element should be inserted.
- </para>
+ <para>Inserts obj in the container.</para>
+ <para>hint is a suggestion to where the element should be inserted.</para>
</description>
<returns>
- <para>An iterator pointing to the inserted element.
- </para>
+ <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>
+ <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>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>
</notes>
</overloaded-method>
<method name="insert">
@@ -2595,16 +2221,13 @@
</parameter>
<type>void</type>
<description>
- <para>Inserts a range of elements into the container.
- </para>
+ <para>Inserts a range of elements into the container. </para>
</description>
<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>
+ <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>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
</notes>
</method>
<overloaded-method name="erase">
@@ -2621,18 +2244,14 @@
<type>const_iterator</type>
</signature>
<description>
- <para>Erase the element pointed to by <code>position</code>.
- </para>
+ <para>Erase the element pointed to by <code>position</code>.</para>
</description>
<returns>
- <para>The iterator following <code>position</code> before the erasure.
- </para>
+ <para>The iterator following <code>position</code> before the erasure.</para>
</returns>
<throws>
- <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.
- </para>
- <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.
- </para>
+ <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.</para>
+ <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.</para>
</throws>
<notes>
</notes>
@@ -2645,16 +2264,13 @@
<type>size_type</type>
</signature>
<description>
- <para>Erase all elements with key equivalent to <code>k</code>.
- </para>
+ <para>Erase all elements with key equivalent to <code>k</code>.</para>
</description>
<returns>
- <para>The number of elements erased.
- </para>
+ <para>The number of elements erased.</para>
</returns>
<throws>
- <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.
- </para>
+ <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.</para>
</throws>
</overloaded-method>
<overloaded-method name="erase">
@@ -2677,33 +2293,26 @@
<type>const_iterator</type>
</signature>
<descritpion>
- <para>Erases the elements in the range from <code>first</code> to <code>last</code>.
- </para>
+ <para>Erases the elements in the range from <code>first</code> to <code>last</code>.</para>
</descritpion>
<returns>
- <para>The iterator following the erased elements - i.e. <code>last</code>.
- </para>
+ <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 a call to <code>hasher</code> or <code>key_equal</code>.
- </para>
- <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.
- </para>
+ <para>Only throws an exception, if it is thrown by a call to <code>hasher</code> or <code>key_equal</code>.</para>
+ <para>They don't get called by the current implementation Boost.Unordered but other implementations may call them.</para>
</throws>
</overloaded-method>
<method name="clear">
<type>void</type>
<description>
- <para>Erases all elements in the container.
- </para>
+ <para>Erases all elements in the container.</para>
</description>
<postconditions>
- <para><code><methodname>size</methodname>() == 0</code>
- </para>
+ <para><code><methodname>size</methodname>() == 0</code></para>
</postconditions>
<throws>
- <para>Never throws an exception.
- </para>
+ <para>Never throws an exception.</para>
</throws>
</method>
<method name="swap">
@@ -2712,8 +2321,7 @@
</parameter>
<type>void</type>
<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>
+ <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>
</method>
</method-group>
@@ -2744,8 +2352,7 @@
<type>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>
+ <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>
</overloaded-method>
<method name="count" cv="const">
@@ -2754,8 +2361,7 @@
</parameter>
<type>size_type</type>
<returns>
- <para>The number of elements with key equivalent to <code>k</code>.
- </para>
+ <para>The number of elements with key equivalent to <code>k</code>.</para>
</returns>
</method>
<overloaded-method name="equal_range">
@@ -2772,8 +2378,10 @@
<type>std::pair<iterator, iterator></type>
</signature>
<returns>
- <para>A range with 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>
+ <para>A range with 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>
@@ -2781,15 +2389,13 @@
<method name="bucket_count" cv="const">
<type>size_type</type>
<returns>
- <para>The number of buckets.
- </para>
+ <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>
+ <para>An upper bound on the number of buckets.</para>
</returns>
</method>
<method name="bucket_size" cv="const">
@@ -2798,14 +2404,10 @@
</parameter>
<type>size_type</type>
<requires>
- <para>
- <code>n < <methodname>bucket_count</methodname>()</code>
- </para>
+ <para><code>n < <methodname>bucket_count</methodname>()</code></para>
</requires>
<returns>
- <para>The number of elements in bucket
- <code>n</code>.
- </para>
+ <para>The number of elements in bucket <code>n</code>.</para>
</returns>
</method>
<method name="bucket" cv="const">
@@ -2814,12 +2416,10 @@
</parameter>
<type>size_type</type>
<returns>
- <para>The index of the bucket which would contain an element with key <code>k</code>.
- </para>
+ <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>
+ <para>The return value is less than <code>bucket_count()</code></para>
</postconditions>
</method>
<overloaded-method name="begin">
@@ -2836,13 +2436,10 @@
<type>const_local_iterator</type>
</signature>
<requires>
- <para><code>n</code> shall be in the range
- <code>[0, bucket_count())</code>.
- </para>
+ <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>
+ <para>A local iterator pointing the first element in the bucket with index <code>n</code>.</para>
</returns>
</overloaded-method>
<overloaded-method name="end">
@@ -2859,13 +2456,10 @@
<type>const_local_iterator</type>
</signature>
<requires>
- <para><code>n</code> shall be in the range
- <code>[0, bucket_count())</code>.
- </para>
+ <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>
+ <para>A local iterator pointing the 'one past the end' element in the bucket with index <code>n</code>.</para>
</returns>
</overloaded-method>
</method-group>
@@ -2873,15 +2467,13 @@
<method name="load_factor" cv="const">
<type>float</type>
<returns>
- <para>The average number of elements per bucket.
- </para>
+ <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>
+ <para>Returns the current maximum load factor.</para>
</returns>
</method>
<method name="max_load_factor">
@@ -2890,8 +2482,7 @@
</parameter>
<type>float</type>
<returns>
- <para>Changes the container's maximum load factor, using <code>z</code> as a hint.
- </para>
+ <para>Changes the container's maximum load factor, using <code>z</code> as a hint.</para>
</returns>
</method>
<method name="rehash">
@@ -2900,14 +2491,11 @@
</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
- </para>
+ <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</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>
+ <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>
@@ -2933,12 +2521,10 @@
</parameter>
<type>void</type>
<effects>
- <para><code>x.swap(y)</code>
- </para>
+ <para><code>x.swap(y)</code></para>
</effects>
<throws>
- <para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>Hash</code> or <code>Pred</code>.
- </para>
+ <para>Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>Hash</code> or <code>Pred</code>.</para>
</throws>
</function>
</namespace>
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk