[Boost-commit] svn:boost r82382 - in sandbox-branches/geometry/index/doc/html: . geometry_index/r_tree

Subject: [Boost-commit] svn:boost r82382 - in sandbox-branches/geometry/index/doc/html: . geometry_index/r_tree
From: adam.wulkiewicz_at_[hidden]
Date: 2013-01-06 23:43:52

Author: awulkiew
Date: 2013-01-06 23:43:51 EST (Sun, 06 Jan 2013)
New Revision: 82382
URL: http://svn.boost.org/trac/boost/changeset/82382

Log:
Details removed from brief
Text files modified: 
   sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/index.html |   122 +++++++-------------------------------- 
   sandbox-branches/geometry/index/doc/html/index.html                       |     2                                         
   2 files changed, 23 insertions(+), 101 deletions(-)

Modified: sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/index.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/index.html	(original)
+++ sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/index.html	2013-01-06 23:43:51 EST (Sun, 06 Jan 2013)
@@ -31,7 +31,8 @@
 <a name="geometry_index.r_tree.index.boost_geometry_index_rtree"></a><a class="link" href="index.html#geometry_index.r_tree.index.boost_geometry_index_rtree" title="boost::geometry::index::rtree">boost::geometry::index::rtree</a>
 </h4></div></div></div>
 <p>
-          <a class="indexterm" name="idp9969336"></a><a class="indexterm" name="idp9969648"></a><a class="indexterm" name="idp9969960"></a><a class="indexterm" name="idp9970272"></a>
+          <a class="indexterm" name="idp9942920"></a><a class="indexterm" name="idp9943232"></a><a class="indexterm" name="idp9943544"></a><a class="indexterm" name="idp9943856"></a>
+The R-tree spatial index.
         </p>
 <h6>
 <a name="geometry_index.r_tree.index.boost_geometry_index_rtree.h0"></a>
@@ -322,8 +323,7 @@
                 </td>
 <td>
                   <p>
-                    The copy constructor. It uses parameters, translator and allocator
-                    from the source tree.
+                    The copy constructor.
                   </p>
                 </td>
 <td>
@@ -368,8 +368,7 @@
                 </td>
 <td>
                   <p>
-                    The moving constructor. It uses parameters, translator and allocator
-                    from the source tree.
+                    The moving constructor.
                   </p>
                 </td>
 <td>
@@ -443,8 +442,7 @@
                 </td>
 <td>
                   <p>
-                    The assignment operator. It uses parameters and translator from
-                    the source tree.
+                    The assignment operator.
                   </p>
                 </td>
 <td>
@@ -465,8 +463,7 @@
                 </td>
 <td>
                   <p>
-                    The moving assignment. It uses parameters and translator from
-                    the source tree.
+                    The moving assignment.
                   </p>
                 </td>
 <td>
@@ -487,8 +484,7 @@
                 </td>
 <td>
                   <p>
-                    Swaps contents of two rtrees. Parameters, translator and allocators
-                    are swapped as well.
+                    Swaps contents of two rtrees.
                   </p>
                 </td>
 <td>
@@ -579,8 +575,7 @@
                 </td>
 <td>
                   <p>
-                    Remove a value from the container. In contrast to the STL set/map
-                    erase() method this method removes only one value from the container.
+                    Remove a value from the container.
                   </p>
                 </td>
 <td>
@@ -607,11 +602,7 @@
                 </td>
 <td>
                   <p>
-                    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.
+                    Remove a range of values from the container.
                   </p>
                 </td>
 <td>
@@ -641,10 +632,7 @@
                 </td>
 <td>
                   <p>
-                    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.
+                    Remove a range of values from the container.
                   </p>
                 </td>
 <td>
@@ -672,19 +660,13 @@
 <td>
                   <p>
                     Finds values meeting spatial predicates, e.g. intersecting some
-                    box.
+                    Box.
                   </p>
                 </td>
 <td>
                   <p>
                     <span class="bold"><strong>Predicates const &amp;</strong></span>: <span class="emphasis"><em>pred</em></span>:
-                    The spatial predicates. May be a Geometry (in this case default
-                    predicate - intersects is used) or generated by bgi::covered_by(geometry),
-                    bgi::disjoint(geometry), bgi::intersects(geometry), bgi::overlaps(geometry),
-                    bgi::within(geometry), !bgi::covered_by(geometry), !bgi::disjoint(geometry),
-                    !bgi::intersects(geometry), !bgi::overlaps(geometry), !bgi::within(geometry)
-                    or bgi::value(func). Those predicates may be passed together
-                    in std::pair or boost::tuple.
+                    The spatial predicates or a Geometry.
                   </p>
                   <p>
                     <span class="bold"><strong>OutIter</strong></span>: <span class="emphasis"><em>out_it</em></span>:
@@ -711,25 +693,13 @@
 <td>
                   <p>
                     Finds one value meeting distances predicates, e.g. nearest to
-                    some point.
+                    some Point.
                   </p>
                 </td>
 <td>
                   <p>
                     <span class="bold"><strong>DistancesPredicates const &amp;</strong></span>:
-                    <span class="emphasis"><em>dpred</em></span>: The distances predicates. May be
-                    a Point. This is default case where Value which nearest point
-                    is closest to Point is returned. May be a PointRelation which
-                    define how distance to Value is calculated. This may be generated
-                    by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point).
-                    DistancesPredicates may also define distances bounds. E.g. that
-                    some distance must be between min_distance and max_distance.
-                    This may be generated by bgi::unbounded(PointRelation) - default
-                    case, bgi::min_bounded(PointRelation, MinRelation), bgi::max_bounded(PointRelation,
-                    MaxRelation), bgi::bounded(PointRelation, MinRelation, MaxRelation).
-                    MinRelation and MaxRelation describes bounds and may be generated
-                    by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound)
-                    or bgi::to_furthest(dist_bound).
+                    <span class="emphasis"><em>dpred</em></span>: The distances predicates or a Point.
                   </p>
                   <p>
                     <span class="bold"><strong>value_type &amp;</strong></span>: <span class="emphasis"><em>v</em></span>:
@@ -757,35 +727,17 @@
 <td>
                   <p>
                     Finds one value meeting distances predicates and spatial predicates,
-                    e.g. nearest to some point and intersecting some box.
+                    e.g. nearest to some Point and intersecting some Box.
                   </p>
                 </td>
 <td>
                   <p>
                     <span class="bold"><strong>DistancesPredicates const &amp;</strong></span>:
-                    <span class="emphasis"><em>dpred</em></span>: The distances predicates. May be
-                    a Point. This is default case where Value which nearest point
-                    is closest to Point is returned. May be a PointRelation which
-                    define how distance to Value is calculated. This may be generated
-                    by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point).
-                    DistancesPredicates may also define distances bounds. E.g. that
-                    some distance must be between min_distance and max_distance.
-                    This may be generated by bgi::unbounded(PointRelation) - default
-                    case, bgi::min_bounded(PointRelation, MinRelation), bgi::max_bounded(PointRelation,
-                    MaxRelation), bgi::bounded(PointRelation, MinRelation, MaxRelation).
-                    MinRelation and MaxRelation describes bounds and may be generated
-                    by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound)
-                    or bgi::to_furthest(dist_bound).
+                    <span class="emphasis"><em>dpred</em></span>: The distances predicates or a Point.
                   </p>
                   <p>
                     <span class="bold"><strong>Predicates const &amp;</strong></span>: <span class="emphasis"><em>pred</em></span>:
-                    The spatial predicates. May be a Geometry (in this case default
-                    predicate - intersects is used) or generated by bgi::covered_by(geometry),
-                    bgi::disjoint(geometry), bgi::intersects(geometry), bgi::overlaps(geometry),
-                    bgi::within(geometry), !bgi::covered_by(geometry), !bgi::disjoint(geometry),
-                    !bgi::intersects(geometry), !bgi::overlaps(geometry), !bgi::within(geometry)
-                    or bgi::value(func). Those predicates may be passed together
-                    in std::pair or boost::tuple.
+                    The spatial predicates or a Geometry
                   </p>
                   <p>
                     <span class="bold"><strong>value_type &amp;</strong></span>: <span class="emphasis"><em>v</em></span>:
@@ -813,25 +765,13 @@
 <td>
                   <p>
                     Finds k values meeting distances predicates, e.g. k nearest values
-                    to some point.
+                    to some Point.
                   </p>
                 </td>
 <td>
                   <p>
                     <span class="bold"><strong>DistancesPredicates const &amp;</strong></span>:
-                    <span class="emphasis"><em>dpred</em></span>: The distances predicates. May be
-                    a Point. This is default case where Value which nearest point
-                    is closest to Point is returned. May be a PointRelation which
-                    define how distance to Value is calculated. This may be generated
-                    by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point).
-                    DistancesPredicates may also define distances bounds. E.g. that
-                    some distance must be between min_distance and max_distance.
-                    This may be generated by bgi::unbounded(PointRelation) - default
-                    case, bgi::min_bounded(PointRelation, MinRelation), bgi::max_bounded(PointRelation,
-                    MaxRelation), bgi::bounded(PointRelation, MinRelation, MaxRelation).
-                    MinRelation and MaxRelation describes bounds and may be generated
-                    by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound)
-                    or bgi::to_furthest(dist_bound).
+                    <span class="emphasis"><em>dpred</em></span>: The distances predicates or a Point.
                   </p>
                   <p>
                     <span class="bold"><strong>size_t</strong></span>: <span class="emphasis"><em>k</em></span>:
@@ -866,25 +806,13 @@
 <td>
                   <p>
                     Finds k values meeting distances predicates and spatial predicates,
-                    e.g. k nearest values to some point and intersecting some box.
+                    e.g. k nearest values to some Point and intersecting some Box.
                   </p>
                 </td>
 <td>
                   <p>
                     <span class="bold"><strong>DistancesPredicates const &amp;</strong></span>:
-                    <span class="emphasis"><em>dpred</em></span>: The distances predicates. May be
-                    a Point. This is default case where Value which nearest point
-                    is closest to Point is returned. May be a PointRelation which
-                    define how distance to Value is calculated. This may be generated
-                    by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point).
-                    DistancesPredicates may also define distances bounds. E.g. that
-                    some distance must be between min_distance and max_distance.
-                    This may be generated by bgi::unbounded(PointRelation) - default
-                    case, bgi::min_bounded(PointRelation, MinRelation), bgi::max_bounded(PointRelation,
-                    MaxRelation), bgi::bounded(PointRelation, MinRelation, MaxRelation).
-                    MinRelation and MaxRelation describes bounds and may be generated
-                    by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound)
-                    or bgi::to_furthest(dist_bound).
+                    <span class="emphasis"><em>dpred</em></span>: The distances predicates or a Point
                   </p>
                   <p>
                     <span class="bold"><strong>size_t</strong></span>: <span class="emphasis"><em>k</em></span>:
@@ -892,13 +820,7 @@
                   </p>
                   <p>
                     <span class="bold"><strong>Predicates const &amp;</strong></span>: <span class="emphasis"><em>pred</em></span>:
-                    The spatial predicates. May be a Geometry (in this case default
-                    predicate - intersects is used) or generated by bgi::covered_by(geometry),
-                    bgi::disjoint(geometry), bgi::intersects(geometry), bgi::overlaps(geometry),
-                    bgi::within(geometry), !bgi::covered_by(geometry), !bgi::disjoint(geometry),
-                    !bgi::intersects(geometry), !bgi::overlaps(geometry), !bgi::within(geometry)
-                    or bgi::value(func). Those predicates may be passed together
-                    in std::pair or boost::tuple.
+                    The spatial predicates or a Geometry.
                   </p>
                   <p>
                     <span class="bold"><strong>OutIter</strong></span>: <span class="emphasis"><em>out_it</em></span>:

Modified: sandbox-branches/geometry/index/doc/html/index.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/index.html	(original)
+++ sandbox-branches/geometry/index/doc/html/index.html	2013-01-06 23:43:51 EST (Sun, 06 Jan 2013)
@@ -57,7 +57,7 @@
 </div>
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: January 07, 2013 at 03:21:24 GMT</small></p></td>
+<td align="left"><p><small>Last revised: January 07, 2013 at 04:43:31 GMT</small></p></td>
 <td align="right"><div class="copyright-footer"></div></td>
 </tr></table>
 <hr>