[Boost-commit] svn:boost r82354 - sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree

Subject: [Boost-commit] svn:boost r82354 - sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree
From: adam.wulkiewicz_at_[hidden]
Date: 2013-01-04 12:56:18

Author: awulkiew
Date: 2013-01-04 12:56:17 EST (Fri, 04 Jan 2013)
New Revision: 82354
URL: http://svn.boost.org/trac/boost/changeset/82354

Log:
remove() description improved.
Text files modified: 
   sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp |    24 ++++++++++++++++++------                
   1 files changed, 18 insertions(+), 6 deletions(-)

Modified: sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp
==============================================================================
--- sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp	(original)
+++ sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp	2013-01-04 12:56:17 EST (Fri, 04 Jan 2013)
@@ -368,7 +368,8 @@
     }
 
     /*!
-    Remove a value from the container.
+    Remove a value from the container. In contrast to the STL set/map erase() method
+    this method removes only one value from the container.
 
     \note Exception-safety: basic
 
@@ -382,7 +383,10 @@
     }
 
     /*!
-    Remove a range of values from the container.
+    Remove a range of values from the container. In contrast to the STL set/map erase() method
+    it doesn't take iterators pointing to values stored in this container. It removes values equal
+    to these passed as a range. Furthermore this method removes only one value for each one passed
+    in the range, not all equal values.
 
     \note Exception-safety: basic
 
@@ -401,7 +405,9 @@
     }
 
     /*!
-    Remove a range of values from the container.
+    Remove a range of values from the container. In contrast to the STL set/map erase() method
+    it removes values equal to these passed as a range. Furthermore, this method removes only
+    one value for each one passed in the range, not all equal values.
 
     \note Exception-safety: basic
 
@@ -1013,7 +1019,8 @@
 }
 
 /*!
-Remove a value from the index.
+Remove a value from the container. In contrast to the STL set/map erase() method
+this function removes only one value from the container.
 
 \param tree The spatial index.
 \param v    The value which will be removed from the index.
@@ -1028,7 +1035,10 @@
 }
 
 /*!
-Remove a range of values from the index.
+Remove a range of values from the container. In contrast to the STL set/map erase() method
+it doesn't take iterators pointing to values stored in this container. It removes values equal
+to these passed as a range. Furthermore this function removes only one value for each one passed
+in the range, not all equal values.
 
 \param tree     The spatial index.
 \param first    The beginning of the range of values.
@@ -1044,7 +1054,9 @@
 }
 
 /*!
-Remove a range of values from the index.
+Remove a range of values from the container. In contrast to the STL set/map erase() method
+it removes values equal to these passed as a range. Furthermore this method removes only
+one value for each one passed in the range, not all equal values.
 
 \param tree     The spatial index.
 \param rng      The range of values.