Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r74142 - trunk/libs/unordered/doc
From: dnljms_at_[hidden]
Date: 2011-08-29 13:14:10


Author: danieljames
Date: 2011-08-29 13:14:09 EDT (Mon, 29 Aug 2011)
New Revision: 74142
URL: http://svn.boost.org/trac/boost/changeset/74142

Log:
Unordered: Update erase reference.
Text files modified:
   trunk/libs/unordered/doc/ref.php | 10 ++++------
   trunk/libs/unordered/doc/ref.xml | 40 ++++++++++++++++------------------------
   2 files changed, 20 insertions(+), 30 deletions(-)

Modified: trunk/libs/unordered/doc/ref.php
==============================================================================
--- trunk/libs/unordered/doc/ref.php (original)
+++ trunk/libs/unordered/doc/ref.php 2011-08-29 13:14:09 EDT (Mon, 29 Aug 2011)
@@ -555,15 +555,13 @@
               </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>
               <notes>
                 <para>
- When the number of elements is a lot smaller than the number of buckets
- this function can be very inefficient as it has to search through empty
- buckets for the next element, in order to return the iterator.
- The method <methodname>quick_erase</methodname> is faster, but has yet
- to be standardized.
+ 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>

Modified: trunk/libs/unordered/doc/ref.xml
==============================================================================
--- trunk/libs/unordered/doc/ref.xml (original)
+++ trunk/libs/unordered/doc/ref.xml 2011-08-29 13:14:09 EDT (Mon, 29 Aug 2011)
@@ -471,15 +471,13 @@
               </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>
               <notes>
                 <para>
- When the number of elements is a lot smaller than the number of buckets
- this function can be very inefficient as it has to search through empty
- buckets for the next element, in order to return the iterator.
- The method <methodname>quick_erase</methodname> is faster, but has yet
- to be standardized.
+ 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>
@@ -1371,15 +1369,13 @@
               </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>
               <notes>
                 <para>
- When the number of elements is a lot smaller than the number of buckets
- this function can be very inefficient as it has to search through empty
- buckets for the next element, in order to return the iterator.
- The method <methodname>quick_erase</methodname> is faster, but has yet
- to be standardized.
+ 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>
@@ -2285,15 +2281,13 @@
               </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>
               <notes>
                 <para>
- When the number of elements is a lot smaller than the number of buckets
- this function can be very inefficient as it has to search through empty
- buckets for the next element, in order to return the iterator.
- The method <methodname>quick_erase</methodname> is faster, but has yet
- to be standardized.
+ 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>
@@ -3234,15 +3228,13 @@
               </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>
               <notes>
                 <para>
- When the number of elements is a lot smaller than the number of buckets
- this function can be very inefficient as it has to search through empty
- buckets for the next element, in order to return the iterator.
- The method <methodname>quick_erase</methodname> is faster, but has yet
- to be standardized.
+ 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>


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