|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r82446 - in sandbox-branches/geometry/index: boost/geometry/extensions/index boost/geometry/extensions/index/rtree doc/generated doc/html doc/html/geometry_index doc/html/geometry_index/r_tree doc/src/tools/doxygen_xml2qbk
From: adam.wulkiewicz_at_[hidden]
Date: 2013-01-10 23:09:34
Author: awulkiew
Date: 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
New Revision: 82446
URL: http://svn.boost.org/trac/boost/changeset/82446
Log:
Fixed errors in doxygen_xml2qbk - lists support, additional paragraphs display.
Added warnings and infos.
Rtree docs improved, added text formatting, warnings etc.
Text files modified:
sandbox-branches/geometry/index/boost/geometry/extensions/index/distance_predicates.hpp | 28
sandbox-branches/geometry/index/boost/geometry/extensions/index/predicates.hpp | 24
sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp | 301 +++++--
sandbox-branches/geometry/index/doc/generated/adaptors.qbk | 6
sandbox-branches/geometry/index/doc/generated/distance_predicates.qbk | 28
sandbox-branches/geometry/index/doc/generated/inserters.qbk | 2
sandbox-branches/geometry/index/doc/generated/predicates.qbk | 42
sandbox-branches/geometry/index/doc/generated/rtree.qbk | 397 +++++++++--
sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk | 36
sandbox-branches/geometry/index/doc/generated/translator_index.qbk | 2
sandbox-branches/geometry/index/doc/html/geometry_index/introduction.html | 2
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree.html | 2
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/creation_and_modification.html | 10
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/introduction.html | 20
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/nearest_neighbours_queries.html | 2
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html | 1348 ++++++++++++++++++++++++++-------------
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/rtree_quickstart.html | 4
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/spatial_queries.html | 2
sandbox-branches/geometry/index/doc/html/index.html | 4
sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/doxygen_elements.hpp | 2
sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/doxygen_xml_parser.hpp | 10
sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp | 50 +
22 files changed, 1562 insertions(+), 760 deletions(-)
Modified: sandbox-branches/geometry/index/boost/geometry/extensions/index/distance_predicates.hpp
==============================================================================
--- sandbox-branches/geometry/index/boost/geometry/extensions/index/distance_predicates.hpp (original)
+++ sandbox-branches/geometry/index/boost/geometry/extensions/index/distance_predicates.hpp 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -288,10 +288,10 @@
\tparam PointRelation PointRelation type.
\tparam MinRelation MinRelation type.
-\param pr The point relation. This may be generated by bgi::to_nearest(Point),
- bgi::to_centroid(Point) or bgi::to_furthest(Point).
-\param minr The minimum bound relation. This may be generated by bgi::to_nearest(min_distance),
- bgi::to_centroid(min_distance) or bgi::to_furthest(min_distance).
+\param pr The point relation. This may be generated by \c bgi::to_nearest(Point),
+ \c bgi::to_centroid(Point) or \c bgi::to_furthest(Point).
+\param minr The minimum bound relation. This may be generated by \c bgi::to_nearest(min_distance),
+ \c bgi::to_centroid(min_distance) or \c bgi::to_furthest(min_distance).
*/
template <typename PointRelation, typename MinRelation>
inline detail::min_bounded<PointRelation, MinRelation>
@@ -314,10 +314,10 @@
\tparam PointRelation PointRelation type.
\tparam MaxRelation MaxRelation type.
-\param pr The point relation. This may be generated by bgi::to_nearest(Point),
- bgi::to_centroid(Point) or bgi::to_furthest(Point).
-\param maxr The maximum bound relation. This may be generated by bgi::to_nearest(max_distance),
- bgi::to_centroid(max_distance) or bgi::to_furthest(max_distance).
+\param pr The point relation. This may be generated by \c bgi::to_nearest(Point),
+ \c bgi::to_centroid(Point) or \c bgi::to_furthest(Point).
+\param maxr The maximum bound relation. This may be generated by \c bgi::to_nearest(max_distance),
+ \c bgi::to_centroid(max_distance) or \c bgi::to_furthest(max_distance).
*/
template <typename PointRelation, typename MaxRelation>
inline detail::max_bounded<PointRelation, MaxRelation>
@@ -342,12 +342,12 @@
\tparam MinRelation MinRelation type.
\tparam MaxRelation MaxRelation type.
-\param pr The point relation. This may be generated by bgi::to_nearest(Point),
- bgi::to_centroid(Point) or bgi::to_furthest(Point).
-\param minr The minimum bound relation. This may be generated by bgi::to_nearest(min_distance),
- bgi::to_centroid(min_distance) or bgi::to_furthest(min_distance).
-\param maxr The maximum bound relation. This may be generated by bgi::to_nearest(max_distance),
- bgi::to_centroid(max_distance) or bgi::to_furthest(max_distance).
+\param pr The point relation. This may be generated by \c bgi::to_nearest(Point),
+ \c bgi::to_centroid(Point) or \c bgi::to_furthest(Point).
+\param minr The minimum bound relation. This may be generated by \c bgi::to_nearest(min_distance),
+ \c bgi::to_centroid(min_distance) or \c bgi::to_furthest(min_distance).
+\param maxr The maximum bound relation. This may be generated by \c bgi::to_nearest(max_distance),
+ \c bgi::to_centroid(max_distance) or \c bgi::to_furthest(max_distance).
*/
template <typename PointRelation, typename MinRelation, typename MaxRelation>
inline detail::bounded<PointRelation, MinRelation, MaxRelation>
Modified: sandbox-branches/geometry/index/boost/geometry/extensions/index/predicates.hpp
==============================================================================
--- sandbox-branches/geometry/index/boost/geometry/extensions/index/predicates.hpp (original)
+++ sandbox-branches/geometry/index/boost/geometry/extensions/index/predicates.hpp 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -154,10 +154,10 @@
}
/*!
-\brief Generate covered_by() predicate.
+\brief Generate \c covered_by() predicate.
Generate a predicate defining Value and Geometry relationship.
-Value will be returned by the query if bg::covered_by(Indexable, Geometry)
+Value will be returned by the query if <tt>bg::covered_by(Indexable, Geometry)</tt>
returns true.
\ingroup predicates
@@ -173,10 +173,10 @@
}
/*!
-\brief Generate disjoint() predicate.
+\brief Generate \c disjoint() predicate.
Generate a predicate defining Value and Geometry relationship.
-Value will be returned by the query if bg::disjoint(Indexable, Geometry)
+Value will be returned by the query if <tt>bg::disjoint(Indexable, Geometry)</tt>
returns true.
\ingroup predicates
@@ -192,10 +192,10 @@
}
/*!
-\brief Generate intersects() predicate.
+\brief Generate \c intersects() predicate.
Generate a predicate defining Value and Geometry relationship.
-Value will be returned by the query if bg::intersects(Indexable, Geometry)
+Value will be returned by the query if <tt>bg::intersects(Indexable, Geometry)</tt>
returns true.
\ingroup predicates
@@ -211,10 +211,10 @@
}
/*!
-\brief Generate overlaps() predicate.
+\brief Generate \c overlaps() predicate.
Generate a predicate defining Value and Geometry relationship.
-Value will be returned by the query if bg::overlaps(Indexable, Geometry)
+Value will be returned by the query if <tt>bg::overlaps(Indexable, Geometry)</tt>
returns true.
\ingroup predicates
@@ -230,10 +230,10 @@
}
//*!
-//\brief Generate touches() predicate.
+//\brief Generate \c touches() predicate.
//
//Generate a predicate defining Value and Geometry relationship.
-//Value will be returned by the query if bg::touches(Indexable, Geometry)
+//Value will be returned by the query if <tt>bg::touches(Indexable, Geometry)</tt>
//returns true.
//
//\ingroup predicates
@@ -249,10 +249,10 @@
//}
/*!
-\brief Generate within() predicate.
+\brief Generate \c within() predicate.
Generate a predicate defining Value and Geometry relationship.
-Value will be returned by the query if bg::within(Indexable, Geometry)
+Value will be returned by the query if <tt>bg::within(Indexable, Geometry)</tt>
returns true.
\ingroup predicates
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-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -66,22 +66,26 @@
The user must pass a type defining the Parameters which will
be used in rtree creation process. This type is used e.g. to specify balancing algorithm
with specific parameters like min and max number of elements in node.
+
+\par
Predefined algorithms with compile-time parameters are:
-bgi::linear<MinElements, MaxElements>,
-bgi::quadratic<MinElements, MaxElements>,
-bgi::rstar<MinElements, MaxElements, OverlapCostThreshold = 0, ReinsertedElements = MaxElements * 0.3>.
+ \li <tt>bgi::linear<MinElements, MaxElements></tt>,
+ \li <tt>bgi::quadratic<MinElements, MaxElements></tt>,
+ \li <tt>bgi::rstar<MinElements, MaxElements, OverlapCostThreshold = 0, ReinsertedElements = MaxElements * 0.3></tt>.
+
+\par
Predefined algorithms with run-time parameters are:
-bgi::runtime::linear,
-bgi::runtime::quadratic,
-bgi::runtime::rstar.
+ \li \c bgi::runtime::linear,
+ \li \c bgi::runtime::quadratic,
+ \li \c bgi::runtime::rstar.
\par Translator
The Translator translates from Value to Indexable each time r-tree requires it. Which means that this
operation is done for each Value access. Therefore the Translator should return the Indexable by
const reference instead of a value. Default translator can translate all types adapted to Point
-or Box concepts (which are Indexables). It also handles std::pair<Indexable, T>, pointers, smart pointers,
-and iterators. E.g. If std::pair<Box, int> is stored, the default translator translates from
-std::pair<Box, int> const& to Box const&.
+or Box concepts (called Indexables). It also handles <tt>std::pair<Indexable, T></tt> and
+<tt>boost::tuple<Indexable, ...></tt>. For example, if <tt>std::pair<Box, int></tt> is stored in the
+container, the default translator translates from <tt>std::pair<Box, int> const&</tt> to <tt>Box const&</tt>.
\tparam Value The type of objects stored in the container.
\tparam Parameters Compile-time parameters.
@@ -177,8 +181,10 @@
\param allocator The allocator object.
\par Throws
- If allocator copy constructor throws. If Value copy constructor or copy assignment throws.
- When nodes allocation fails.
+ \li If allocator copy constructor throws.
+ \li If Value copy constructor or copy assignment throws.
+ \li If allocation throws.
+ \li When memory allocation for Node fails.
*/
template<typename Iterator>
inline rtree(Iterator first, Iterator last,
@@ -212,8 +218,10 @@
\param allocator The allocator object.
\par Throws
- If allocator copy constructor throws. If Value copy constructor or copy assignment throws.
- When nodes allocation fails.
+ \li If allocator copy constructor throws.
+ \li If Value copy constructor or copy assignment throws.
+ \li If allocation throws.
+ \li When memory allocation for Node fails.
*/
template<typename Range>
inline explicit rtree(Range const& rng,
@@ -257,8 +265,10 @@
\param src The rtree which content will be copied.
\par Throws
- If allocator copy constructor throws. If Value copy constructor throws.
- When nodes allocation fails.
+ \li If allocator copy constructor throws.
+ \li If Value copy constructor throws.
+ \li If allocation throws.
+ \li When memory allocation for Node fails.
*/
inline rtree(rtree const& src)
: m_translator(src.m_translator) // SHOULDN'T THROW
@@ -282,8 +292,10 @@
\param allocator The allocator which will be used.
\par Throws
- If allocator copy constructor throws. If Value copy constructor throws.
- When nodes allocation fails.
+ \li If allocator copy constructor throws.
+ \li If Value copy constructor throws.
+ \li If allocation throws.
+ \li When memory allocation for Node fails.
*/
inline rtree(rtree const& src, allocator_type const& allocator)
: m_translator(src.m_translator) // SHOULDN'T THROW
@@ -328,8 +340,9 @@
\param src The rtree which content will be copied.
\par Throws
- If Value copy constructor throws.
- When nodes allocation fails.
+ \li If Value copy constructor throws.
+ \li If allocation throws.
+ \li When nodes allocation fails.
*/
inline rtree & operator=(BOOST_COPY_ASSIGN_REF(rtree) src)
{
@@ -352,7 +365,10 @@
\param src The rtree which content will be moved.
\par Throws
- Only if allocators aren't equal. If Value copy constructor throws. When nodes allocation fails.
+ Only if allocators aren't equal.
+ \li If Value copy constructor throws.
+ \li If allocation throws.
+ \li When nodes allocation fails.
*/
inline rtree & operator=(BOOST_RV_REF(rtree) src)
{
@@ -412,9 +428,11 @@
\param value The value which will be stored in the container.
\par Throws
- If Value copy constructor or copy assignment throws. When nodes allocation fails.
+ \li If Value copy constructor or copy assignment throws.
+ \li If allocation throws.
+ \li When nodes allocation fails.
- \par Exception-safety
+ \warning
This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state,
elements must not be inserted or removed, methods may return invalid data.
*/
@@ -433,9 +451,11 @@
\param last The end of the range of values.
\par Throws
- If Value copy constructor or copy assignment throws. When nodes allocation fails.
+ \li If Value copy constructor or copy assignment throws.
+ \li If allocation throws.
+ \li When nodes allocation fails.
- \par Exception-safety
+ \warning
This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state,
elements must not be inserted or removed, methods may return invalid data.
*/
@@ -455,9 +475,11 @@
\param rng The range of values.
\par Throws
- If Value copy constructor or copy assignment throws. When nodes allocation fails.
+ \li If Value copy constructor or copy assignment throws.
+ \li If allocation throws.
+ \li When nodes allocation fails.
- \par Exception-safety
+ \warning
This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state,
elements must not be inserted or removed, methods may return invalid data.
*/
@@ -475,7 +497,7 @@
/*!
\brief Remove a value from the container.
- In contrast to the STL set/map erase() method
+ In contrast to the \c std::set or \c std::map \c erase() method
this method removes only one value from the container.
\param value The value which will be removed from the container.
@@ -483,9 +505,11 @@
\return 1 if the value was removed, 0 otherwise.
\par Throws
- If Value copy constructor or copy assignment throws. When nodes allocation fails.
+ \li If Value copy constructor or copy assignment throws.
+ \li If allocation throws.
+ \li When nodes allocation fails.
- \par Exception-safety
+ \warning
This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state,
elements must not be inserted or removed, methods may return invalid data.
*/
@@ -497,7 +521,7 @@
/*!
\brief Remove a range of values from the container.
- In contrast to the STL set/map erase() method
+ In contrast to the \c std::set or \c std::map \c 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.
@@ -508,9 +532,11 @@
\return The number of removed values.
\par Throws
- If Value copy constructor or copy assignment throws. When nodes allocation fails.
+ \li If Value copy constructor or copy assignment throws.
+ \li If allocation throws.
+ \li When nodes allocation fails.
- \par Exception-safety
+ \warning
This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state,
elements must not be inserted or removed, methods may return invalid data.
*/
@@ -526,7 +552,7 @@
/*!
\brief Remove a range of values from the container.
- In contrast to the STL set/map erase() method
+ In contrast to the \c std::set or \c std::map \c 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.
@@ -535,9 +561,11 @@
\return The number of removed values.
\par Throws
- If Value copy constructor or copy assignment throws. When nodes allocation fails.
+ \li If Value copy constructor or copy assignment throws.
+ \li If allocation throws.
+ \li When nodes allocation fails.
- \par Exception-safety
+ \warning
This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state,
elements must not be inserted or removed, methods may return invalid data.
*/
@@ -554,13 +582,23 @@
/*!
\brief Finds values meeting spatial predicates, e.g. intersecting some Box.
- 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.
+ <b>Spatial predicates</b> may be a \c Geometry. In this case Values intersecting the \c Geometry are returned.
+
+ It may be generated by one of the functions listed below:
+ \li \c bgi::covered_by(geometry),
+ \li \c bgi::disjoint(geometry),
+ \li \c bgi::intersects(geometry) - default,
+ \li \c bgi::overlaps(geometry),
+ \li \c bgi::within(geometry),
+ \li \c !bgi::covered_by(geometry),
+ \li \c !bgi::disjoint(geometry),
+ \li \c !bgi::intersects(geometry),
+ \li \c !bgi::overlaps(geometry),
+ \li \c !bgi::within(geometry)
+ \li \c bgi::value(func).
+
+ Those predicates may be passed together in
+ \c std::pair<...> or \c boost::tuple<...>.
\param pred The spatial predicates or a Geometry.
\param out_it The output iterator of the result range. E.g. an iterator generated by
@@ -569,7 +607,8 @@
\return The number of values found.
\par Throws
- If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
+ \li If Value copy constructor or copy assignment throws.
+ \li If OutIter dereference or increment throws.
*/
template <typename Predicates, typename OutIter>
inline size_type spatial_query(Predicates const& pred, OutIter out_it) const
@@ -588,15 +627,26 @@
/*!
\brief Finds one value meeting distances predicates, e.g. nearest to some Point.
- 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).
+ <b>Distances predicates</b> may be a \c Point. In this the case the Value closest to \c Point is returned.
+
+ It is possible to define how distance to Value is calculated. This is done by passing PointRelation.
+ It can be generated by following functions:
+ \li bgi::to_nearest(Point) - default,
+ \li bgi::to_centroid(Point),
+ \li bgi::to_furthest(Point).
+
+ It is possible to define define distances bounds, for example that some distance must be between
+ min_distance and max_distance. This is done by passing DistancesPredicates which can be generated
+ by following functions:
+ \li bgi::unbounded(PointRelation) - default,
+ \li bgi::min_bounded(PointRelation, MinRelation),
+ \li bgi::max_bounded(PointRelation, MaxRelation),
+ \li bgi::bounded(PointRelation, MinRelation, MaxRelation).
+
+ MinRelation and MaxRelation describes bounds and can be generated by following functions:
+ \li bgi::to_nearest(some_distance),
+ \li bgi::to_centroid(some_distance),
+ \li bgi::to_furthest(some_distance).
\param dpred The distances predicates or a Point.
@@ -617,23 +667,44 @@
\brief Finds one value meeting distances predicates and spatial predicates,
e.g. nearest to some Point and intersecting some Box.
- 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).
-
- 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.
+ <b>Distances predicates</b> may be a \c Point. In this the case the Value closest to \c Point is returned.
+
+ It is possible to define how distance to Value is calculated. This is done by passing PointRelation.
+ It can be generated by following functions:
+ \li bgi::to_nearest(Point) - default,
+ \li bgi::to_centroid(Point),
+ \li bgi::to_furthest(Point).
+
+ It is possible to define define distances bounds, for example that some distance must be between
+ min_distance and max_distance. This is done by passing DistancesPredicates which can be generated
+ by following functions:
+ \li bgi::unbounded(PointRelation) - default,
+ \li bgi::min_bounded(PointRelation, MinRelation),
+ \li bgi::max_bounded(PointRelation, MaxRelation),
+ \li bgi::bounded(PointRelation, MinRelation, MaxRelation).
+
+ MinRelation and MaxRelation describes bounds and can be generated by following functions:
+ \li bgi::to_nearest(some_distance),
+ \li bgi::to_centroid(some_distance),
+ \li bgi::to_furthest(some_distance).
+
+ <b>Spatial predicates</b> may be a \c Geometry. In this case Values intersecting the \c Geometry are returned.
+
+ It may be generated by one of the functions listed below:
+ \li \c bgi::covered_by(geometry),
+ \li \c bgi::disjoint(geometry),
+ \li \c bgi::intersects(geometry) - default,
+ \li \c bgi::overlaps(geometry),
+ \li \c bgi::within(geometry),
+ \li \c !bgi::covered_by(geometry),
+ \li \c !bgi::disjoint(geometry),
+ \li \c !bgi::intersects(geometry),
+ \li \c !bgi::overlaps(geometry),
+ \li \c !bgi::within(geometry)
+ \li \c bgi::value(func).
+
+ Those predicates may be passed together in
+ \c std::pair<...> or \c boost::tuple<...>.
\param dpred The distances predicates or a Point.
\param pred The spatial predicates or a Geometry
@@ -653,15 +724,26 @@
/*!
\brief Finds k values meeting distances predicates, e.g. k nearest values to some Point.
- 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).
+ <b>Distances predicates</b> may be a \c Point. In this the case the Value closest to \c Point is returned.
+
+ It is possible to define how distance to Value is calculated. This is done by passing PointRelation.
+ It can be generated by following functions:
+ \li bgi::to_nearest(Point) - default,
+ \li bgi::to_centroid(Point),
+ \li bgi::to_furthest(Point).
+
+ It is possible to define define distances bounds, for example that some distance must be between
+ min_distance and max_distance. This is done by passing DistancesPredicates which can be generated
+ by following functions:
+ \li bgi::unbounded(PointRelation) - default,
+ \li bgi::min_bounded(PointRelation, MinRelation),
+ \li bgi::max_bounded(PointRelation, MaxRelation),
+ \li bgi::bounded(PointRelation, MinRelation, MaxRelation).
+
+ MinRelation and MaxRelation describes bounds and can be generated by following functions:
+ \li bgi::to_nearest(some_distance),
+ \li bgi::to_centroid(some_distance),
+ \li bgi::to_furthest(some_distance).
\param dpred The distances predicates or a Point.
\param k The max number of values.
@@ -682,23 +764,44 @@
\brief Finds k values meeting distances predicates and spatial predicates,
e.g. k nearest values to some Point and intersecting some Box.
- 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).
-
- 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.
+ <b>Distances predicates</b> may be a \c Point. In this the case the Value closest to \c Point is returned.
+
+ It is possible to define how distance to Value is calculated. This is done by passing PointRelation.
+ It can be generated by following functions:
+ \li bgi::to_nearest(Point) - default,
+ \li bgi::to_centroid(Point),
+ \li bgi::to_furthest(Point).
+
+ It is possible to define define distances bounds, for example that some distance must be between
+ min_distance and max_distance. This is done by passing DistancesPredicates which can be generated
+ by following functions:
+ \li bgi::unbounded(PointRelation) - default,
+ \li bgi::min_bounded(PointRelation, MinRelation),
+ \li bgi::max_bounded(PointRelation, MaxRelation),
+ \li bgi::bounded(PointRelation, MinRelation, MaxRelation).
+
+ MinRelation and MaxRelation describes bounds and can be generated by following functions:
+ \li bgi::to_nearest(some_distance),
+ \li bgi::to_centroid(some_distance),
+ \li bgi::to_furthest(some_distance).
+
+ <b>Spatial predicates</b> may be a \c Geometry. In this case Values intersecting the \c Geometry are returned.
+
+ It may be generated by one of the functions listed below:
+ \li \c bgi::covered_by(geometry),
+ \li \c bgi::disjoint(geometry),
+ \li \c bgi::intersects(geometry) - default,
+ \li \c bgi::overlaps(geometry),
+ \li \c bgi::within(geometry),
+ \li \c !bgi::covered_by(geometry),
+ \li \c !bgi::disjoint(geometry),
+ \li \c !bgi::intersects(geometry),
+ \li \c !bgi::overlaps(geometry),
+ \li \c !bgi::within(geometry)
+ \li \c bgi::value(func).
+
+ Those predicates may be passed together in
+ \c std::pair<...> or \c boost::tuple<...>.
\param dpred The distances predicates or a Point
\param k The max number of values.
@@ -757,7 +860,7 @@
\brief Returns the box containing all values stored in the container.
Returns the box containing all values stored in the container.
- If the container is empty the result of geometry::assign_inverse() is returned.
+ If the container is empty the result of \c geometry::assign_inverse() is returned.
\return The box containing all values stored in the container or an invalid box if
there are no values in the container.
@@ -1170,7 +1273,7 @@
/*!
\brief Remove a value from the container.
-Remove a value from the container. In contrast to the STL set/map erase() method
+Remove a value from the container. In contrast to the \c std::set or \c std::map \c erase() method
this function removes only one value from the container.
\ingroup rtree_functions
@@ -1190,7 +1293,7 @@
/*!
\brief 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
+Remove a range of values from the container. In contrast to the \c std::set or \c std::map \c 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.
@@ -1213,7 +1316,7 @@
/*!
\brief 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
+Remove a range of values from the container. In contrast to the \c std::set or \c std::map \c 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.
Modified: sandbox-branches/geometry/index/doc/generated/adaptors.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/adaptors.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/adaptors.qbk 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -17,7 +17,7 @@
size_t k,
Predicates const & pred)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `DistancesPredicates const &` ][ `dpred` ][Distance predicates. ]]
@@ -33,7 +33,7 @@
``template<typename DistancesPredicates>
detail::nearest_query<DistancesPredicates, index::detail::empty> boost::geometry::index::adaptors::nearest_queried(DistancesPredicates const & dpred, size_t k)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `DistancesPredicates const &` ][ `dpred` ][Distance predicates. ]]
@@ -48,7 +48,7 @@
``template<typename Predicates>
detail::spatial_query<Predicates> boost::geometry::index::adaptors::spatial_queried(Predicates const & pred)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `Predicates const &` ][ `pred` ][Spatial predicates. ]]
Modified: sandbox-branches/geometry/index/doc/generated/distance_predicates.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/distance_predicates.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/distance_predicates.qbk 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -20,7 +20,7 @@
``template<typename T>
detail::to_nearest<T> boost::geometry::index::to_nearest(T const & v)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `T const &` ][ `v` ][Point or bound value. ]]
@@ -35,7 +35,7 @@
``template<typename T>
detail::to_centroid<T> boost::geometry::index::to_centroid(T const & v)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `T const &` ][ `v` ][Point or bound value. ]]
@@ -50,7 +50,7 @@
``template<typename T>
detail::to_furthest<T> boost::geometry::index::to_furthest(T const & v)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `T const &` ][ `v` ][Point or bound value. ]]
@@ -65,7 +65,7 @@
``template<typename PointRelation>
detail::unbounded<PointRelation> boost::geometry::index::unbounded(PointRelation const & pr)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `PointRelation const &` ][ `pr` ][The point relation. This may be generated by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point). ]]
@@ -80,11 +80,11 @@
``template<typename PointRelation, typename MinRelation>
detail::min_bounded<PointRelation, MinRelation> boost::geometry::index::min_bounded(PointRelation const & pr, MinRelation const & minr)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
-[[ `PointRelation const &` ][ `pr` ][The point relation. This may be generated by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point). ]]
-[[ `MinRelation const &` ][ `minr` ][The minimum bound relation. This may be generated by bgi::to_nearest(min_distance), bgi::to_centroid(min_distance) or bgi::to_furthest(min_distance). ]]
+[[ `PointRelation const &` ][ `pr` ][The point relation. This may be generated by [^bgi::to_nearest(Point)], [^bgi::to_centroid(Point)] or [^bgi::to_furthest(Point)]. ]]
+[[ `MinRelation const &` ][ `minr` ][The minimum bound relation. This may be generated by [^bgi::to_nearest(min_distance)], [^bgi::to_centroid(min_distance)] or [^bgi::to_furthest(min_distance)]. ]]
]
[endsect]
@@ -96,11 +96,11 @@
``template<typename PointRelation, typename MaxRelation>
detail::max_bounded<PointRelation, MaxRelation> boost::geometry::index::max_bounded(PointRelation const & pr, MaxRelation const & maxr)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
-[[ `PointRelation const &` ][ `pr` ][The point relation. This may be generated by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point). ]]
-[[ `MaxRelation const &` ][ `maxr` ][The maximum bound relation. This may be generated by bgi::to_nearest(max_distance), bgi::to_centroid(max_distance) or bgi::to_furthest(max_distance). ]]
+[[ `PointRelation const &` ][ `pr` ][The point relation. This may be generated by [^bgi::to_nearest(Point)], [^bgi::to_centroid(Point)] or [^bgi::to_furthest(Point)]. ]]
+[[ `MaxRelation const &` ][ `maxr` ][The maximum bound relation. This may be generated by [^bgi::to_nearest(max_distance)], [^bgi::to_centroid(max_distance)] or [^bgi::to_furthest(max_distance)]. ]]
]
[endsect]
@@ -116,12 +116,12 @@
MinRelation const & minr,
MaxRelation const & maxr)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
-[[ `PointRelation const &` ][ `pr` ][The point relation. This may be generated by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point). ]]
-[[ `MinRelation const &` ][ `minr` ][The minimum bound relation. This may be generated by bgi::to_nearest(min_distance), bgi::to_centroid(min_distance) or bgi::to_furthest(min_distance). ]]
-[[ `MaxRelation const &` ][ `maxr` ][The maximum bound relation. This may be generated by bgi::to_nearest(max_distance), bgi::to_centroid(max_distance) or bgi::to_furthest(max_distance). ]]
+[[ `PointRelation const &` ][ `pr` ][The point relation. This may be generated by [^bgi::to_nearest(Point)], [^bgi::to_centroid(Point)] or [^bgi::to_furthest(Point)]. ]]
+[[ `MinRelation const &` ][ `minr` ][The minimum bound relation. This may be generated by [^bgi::to_nearest(min_distance)], [^bgi::to_centroid(min_distance)] or [^bgi::to_furthest(min_distance)]. ]]
+[[ `MaxRelation const &` ][ `maxr` ][The maximum bound relation. This may be generated by [^bgi::to_nearest(max_distance)], [^bgi::to_centroid(max_distance)] or [^bgi::to_furthest(max_distance)]. ]]
]
[endsect]
Modified: sandbox-branches/geometry/index/doc/generated/inserters.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/inserters.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/inserters.qbk 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -14,7 +14,7 @@
``template<typename Container>
insert_iterator<Container> boost::geometry::index::inserter(Container & c)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `Container &` ][ `c` ][The reference to the container (spatial index) to which values will be inserted.]]
Modified: sandbox-branches/geometry/index/doc/generated/predicates.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/predicates.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/predicates.qbk 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -5,11 +5,11 @@
[[Function][Description]]
[[[link geometry_index.r_tree.reference.group__predicates.function0 `empty()`]][Generate empty predicate. ]]
[[[link geometry_index.r_tree.reference.group__predicates.function1 `value(ValuePredicate const &)`]][Generate value predicate. ]]
-[[[link geometry_index.r_tree.reference.group__predicates.function2 `covered_by(Geometry const &)`]][Generate covered_by() predicate. ]]
-[[[link geometry_index.r_tree.reference.group__predicates.function3 `disjoint(Geometry const &)`]][Generate disjoint() predicate. ]]
-[[[link geometry_index.r_tree.reference.group__predicates.function4 `intersects(Geometry const &)`]][Generate intersects() predicate. ]]
-[[[link geometry_index.r_tree.reference.group__predicates.function5 `overlaps(Geometry const &)`]][Generate overlaps() predicate. ]]
-[[[link geometry_index.r_tree.reference.group__predicates.function6 `within(Geometry const &)`]][Generate within() predicate. ]]
+[[[link geometry_index.r_tree.reference.group__predicates.function2 `covered_by(Geometry const &)`]][Generate [^covered_by()] predicate. ]]
+[[[link geometry_index.r_tree.reference.group__predicates.function3 `disjoint(Geometry const &)`]][Generate [^disjoint()] predicate. ]]
+[[[link geometry_index.r_tree.reference.group__predicates.function4 `intersects(Geometry const &)`]][Generate [^intersects()] predicate. ]]
+[[[link geometry_index.r_tree.reference.group__predicates.function5 `overlaps(Geometry const &)`]][Generate [^overlaps()] predicate. ]]
+[[[link geometry_index.r_tree.reference.group__predicates.function6 `within(Geometry const &)`]][Generate [^within()] predicate. ]]
]
[section:function0 empty()]
@@ -28,7 +28,7 @@
``template<typename ValuePredicate>
detail::value<ValuePredicate> boost::geometry::index::value(ValuePredicate const & vpred)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `ValuePredicate const &` ][ `vpred` ][The functor. ]]
@@ -36,14 +36,14 @@
[endsect]
[section:function2 covered_by(Geometry const &)]
-Generate covered_by() predicate.
+Generate [^covered_by()] predicate.
[heading Description]
-Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if bg::covered_by(Indexable, Geometry) returns true.[heading Synopsis]
+Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if [^bg::covered_by(Indexable, Geometry)] returns true.[heading Synopsis]
``template<typename Geometry>
detail::covered_by<Geometry> boost::geometry::index::covered_by(Geometry const & g)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `Geometry const &` ][ `g` ][The Geometry object. ]]
@@ -51,14 +51,14 @@
[endsect]
[section:function3 disjoint(Geometry const &)]
-Generate disjoint() predicate.
+Generate [^disjoint()] predicate.
[heading Description]
-Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if bg::disjoint(Indexable, Geometry) returns true.[heading Synopsis]
+Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if [^bg::disjoint(Indexable, Geometry)] returns true.[heading Synopsis]
``template<typename Geometry>
detail::disjoint<Geometry> boost::geometry::index::disjoint(Geometry const & g)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `Geometry const &` ][ `g` ][The Geometry object. ]]
@@ -66,14 +66,14 @@
[endsect]
[section:function4 intersects(Geometry const &)]
-Generate intersects() predicate.
+Generate [^intersects()] predicate.
[heading Description]
-Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if bg::intersects(Indexable, Geometry) returns true.[heading Synopsis]
+Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if [^bg::intersects(Indexable, Geometry)] returns true.[heading Synopsis]
``template<typename Geometry>
detail::intersects<Geometry> boost::geometry::index::intersects(Geometry const & g)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `Geometry const &` ][ `g` ][The Geometry object. ]]
@@ -81,14 +81,14 @@
[endsect]
[section:function5 overlaps(Geometry const &)]
-Generate overlaps() predicate.
+Generate [^overlaps()] predicate.
[heading Description]
-Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if bg::overlaps(Indexable, Geometry) returns true.[heading Synopsis]
+Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if [^bg::overlaps(Indexable, Geometry)] returns true.[heading Synopsis]
``template<typename Geometry>
detail::overlaps<Geometry> boost::geometry::index::overlaps(Geometry const & g)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `Geometry const &` ][ `g` ][The Geometry object. ]]
@@ -96,14 +96,14 @@
[endsect]
[section:function6 within(Geometry const &)]
-Generate within() predicate.
+Generate [^within()] predicate.
[heading Description]
-Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if bg::within(Indexable, Geometry) returns true.[heading Synopsis]
+Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if [^bg::within(Indexable, Geometry)] returns true.[heading Synopsis]
``template<typename Geometry>
detail::within<Geometry> boost::geometry::index::within(Geometry const & g)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `Geometry const &` ][ `g` ][The Geometry object. ]]
Modified: sandbox-branches/geometry/index/doc/generated/rtree.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/rtree.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/rtree.qbk 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -9,9 +9,32 @@
The R-tree spatial index. This is self-balancing spatial index capable to store various types of Values and balancing algorithms.
[heading Parameters]
-The user must pass a type defining the Parameters which will be used in rtree creation process. This type is used e.g. to specify balancing algorithm with specific parameters like min and max number of elements in node. Predefined algorithms with compile-time parameters are: bgi::linear<MinElements, MaxElements>, bgi::quadratic<MinElements, MaxElements>, bgi::rstar<MinElements, MaxElements, OverlapCostThreshold = 0, ReinsertedElements = MaxElements * 0.3>. Predefined algorithms with run-time parameters are: bgi::runtime::linear, bgi::runtime::quadratic, bgi::runtime::rstar.
+The user must pass a type defining the Parameters which will be used in rtree creation process. This type is used e.g. to specify balancing algorithm with specific parameters like min and max number of elements in node.
+
+
+
+
+Predefined algorithms with compile-time parameters are:
+
+* [^bgi::linear<MinElements, MaxElements>],
+* [^bgi::quadratic<MinElements, MaxElements>],
+* [^bgi::rstar<MinElements, MaxElements, OverlapCostThreshold = 0, ReinsertedElements = MaxElements * 0.3>].
+
+
+
+
+
+
+Predefined algorithms with run-time parameters are:
+
+* [^bgi::runtime::linear],
+* [^bgi::runtime::quadratic],
+* [^bgi::runtime::rstar].
+
+
+
[heading Translator]
-The Translator translates from Value to Indexable each time r-tree requires it. Which means that this operation is done for each Value access. Therefore the Translator should return the Indexable by const reference instead of a value. Default translator can translate all types adapted to Point or Box concepts (which are Indexables). It also handles std::pair<Indexable, T>, pointers, smart pointers, and iterators. E.g. If std::pair<Box, int> is stored, the default translator translates from std::pair<Box, int> const& to Box const&.
+The Translator translates from Value to Indexable each time r-tree requires it. Which means that this operation is done for each Value access. Therefore the Translator should return the Indexable by const reference instead of a value. Default translator can translate all types adapted to Point or Box concepts (called Indexables). It also handles [^std::pair<Indexable, T>] and [^boost::tuple<Indexable, ...>]. For example, if [^std::pair<Box, int>] is stored in the container, the default translator translates from [^std::pair<Box, int> const&] to [^Box const&].
[heading Header]
`#include <boost/geometry/extensions/index/rtree/rtree.hpp>`
@@ -94,14 +117,14 @@
[heading Synopsis]
``rtree(parameters_type parameters = parameters_type(), translator_type const & translator = translator_type())``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `parameters_type` ][ `parameters` ][The parameters object. ]]
[[ `translator_type const &` ][ `translator` ][The translator object.]]
]
[heading Throws]
-If allocator default constructor throws.
+If allocator default constructor throws.
[endsect]
@@ -113,7 +136,7 @@
translator_type const & translator,
allocator_type allocator)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `parameters_type` ][ `parameters` ][The parameters object. ]]
@@ -121,7 +144,7 @@
[[ `allocator_type` ][ `allocator` ][The allocator object.]]
]
[heading Throws]
-If allocator copy constructor throws.
+If allocator copy constructor throws.
[endsect]
@@ -136,7 +159,7 @@
translator_type const & translator = translator_type(),
allocator_type allocator = allocator_type())``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `Iterator` ][ `first` ][The beginning of the range of Values. ]]
@@ -146,7 +169,14 @@
[[ `allocator_type` ][ `allocator` ][The allocator object.]]
]
[heading Throws]
-If allocator copy constructor throws. If Value copy constructor or copy assignment throws. When nodes allocation fails.
+
+
+* If allocator copy constructor throws.
+* If Value copy constructor or copy assignment throws.
+* If allocation throws.
+* When memory allocation for Node fails.
+
+
[endsect]
@@ -160,7 +190,7 @@
translator_type const & translator = translator_type(),
allocator_type allocator = allocator_type())``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `Range const &` ][ `rng` ][The range of Values. ]]
@@ -169,7 +199,14 @@
[[ `allocator_type` ][ `allocator` ][The allocator object.]]
]
[heading Throws]
-If allocator copy constructor throws. If Value copy constructor or copy assignment throws. When nodes allocation fails.
+
+
+* If allocator copy constructor throws.
+* If Value copy constructor or copy assignment throws.
+* If allocation throws.
+* When memory allocation for Node fails.
+
+
[endsect]
@@ -180,7 +217,7 @@
``~rtree()``
[heading Throws]
-Nothing.
+Nothing.
[endsect]
@@ -191,13 +228,20 @@
It uses parameters, translator and allocator from the source tree.[heading Synopsis]
``rtree(rtree const & src)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree const &` ][ `src` ][The rtree which content will be copied.]]
]
[heading Throws]
-If allocator copy constructor throws. If Value copy constructor throws. When nodes allocation fails.
+
+
+* If allocator copy constructor throws.
+* If Value copy constructor throws.
+* If allocation throws.
+* When memory allocation for Node fails.
+
+
[endsect]
@@ -208,14 +252,21 @@
It uses Parameters and translator from the source tree.[heading Synopsis]
``rtree(rtree const & src, allocator_type const & allocator)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree const &` ][ `src` ][The rtree which content will be copied. ]]
[[ `allocator_type const &` ][ `allocator` ][The allocator which will be used.]]
]
[heading Throws]
-If allocator copy constructor throws. If Value copy constructor throws. When nodes allocation fails.
+
+
+* If allocator copy constructor throws.
+* If Value copy constructor throws.
+* If allocation throws.
+* When memory allocation for Node fails.
+
+
[endsect]
@@ -226,13 +277,13 @@
It uses parameters, translator and allocator from the source tree.[heading Synopsis]
``rtree(rtree && src)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree &&` ][ `src` ][The rtree which content will be moved.]]
]
[heading Throws]
-If allocator move constructor throws.
+If allocator move constructor throws.
[endsect]
@@ -243,13 +294,19 @@
It uses parameters and translator from the source tree.[heading Synopsis]
``rtree & operator=(const rtree & src)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `const rtree &` ][ `src` ][The rtree which content will be copied.]]
]
[heading Throws]
-If Value copy constructor throws. When nodes allocation fails.
+
+
+* If Value copy constructor throws.
+* If allocation throws.
+* When nodes allocation fails.
+
+
[endsect]
@@ -260,13 +317,19 @@
It uses parameters and translator from the source tree.[heading Synopsis]
``rtree & operator=(rtree && src)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree &&` ][ `src` ][The rtree which content will be moved.]]
]
[heading Throws]
-Only if allocators aren't equal. If Value copy constructor throws. When nodes allocation fails.
+Only if allocators aren't equal.
+
+* If Value copy constructor throws.
+* If allocation throws.
+* When nodes allocation fails.
+
+
[endsect]
@@ -277,13 +340,13 @@
Parameters, translator and allocators are swapped as well.[heading Synopsis]
``void swap(rtree & other)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree &` ][ `other` ][The rtree which content will be swapped with this rtree content.]]
]
[heading Throws]
-If allocators swap throws.
+If allocators swap throws.
[endsect]
@@ -293,15 +356,21 @@
[heading Synopsis]
``void insert(value_type const & value)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `value_type const &` ][ `value` ][The value which will be stored in the container.]]
]
[heading Throws]
-If Value copy constructor or copy assignment throws. When nodes allocation fails.
-[heading Exception-safety]
-This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.
+
+
+* If Value copy constructor or copy assignment throws.
+* If allocation throws.
+* When nodes allocation fails.
+
+
+
+[warning This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. ]
[endsect]
@@ -312,16 +381,22 @@
``template<typename Iterator>
void insert(Iterator first, Iterator last)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `Iterator` ][ `first` ][The beginning of the range of values. ]]
[[ `Iterator` ][ `last` ][The end of the range of values.]]
]
[heading Throws]
-If Value copy constructor or copy assignment throws. When nodes allocation fails.
-[heading Exception-safety]
-This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.
+
+
+* If Value copy constructor or copy assignment throws.
+* If allocation throws.
+* When nodes allocation fails.
+
+
+
+[warning This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. ]
[endsect]
@@ -332,15 +407,21 @@
``template<typename Range>
void insert(Range const & rng)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `Range const &` ][ `rng` ][The range of values.]]
]
[heading Throws]
-If Value copy constructor or copy assignment throws. When nodes allocation fails.
-[heading Exception-safety]
-This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.
+
+
+* If Value copy constructor or copy assignment throws.
+* If allocation throws.
+* When nodes allocation fails.
+
+
+
+[warning This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. ]
[endsect]
@@ -348,10 +429,10 @@
Remove a value from the container.
[heading Description]
-In contrast to the STL set/map erase() method this method removes only one value from the container.[heading Synopsis]
+In contrast to the [^std::set] or [^std::map][^erase()] method this method removes only one value from the container.[heading Synopsis]
``size_type remove(value_type const & value)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `value_type const &` ][ `value` ][The value which will be removed from the container.]]
@@ -359,9 +440,15 @@
[heading Returns]
1 if the value was removed, 0 otherwise.
[heading Throws]
-If Value copy constructor or copy assignment throws. When nodes allocation fails.
-[heading Exception-safety]
-This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.
+
+
+* If Value copy constructor or copy assignment throws.
+* If allocation throws.
+* When nodes allocation fails.
+
+
+
+[warning This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. ]
[endsect]
@@ -369,11 +456,11 @@
Remove a range of values from the container.
[heading Description]
-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.[heading Synopsis]
+In contrast to the [^std::set] or [^std::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.[heading Synopsis]
``template<typename Iterator>
size_type remove(Iterator first, Iterator last)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `Iterator` ][ `first` ][The beginning of the range of values. ]]
@@ -382,9 +469,15 @@
[heading Returns]
The number of removed values.
[heading Throws]
-If Value copy constructor or copy assignment throws. When nodes allocation fails.
-[heading Exception-safety]
-This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.
+
+
+* If Value copy constructor or copy assignment throws.
+* If allocation throws.
+* When nodes allocation fails.
+
+
+
+[warning This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. ]
[endsect]
@@ -392,11 +485,11 @@
Remove a range of values from the container.
[heading Description]
-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.[heading Synopsis]
+In contrast to the [^std::set] or [^std::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.[heading Synopsis]
``template<typename Range>
size_type remove(Range const & rng)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `Range const &` ][ `rng` ][The range of values.]]
@@ -404,9 +497,15 @@
[heading Returns]
The number of removed values.
[heading Throws]
-If Value copy constructor or copy assignment throws. When nodes allocation fails.
-[heading Exception-safety]
-This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.
+
+
+* If Value copy constructor or copy assignment throws.
+* If allocation throws.
+* When nodes allocation fails.
+
+
+
+[warning This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. ]
[endsect]
@@ -414,11 +513,28 @@
Finds values meeting spatial predicates, e.g. intersecting some Box.
[heading Description]
-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.[heading Synopsis]
+[*Spatial predicates] may be a [^Geometry]. In this case Values intersecting the [^Geometry] are returned.
+
+It may be generated by one of the functions listed below:
+
+* [^bgi::covered_by(geometry)],
+* [^bgi::disjoint(geometry)],
+* [^bgi::intersects(geometry)] - default,
+* [^bgi::overlaps(geometry)],
+* [^bgi::within(geometry)],
+* [^!bgi::covered_by(geometry)],
+* [^!bgi::disjoint(geometry)],
+* [^!bgi::intersects(geometry)],
+* [^!bgi::overlaps(geometry)],
+* [^!bgi::within(geometry)]
+* [^bgi::value(func)].
+
+
+Those predicates may be passed together in [^std::pair<]...> or [^boost::tuple<]...>.[heading Synopsis]
``template<typename Predicates, typename OutIter>
size_type spatial_query(Predicates const & pred, OutIter out_it)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `Predicates const &` ][ `pred` ][The spatial predicates or a Geometry. ]]
@@ -427,7 +543,12 @@
[heading Returns]
The number of values found.
[heading Throws]
-If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
+
+
+* If Value copy constructor or copy assignment throws.
+* If OutIter dereference or increment throws.
+
+
[endsect]
@@ -435,11 +556,34 @@
Finds one value meeting distances predicates, e.g. nearest to some Point.
[heading Description]
-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).[heading Synopsis]
+[*Distances predicates] may be a [^Point]. In this the case the Value closest to [^Point] is returned.
+
+It is possible to define how distance to Value is calculated. This is done by passing PointRelation. It can be generated by following functions:
+
+* bgi::to_nearest(Point) - default,
+* bgi::to_centroid(Point),
+* bgi::to_furthest(Point).
+
+
+It is possible to define define distances bounds, for example that some distance must be between min_distance and max_distance. This is done by passing DistancesPredicates which can be generated by following functions:
+
+* bgi::unbounded(PointRelation) - default,
+* bgi::min_bounded(PointRelation, MinRelation),
+* bgi::max_bounded(PointRelation, MaxRelation),
+* bgi::bounded(PointRelation, MinRelation, MaxRelation).
+
+
+MinRelation and MaxRelation describes bounds and can be generated by following functions:
+
+* bgi::to_nearest(some_distance),
+* bgi::to_centroid(some_distance),
+* bgi::to_furthest(some_distance).
+
+[heading Synopsis]
``template<typename DistancesPredicates>
size_type nearest_query(DistancesPredicates const & dpred, value_type & v)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `DistancesPredicates const &` ][ `dpred` ][The distances predicates or a Point.]]
@@ -448,7 +592,7 @@
[heading Returns]
The number of values found.
[heading Throws]
-If Value copy constructor or copy assignment throws.
+If Value copy constructor or copy assignment throws.
[endsect]
@@ -456,15 +600,53 @@
Finds one value meeting distances predicates and spatial predicates, e.g. nearest to some Point and intersecting some Box.
[heading Description]
-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).
+[*Distances predicates] may be a [^Point]. In this the case the Value closest to [^Point] is returned.
+
+It is possible to define how distance to Value is calculated. This is done by passing PointRelation. It can be generated by following functions:
+
+* bgi::to_nearest(Point) - default,
+* bgi::to_centroid(Point),
+* bgi::to_furthest(Point).
+
-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.[heading Synopsis]
+It is possible to define define distances bounds, for example that some distance must be between min_distance and max_distance. This is done by passing DistancesPredicates which can be generated by following functions:
+
+* bgi::unbounded(PointRelation) - default,
+* bgi::min_bounded(PointRelation, MinRelation),
+* bgi::max_bounded(PointRelation, MaxRelation),
+* bgi::bounded(PointRelation, MinRelation, MaxRelation).
+
+
+MinRelation and MaxRelation describes bounds and can be generated by following functions:
+
+* bgi::to_nearest(some_distance),
+* bgi::to_centroid(some_distance),
+* bgi::to_furthest(some_distance).
+
+[*Spatial predicates] may be a [^Geometry]. In this case Values intersecting the [^Geometry] are returned.
+
+It may be generated by one of the functions listed below:
+
+* [^bgi::covered_by(geometry)],
+* [^bgi::disjoint(geometry)],
+* [^bgi::intersects(geometry)] - default,
+* [^bgi::overlaps(geometry)],
+* [^bgi::within(geometry)],
+* [^!bgi::covered_by(geometry)],
+* [^!bgi::disjoint(geometry)],
+* [^!bgi::intersects(geometry)],
+* [^!bgi::overlaps(geometry)],
+* [^!bgi::within(geometry)]
+* [^bgi::value(func)].
+
+
+Those predicates may be passed together in [^std::pair<]...> or [^boost::tuple<]...>.[heading Synopsis]
``template<typename DistancesPredicates, typename Predicates>
size_type nearest_query(DistancesPredicates const & dpred,
Predicates const & pred,
value_type & v)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `DistancesPredicates const &` ][ `dpred` ][The distances predicates or a Point. ]]
@@ -474,7 +656,7 @@
[heading Returns]
The number of values found.
[heading Throws]
-If Value copy constructor or copy assignment throws.
+If Value copy constructor or copy assignment throws.
[endsect]
@@ -482,13 +664,36 @@
Finds k values meeting distances predicates, e.g. k nearest values to some Point.
[heading Description]
-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).[heading Synopsis]
+[*Distances predicates] may be a [^Point]. In this the case the Value closest to [^Point] is returned.
+
+It is possible to define how distance to Value is calculated. This is done by passing PointRelation. It can be generated by following functions:
+
+* bgi::to_nearest(Point) - default,
+* bgi::to_centroid(Point),
+* bgi::to_furthest(Point).
+
+
+It is possible to define define distances bounds, for example that some distance must be between min_distance and max_distance. This is done by passing DistancesPredicates which can be generated by following functions:
+
+* bgi::unbounded(PointRelation) - default,
+* bgi::min_bounded(PointRelation, MinRelation),
+* bgi::max_bounded(PointRelation, MaxRelation),
+* bgi::bounded(PointRelation, MinRelation, MaxRelation).
+
+
+MinRelation and MaxRelation describes bounds and can be generated by following functions:
+
+* bgi::to_nearest(some_distance),
+* bgi::to_centroid(some_distance),
+* bgi::to_furthest(some_distance).
+
+[heading Synopsis]
``template<typename DistancesPredicates, typename OutIter>
size_type nearest_query(DistancesPredicates const & dpred,
size_t k,
OutIter out_it)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `DistancesPredicates const &` ][ `dpred` ][The distances predicates or a Point. ]]
@@ -498,7 +703,7 @@
[heading Returns]
The number of values found.
[heading Throws]
-If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
+If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
[endsect]
@@ -506,9 +711,47 @@
Finds k values meeting distances predicates and spatial predicates, e.g. k nearest values to some Point and intersecting some Box.
[heading Description]
-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).
+[*Distances predicates] may be a [^Point]. In this the case the Value closest to [^Point] is returned.
+
+It is possible to define how distance to Value is calculated. This is done by passing PointRelation. It can be generated by following functions:
+
+* bgi::to_nearest(Point) - default,
+* bgi::to_centroid(Point),
+* bgi::to_furthest(Point).
+
+
+It is possible to define define distances bounds, for example that some distance must be between min_distance and max_distance. This is done by passing DistancesPredicates which can be generated by following functions:
+
+* bgi::unbounded(PointRelation) - default,
+* bgi::min_bounded(PointRelation, MinRelation),
+* bgi::max_bounded(PointRelation, MaxRelation),
+* bgi::bounded(PointRelation, MinRelation, MaxRelation).
+
-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.[heading Synopsis]
+MinRelation and MaxRelation describes bounds and can be generated by following functions:
+
+* bgi::to_nearest(some_distance),
+* bgi::to_centroid(some_distance),
+* bgi::to_furthest(some_distance).
+
+[*Spatial predicates] may be a [^Geometry]. In this case Values intersecting the [^Geometry] are returned.
+
+It may be generated by one of the functions listed below:
+
+* [^bgi::covered_by(geometry)],
+* [^bgi::disjoint(geometry)],
+* [^bgi::intersects(geometry)] - default,
+* [^bgi::overlaps(geometry)],
+* [^bgi::within(geometry)],
+* [^!bgi::covered_by(geometry)],
+* [^!bgi::disjoint(geometry)],
+* [^!bgi::intersects(geometry)],
+* [^!bgi::overlaps(geometry)],
+* [^!bgi::within(geometry)]
+* [^bgi::value(func)].
+
+
+Those predicates may be passed together in [^std::pair<]...> or [^boost::tuple<]...>.[heading Synopsis]
``template<typename DistancesPredicates,
typename Predicates,
typename OutIter>
@@ -517,7 +760,7 @@
Predicates const & pred,
OutIter out_it)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `DistancesPredicates const &` ][ `dpred` ][The distances predicates or a Point ]]
@@ -528,7 +771,7 @@
[heading Returns]
The number of values found.
[heading Throws]
-If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
+If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
[endsect]
@@ -541,7 +784,7 @@
[heading Returns]
The number of stored values.
[heading Throws]
-Nothing.
+Nothing.
[endsect]
@@ -554,7 +797,7 @@
[heading Returns]
true if the container is empty.
[heading Throws]
-Nothing.
+Nothing.
[endsect]
@@ -565,7 +808,7 @@
``void clear()``
[heading Throws]
-Nothing.
+Nothing.
[endsect]
@@ -573,13 +816,13 @@
Returns the box containing all values stored in the container.
[heading Description]
-Returns the box containing all values stored in the container. If the container is empty the result of geometry::assign_inverse() is returned.[heading Synopsis]
+Returns the box containing all values stored in the container. If the container is empty the result of [^geometry::assign_inverse()] is returned.[heading Synopsis]
``box_type box()``
[heading Returns]
The box containing all values stored in the container or an invalid box if there are no values in the container.
[heading Throws]
-Nothing.
+Nothing.
[endsect]
@@ -591,7 +834,7 @@
``template<typename ValueOrIndexable>
size_type count(ValueOrIndexable const & vori)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `ValueOrIndexable const &` ][ `vori` ][The value or indexable which will be counted.]]
@@ -599,7 +842,7 @@
[heading Returns]
The number of values found.
[heading Throws]
-Nothing.
+Nothing.
[endsect]
@@ -612,7 +855,7 @@
[heading Returns]
The parameters object.
[heading Throws]
-Nothing.
+Nothing.
[endsect]
@@ -625,7 +868,7 @@
[heading Returns]
The translator object.
[heading Throws]
-Nothing.
+Nothing.
[endsect]
@@ -638,7 +881,7 @@
[heading Returns]
The allocator.
[heading Throws]
-If allocator copy constructor throws.
+If allocator copy constructor throws.
[endsect]
Modified: sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -30,7 +30,7 @@
typename Allocator>
void boost::geometry::index::insert(rtree< Value, Options, Translator, Allocator > & tree, Value const & v)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree< Value, Options, Translator, Allocator > &` ][ `tree` ][The spatial index. ]]
@@ -51,7 +51,7 @@
Iterator first,
Iterator last)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree< Value, Options, Translator, Allocator > &` ][ `tree` ][The spatial index. ]]
@@ -71,7 +71,7 @@
typename Range>
void boost::geometry::index::insert(rtree< Value, Options, Translator, Allocator > & tree, Range const & rng)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree< Value, Options, Translator, Allocator > &` ][ `tree` ][The spatial index. ]]
@@ -83,14 +83,14 @@
Remove a value from the container.
[heading Description]
-Remove a value from the container. In contrast to the STL set/map erase() method this function removes only one value from the container.[heading Synopsis]
+Remove a value from the container. In contrast to the [^std::set] or [^std::map][^erase()] method this function removes only one value from the container.[heading Synopsis]
``template<typename Value,
typename Options,
typename Translator,
typename Allocator>
rtree<Value, Options, Translator, Allocator>::size_type boost::geometry::index::remove(rtree< Value, Options, Translator, Allocator > & tree, Value const & v)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree< Value, Options, Translator, Allocator > &` ][ `tree` ][The spatial index. ]]
@@ -104,7 +104,7 @@
Remove a range of values from the container.
[heading Description]
-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.[heading Synopsis]
+Remove a range of values from the container. In contrast to the [^std::set] or [^std::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.[heading Synopsis]
``template<typename Value,
typename Options,
typename Translator,
@@ -114,7 +114,7 @@
Iterator first,
Iterator last)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree< Value, Options, Translator, Allocator > &` ][ `tree` ][The spatial index. ]]
@@ -129,7 +129,7 @@
Remove a range of values from the container.
[heading Description]
-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.[heading Synopsis]
+Remove a range of values from the container. In contrast to the [^std::set] or [^std::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.[heading Synopsis]
``template<typename Value,
typename Options,
typename Translator,
@@ -137,7 +137,7 @@
typename Range>
rtree<Value, Options, Translator, Allocator>::size_type boost::geometry::index::remove(rtree< Value, Options, Translator, Allocator > & tree, Range const & rng)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree< Value, Options, Translator, Allocator > &` ][ `tree` ][The spatial index. ]]
@@ -161,7 +161,7 @@
Predicates const & pred,
OutIter out_it)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index. ]]
@@ -185,7 +185,7 @@
DistancesPredicates const & dpred,
Value & v)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index. ]]
@@ -211,7 +211,7 @@
Predicates const & pred,
Value & v)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index. ]]
@@ -238,7 +238,7 @@
size_t k,
OutIter out_it)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index. ]]
@@ -267,7 +267,7 @@
Predicates const & pred,
OutIter out_it)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index. ]]
@@ -290,7 +290,7 @@
typename Allocator>
void boost::geometry::index::clear(rtree< Value, Options, Translator, Allocator > & tree)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree< Value, Options, Translator, Allocator > &` ][ `tree` ][The spatial index. ]]
@@ -307,7 +307,7 @@
typename Allocator>
size_t boost::geometry::index::size(rtree< Value, Options, Translator, Allocator > const & tree)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index.]]
@@ -326,7 +326,7 @@
typename Allocator>
bool boost::geometry::index::empty(rtree< Value, Options, Translator, Allocator > const & tree)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index.]]
@@ -345,7 +345,7 @@
typename Allocator>
rtree<Value, Options, Translator, Allocator>::box_type boost::geometry::index::box(rtree< Value, Options, Translator, Allocator > const & tree)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index.]]
Modified: sandbox-branches/geometry/index/doc/generated/translator_index.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/translator_index.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/translator_index.qbk 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -37,7 +37,7 @@
[heading Synopsis]
``index(Container const & c)``
-[heading Parameters]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[ `Container const &` ][ `c` ][The container which stores indexed values. ]]
Modified: sandbox-branches/geometry/index/doc/html/geometry_index/introduction.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/geometry_index/introduction.html (original)
+++ sandbox-branches/geometry/index/doc/html/geometry_index/introduction.html 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Introduction</title>
<link rel="stylesheet" href="http://www.boost.org/doc/libs/release/doc/src/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../index.html" title="Chapter 1. Geometry Index">
<link rel="up" href="../index.html" title="Chapter 1. Geometry Index">
<link rel="prev" href="../index.html" title="Chapter 1. Geometry Index">
Modified: sandbox-branches/geometry/index/doc/html/geometry_index/r_tree.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/geometry_index/r_tree.html (original)
+++ sandbox-branches/geometry/index/doc/html/geometry_index/r_tree.html 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>R-tree</title>
<link rel="stylesheet" href="http://www.boost.org/doc/libs/release/doc/src/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../index.html" title="Chapter 1. Geometry Index">
<link rel="up" href="../index.html" title="Chapter 1. Geometry Index">
<link rel="prev" href="introduction.html" title="Introduction">
Modified: sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/creation_and_modification.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/creation_and_modification.html (original)
+++ sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/creation_and_modification.html 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Creation and modification</title>
<link rel="stylesheet" href="http://www.boost.org/doc/libs/release/doc/src/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../../index.html" title="Chapter 1. Geometry Index">
<link rel="up" href="../r_tree.html" title="R-tree">
<link rel="prev" href="rtree_quickstart.html" title="Quick Start">
@@ -55,7 +55,7 @@
</p>
<pre class="programlisting"><span class="identifier">rtree</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Parameters</span><span class="special">,</span> <span class="identifier">Translator</span> <span class="special">=</span> <span class="identifier">translator</span><span class="special">::</span><span class="identifier">def</span><span class="special"><</span><span class="identifier">Value</span><span class="special">>,</span> <span class="identifier">Allocator</span><span class="special">></span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">allocator</span><span class="special"><</span><span class="identifier">Value</span><span class="special">></span> <span class="special">></span>
</pre>
-<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<code class="computeroutput">Value</code> - type of object which will be stored in the container,
</li>
@@ -90,7 +90,7 @@
be handled by the default <code class="computeroutput">Translator</code> - <code class="computeroutput"><span class="identifier">index</span><span class="special">::</span><span class="identifier">translator</span><span class="special">::</span><span class="identifier">def</span><span class="special"><</span>Value<span class="special">></span></code>
are defined as follows:
</p>
-<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<code class="computeroutput">Indexable <span class="special">=</span> Point
<span class="special">|</span> Box</code>
@@ -116,7 +116,7 @@
A <code class="computeroutput">Translator</code> is a type which knows how to handle <code class="computeroutput">Value</code>s.
It has two purposes:
</p>
-<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
it translates <code class="computeroutput">Value</code> to a more suitable <code class="computeroutput">Indexable</code>
type which is needed by most of operations,
@@ -134,7 +134,7 @@
<p>
If comparison of two <code class="computeroutput">Value</code>s is required, the default translator:
</p>
-<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
for <code class="computeroutput">Point</code>
and <code class="computeroutput">Box</code>
Modified: sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/introduction.html
Modified: sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/nearest_neighbours_queries.html
Modified: sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html
Modified: sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/rtree_quickstart.html
Modified: sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/spatial_queries.html
Modified: sandbox-branches/geometry/index/doc/html/index.html
Modified: sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/doxygen_elements.hpp
Modified: sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/doxygen_xml_parser.hpp
Modified: sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp
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
==============================================================================
--- sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/introduction.html (original)
+++ sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/introduction.html 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Introduction</title>
<link rel="stylesheet" href="http://www.boost.org/doc/libs/release/doc/src/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../../index.html" title="Chapter 1. Geometry Index">
<link rel="up" href="../r_tree.html" title="R-tree">
<link rel="prev" href="../r_tree.html" title="R-tree">
@@ -28,10 +28,10 @@
</h3></div></div></div>
<p>
R-tree is a tree data structure used for spatial searching. It was proposed
- by Antonin Guttman in 1984 [1]</sup></a> as an expansion of B-tree for multi-dimensional data. It may
+ by Antonin Guttman in 1984 <sup>[<a name="geometry_index.r_tree.introduction.f0" href="#ftn.geometry_index.r_tree.introduction.f0" class="footnote">1</a>]</sup> as an expansion of B-tree for multi-dimensional data. It may
be used to store points or volumetric data in order to perform a spatial
query later. This query may return objects that are inside some area or are
- close to some point in space [2]</sup></a>.
+ close to some point in space <sup>[<a name="geometry_index.r_tree.introduction.f1" href="#ftn.geometry_index.r_tree.introduction.f1" class="footnote">2</a>]</sup>.
</p>
<p>
The R-tree structure is presented on the image below. Each R-tree's node
@@ -51,7 +51,7 @@
</p>
<p>
The R-tree is a self-balanced data structure. The key part of balancing algorithm
- is node splitting algorithm [3]</sup></a> [4]</sup></a>. Each algorithm produces different splits so the internal structure
+ is node splitting algorithm <sup>[<a name="geometry_index.r_tree.introduction.f2" href="#ftn.geometry_index.r_tree.introduction.f2" class="footnote">3</a>]</sup> <sup>[<a name="geometry_index.r_tree.introduction.f3" href="#ftn.geometry_index.r_tree.introduction.f3" class="footnote">4</a>]</sup>. Each algorithm produces different splits so the internal structure
of a tree may be different for each one of them. In general more complex
algorithms analyses elements better and produces less overlapping nodes.
In the searching process less nodes must be traversed in order to find desired
@@ -180,7 +180,7 @@
<p>
Key features of this implementation of the R-tree are:
</p>
-<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
capable to store arbitrary Value type,
</li>
@@ -201,20 +201,20 @@
</li>
</ul></div>
<div class="footnotes">
-<br><hr style="width:100; align:left;">
-<div id="ftn.geometry_index.r_tree.introduction.f0" class="footnote"><p>[1]
+<br><hr width="100" align="left">
+<div class="footnote"><p><sup>[<a id="ftn.geometry_index.r_tree.introduction.f0" href="#geometry_index.r_tree.introduction.f0" class="para">1</a>] </sup>
Guttman, A. (1984). <span class="emphasis"><em>R-Trees: A Dynamic Index Structure for Spatial
Searching</em></span>
</p></div>
-<div id="ftn.geometry_index.r_tree.introduction.f1" class="footnote"><p>[2]
+<div class="footnote"><p><sup>[<a id="ftn.geometry_index.r_tree.introduction.f1" href="#geometry_index.r_tree.introduction.f1" class="para">2</a>] </sup>
Cheung, K.; Fu, A. (1998). <span class="emphasis"><em>Enhanced Nearest Neighbour Search
on the R-tree</em></span>
</p></div>
-<div id="ftn.geometry_index.r_tree.introduction.f2" class="footnote"><p>[3]
+<div class="footnote"><p><sup>[<a id="ftn.geometry_index.r_tree.introduction.f2" href="#geometry_index.r_tree.introduction.f2" class="para">3</a>] </sup>
Greene, D. (1989). <span class="emphasis"><em>An implementation and performance analysis
of spatial data access methods</em></span>
</p></div>
-<div id="ftn.geometry_index.r_tree.introduction.f3" class="footnote"><p>[4]
+<div class="footnote"><p><sup>[<a id="ftn.geometry_index.r_tree.introduction.f3" href="#geometry_index.r_tree.introduction.f3" class="para">4</a>] </sup>
Beckmann, N.; Kriegel, H. P.; Schneider, R.; Seeger, B. (1990). <span class="emphasis"><em>The
R*-tree: an efficient and robust access method for points and rectangles</em></span>
</p></div>
==============================================================================
--- sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/nearest_neighbours_queries.html (original)
+++ sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/nearest_neighbours_queries.html 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Nearest neighbours queries</title>
<link rel="stylesheet" href="http://www.boost.org/doc/libs/release/doc/src/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../../index.html" title="Chapter 1. Geometry Index">
<link rel="up" href="../r_tree.html" title="R-tree">
<link rel="prev" href="spatial_queries.html" title="Spatial queries">
==============================================================================
--- sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html (original)
+++ sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Reference</title>
<link rel="stylesheet" href="http://www.boost.org/doc/libs/release/doc/src/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../../index.html" title="Chapter 1. Geometry Index">
<link rel="up" href="../r_tree.html" title="R-tree">
<link rel="prev" href="nearest_neighbours_queries.html" title="Nearest neighbours queries">
@@ -45,12 +45,12 @@
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree" title="boost::geometry::index::rtree">boost::geometry::index::rtree</a>
</h4></div></div></div>
<p>
- <a class="indexterm" name="id899495"></a><a class="indexterm" name="id899500"></a><a class="indexterm" name="id899504"></a><a class="indexterm" name="id899509"></a>
+ <a class="indexterm" name="idp9685736"></a><a class="indexterm" name="idp9686048"></a><a class="indexterm" name="idp9686360"></a><a class="indexterm" name="idp9686672"></a>
The R-tree spatial index.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.description">Description</a>
</h6>
<p>
The R-tree spatial index. This is self-balancing spatial index capable
@@ -58,42 +58,67 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters">Parameters</a>
</h6>
<p>
The user must pass a type defining the Parameters which will be used in
rtree creation process. This type is used e.g. to specify balancing algorithm
- with specific parameters like min and max number of elements in node. Predefined
- algorithms with compile-time parameters are: bgi::linear<MinElements,
- MaxElements>, bgi::quadratic<MinElements, MaxElements>, bgi::rstar<MinElements,
- MaxElements, OverlapCostThreshold = 0, ReinsertedElements = MaxElements
- * 0.3>. Predefined algorithms with run-time parameters are: bgi::runtime::linear,
- bgi::runtime::quadratic, bgi::runtime::rstar.
+ with specific parameters like min and max number of elements in node.
</p>
+<p>
+ Predefined algorithms with compile-time parameters are:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <code class="literal">bgi::linear<MinElements, MaxElements></code>,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::quadratic<MinElements, MaxElements></code>,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::rstar<MinElements, MaxElements, OverlapCostThreshold
+ = 0, ReinsertedElements = MaxElements * 0.3></code>.
+ </li>
+</ul></div>
+<p>
+ Predefined algorithms with run-time parameters are:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <code class="literal">bgi::runtime::linear</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::runtime::quadratic</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::runtime::rstar</code>.
+ </li>
+</ul></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.translator">Translator</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.translator">Translator</a>
</h6>
<p>
The Translator translates from Value to Indexable each time r-tree requires
it. Which means that this operation is done for each Value access. Therefore
the Translator should return the Indexable by const reference instead of
a value. Default translator can translate all types adapted to Point or
- Box concepts (which are Indexables). It also handles std::pair<Indexable,
- T>, pointers, smart pointers, and iterators. E.g. If std::pair<Box,
- int> is stored, the default translator translates from std::pair<Box,
- int> const& to Box const&.
+ Box concepts (called Indexables). It also handles <code class="literal">std::pair<Indexable,
+ T></code> and <code class="literal">boost::tuple<Indexable, ...></code>.
+ For example, if <code class="literal">std::pair<Box, int></code> is stored
+ in the container, the default translator translates from <code class="literal">std::pair<Box,
+ int> const&</code> to <code class="literal">Box const&</code>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.header">Header</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.header">Header</a>
</h6>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">extensions</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">rtree</span><span class="special">/</span><span class="identifier">rtree</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h4"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -110,7 +135,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h5"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.template_parameter_s_">Template
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -184,7 +209,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h6"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.typedef_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.typedef_s_">Typedef(s)</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.typedef_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.typedef_s_">Typedef(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -292,7 +317,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h7"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.constructor_s__and_destructor"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.constructor_s__and_destructor">Constructor(s)
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.constructor_s__and_destructor"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.constructor_s__and_destructor">Constructor(s)
and destructor</a>
</h6>
<div class="informaltable"><table class="table">
@@ -420,7 +445,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h8"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member_s_">Member(s)</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member_s_">Member(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -738,7 +763,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -747,7 +772,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -811,7 +836,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.throws">Throws</a>
</h6>
<p>
If allocator default constructor throws.
@@ -827,7 +852,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -838,7 +863,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -919,7 +944,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.throws">Throws</a>
</h6>
<p>
If allocator copy constructor throws.
@@ -935,7 +960,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -949,7 +974,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -1064,12 +1089,22 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.throws">Throws</a>
</h6>
-<p>
- If allocator copy constructor throws. If Value copy constructor or copy
- assignment throws. When nodes allocation fails.
- </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ If allocator copy constructor throws.
+ </li>
+<li class="listitem">
+ If Value copy constructor or copy assignment throws.
+ </li>
+<li class="listitem">
+ If allocation throws.
+ </li>
+<li class="listitem">
+ When memory allocation for Node fails.
+ </li>
+</ul></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
@@ -1081,7 +1116,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -1094,7 +1129,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -1193,12 +1228,22 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.throws">Throws</a>
</h6>
-<p>
- If allocator copy constructor throws. If Value copy constructor or copy
- assignment throws. When nodes allocation fails.
- </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ If allocator copy constructor throws.
+ </li>
+<li class="listitem">
+ If Value copy constructor or copy assignment throws.
+ </li>
+<li class="listitem">
+ If allocation throws.
+ </li>
+<li class="listitem">
+ When memory allocation for Node fails.
+ </li>
+</ul></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
@@ -1209,7 +1254,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -1218,7 +1263,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.throws">Throws</a>
</h6>
<p>
Nothing.
@@ -1234,14 +1279,14 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.description">Description</a>
</h6>
<p>
It uses parameters, translator and allocator from the source tree.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -1250,7 +1295,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -1296,12 +1341,22 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.throws">Throws</a>
</h6>
-<p>
- If allocator copy constructor throws. If Value copy constructor throws.
- When nodes allocation fails.
- </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ If allocator copy constructor throws.
+ </li>
+<li class="listitem">
+ If Value copy constructor throws.
+ </li>
+<li class="listitem">
+ If allocation throws.
+ </li>
+<li class="listitem">
+ When memory allocation for Node fails.
+ </li>
+</ul></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
@@ -1313,14 +1368,14 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.description">Description</a>
</h6>
<p>
It uses Parameters and translator from the source tree.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -1329,7 +1384,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -1394,12 +1449,22 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.throws">Throws</a>
</h6>
-<p>
- If allocator copy constructor throws. If Value copy constructor throws.
- When nodes allocation fails.
- </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ If allocator copy constructor throws.
+ </li>
+<li class="listitem">
+ If Value copy constructor throws.
+ </li>
+<li class="listitem">
+ If allocation throws.
+ </li>
+<li class="listitem">
+ When memory allocation for Node fails.
+ </li>
+</ul></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
@@ -1411,14 +1476,14 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.description">Description</a>
</h6>
<p>
It uses parameters, translator and allocator from the source tree.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -1427,7 +1492,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -1472,7 +1537,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.throws">Throws</a>
</h6>
<p>
If allocator move constructor throws.
@@ -1488,14 +1553,14 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.description">Description</a>
</h6>
<p>
It uses parameters and translator from the source tree.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -1504,7 +1569,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -1550,11 +1615,19 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.throws">Throws</a>
</h6>
-<p>
- If Value copy constructor throws. When nodes allocation fails.
- </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ If Value copy constructor throws.
+ </li>
+<li class="listitem">
+ If allocation throws.
+ </li>
+<li class="listitem">
+ When nodes allocation fails.
+ </li>
+</ul></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
@@ -1566,14 +1639,14 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.description">Description</a>
</h6>
<p>
It uses parameters and translator from the source tree.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -1582,7 +1655,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -1627,12 +1700,22 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.throws">Throws</a>
</h6>
<p>
- Only if allocators aren't equal. If Value copy constructor throws. When
- nodes allocation fails.
+ Only if allocators aren't equal.
</p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ If Value copy constructor throws.
+ </li>
+<li class="listitem">
+ If allocation throws.
+ </li>
+<li class="listitem">
+ When nodes allocation fails.
+ </li>
+</ul></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
@@ -1644,14 +1727,14 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.description">Description</a>
</h6>
<p>
Parameters, translator and allocators are swapped as well.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -1660,7 +1743,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -1705,7 +1788,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.throws">Throws</a>
</h6>
<p>
If allocators swap throws.
@@ -1721,7 +1804,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -1730,7 +1813,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -1775,21 +1858,30 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.throws">Throws</a>
- </h6>
-<p>
- If Value copy constructor or copy assignment throws. When nodes allocation
- fails.
- </p>
-<h6>
-<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.exception_safety"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.exception_safety">Exception-safety</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.throws">Throws</a>
</h6>
-<p>
- This operation is not thread safe. If it throws, the R-tree may be left
- in an inconsistent state, elements must not be inserted or removed, methods
- may return invalid data.
- </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ If Value copy constructor or copy assignment throws.
+ </li>
+<li class="listitem">
+ If allocation throws.
+ </li>
+<li class="listitem">
+ When nodes allocation fails.
+ </li>
+</ul></div>
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top"><p>
+ This operation is not thread safe. If it throws, the R-tree may be
+ left in an inconsistent state, elements must not be inserted or removed,
+ methods may return invalid data.
+ </p></td></tr>
+</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
@@ -1801,7 +1893,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -1811,7 +1903,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -1875,21 +1967,30 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.throws">Throws</a>
</h6>
-<p>
- If Value copy constructor or copy assignment throws. When nodes allocation
- fails.
- </p>
-<h6>
-<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.exception_safety"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.exception_safety">Exception-safety</a>
- </h6>
-<p>
- This operation is not thread safe. If it throws, the R-tree may be left
- in an inconsistent state, elements must not be inserted or removed, methods
- may return invalid data.
- </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ If Value copy constructor or copy assignment throws.
+ </li>
+<li class="listitem">
+ If allocation throws.
+ </li>
+<li class="listitem">
+ When nodes allocation fails.
+ </li>
+</ul></div>
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top"><p>
+ This operation is not thread safe. If it throws, the R-tree may be
+ left in an inconsistent state, elements must not be inserted or removed,
+ methods may return invalid data.
+ </p></td></tr>
+</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
@@ -1901,7 +2002,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -1911,7 +2012,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -1957,21 +2058,30 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.throws">Throws</a>
- </h6>
-<p>
- If Value copy constructor or copy assignment throws. When nodes allocation
- fails.
- </p>
-<h6>
-<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.exception_safety"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.exception_safety">Exception-safety</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.throws">Throws</a>
</h6>
-<p>
- This operation is not thread safe. If it throws, the R-tree may be left
- in an inconsistent state, elements must not be inserted or removed, methods
- may return invalid data.
- </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ If Value copy constructor or copy assignment throws.
+ </li>
+<li class="listitem">
+ If allocation throws.
+ </li>
+<li class="listitem">
+ When nodes allocation fails.
+ </li>
+</ul></div>
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top"><p>
+ This operation is not thread safe. If it throws, the R-tree may be
+ left in an inconsistent state, elements must not be inserted or removed,
+ methods may return invalid data.
+ </p></td></tr>
+</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
@@ -1983,15 +2093,15 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.description">Description</a>
</h6>
<p>
- In contrast to the STL set/map erase() method this method removes only
- one value from the container.
+ In contrast to the <code class="literal">std::set</code> or <code class="literal">std::map</code><code class="literal">erase()</code>
+ method this method removes only one value from the container.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -2000,7 +2110,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -2045,28 +2155,37 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.returns">Returns</a>
</h6>
<p>
1 if the value was removed, 0 otherwise.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.h4"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.throws">Throws</a>
- </h6>
-<p>
- If Value copy constructor or copy assignment throws. When nodes allocation
- fails.
- </p>
-<h6>
-<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.h5"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.exception_safety"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.exception_safety">Exception-safety</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.throws">Throws</a>
</h6>
-<p>
- This operation is not thread safe. If it throws, the R-tree may be left
- in an inconsistent state, elements must not be inserted or removed, methods
- may return invalid data.
- </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ If Value copy constructor or copy assignment throws.
+ </li>
+<li class="listitem">
+ If allocation throws.
+ </li>
+<li class="listitem">
+ When nodes allocation fails.
+ </li>
+</ul></div>
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top"><p>
+ This operation is not thread safe. If it throws, the R-tree may be
+ left in an inconsistent state, elements must not be inserted or removed,
+ methods may return invalid data.
+ </p></td></tr>
+</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
@@ -2078,17 +2197,18 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.description">Description</a>
</h6>
<p>
- 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.
+ In contrast to the <code class="literal">std::set</code> or <code class="literal">std::map</code><code class="literal">erase()</code>
+ 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.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -2098,7 +2218,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -2162,28 +2282,37 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.returns">Returns</a>
</h6>
<p>
The number of removed values.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.h4"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.throws">Throws</a>
</h6>
-<p>
- If Value copy constructor or copy assignment throws. When nodes allocation
- fails.
- </p>
-<h6>
-<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.h5"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.exception_safety"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.exception_safety">Exception-safety</a>
- </h6>
-<p>
- This operation is not thread safe. If it throws, the R-tree may be left
- in an inconsistent state, elements must not be inserted or removed, methods
- may return invalid data.
- </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ If Value copy constructor or copy assignment throws.
+ </li>
+<li class="listitem">
+ If allocation throws.
+ </li>
+<li class="listitem">
+ When nodes allocation fails.
+ </li>
+</ul></div>
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top"><p>
+ This operation is not thread safe. If it throws, the R-tree may be
+ left in an inconsistent state, elements must not be inserted or removed,
+ methods may return invalid data.
+ </p></td></tr>
+</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
@@ -2195,16 +2324,17 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.description">Description</a>
</h6>
<p>
- 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.
+ In contrast to the <code class="literal">std::set</code> or <code class="literal">std::map</code><code class="literal">erase()</code>
+ 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.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -2214,7 +2344,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -2260,28 +2390,37 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.returns">Returns</a>
</h6>
<p>
The number of removed values.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.h4"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.throws">Throws</a>
</h6>
-<p>
- If Value copy constructor or copy assignment throws. When nodes allocation
- fails.
- </p>
-<h6>
-<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.h5"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.exception_safety"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.exception_safety">Exception-safety</a>
- </h6>
-<p>
- This operation is not thread safe. If it throws, the R-tree may be left
- in an inconsistent state, elements must not be inserted or removed, methods
- may return invalid data.
- </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ If Value copy constructor or copy assignment throws.
+ </li>
+<li class="listitem">
+ If allocation throws.
+ </li>
+<li class="listitem">
+ When nodes allocation fails.
+ </li>
+</ul></div>
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top"><p>
+ This operation is not thread safe. If it throws, the R-tree may be
+ left in an inconsistent state, elements must not be inserted or removed,
+ methods may return invalid data.
+ </p></td></tr>
+</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
@@ -2293,19 +2432,58 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.description">Description</a>
</h6>
<p>
- 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.
+ <span class="bold"><strong>Spatial predicates</strong></span> may be a <code class="literal">Geometry</code>.
+ In this case Values intersecting the <code class="literal">Geometry</code> are
+ returned.
+ </p>
+<p>
+ It may be generated by one of the functions listed below:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <code class="literal">bgi::covered_by(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::disjoint(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::intersects(geometry)</code> - default,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::overlaps(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::within(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">!bgi::covered_by(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">!bgi::disjoint(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">!bgi::intersects(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">!bgi::overlaps(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">!bgi::within(geometry)</code>
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::value(func)</code>.
+ </li>
+</ul></div>
+<p>
+ Those predicates may be passed together in <code class="literal">std::pair<</code>...>
+ or <code class="literal">boost::tuple<</code>...>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -2315,7 +2493,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -2380,19 +2558,23 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.returns">Returns</a>
</h6>
<p>
The number of values found.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.h4"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.throws">Throws</a>
</h6>
-<p>
- If Value copy constructor or copy assignment throws. If OutIter dereference
- or increment throws.
- </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ If Value copy constructor or copy assignment throws.
+ </li>
+<li class="listitem">
+ If OutIter dereference or increment throws.
+ </li>
+</ul></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
@@ -2404,24 +2586,64 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.description">Description</a>
</h6>
<p>
- 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="bold"><strong>Distances predicates</strong></span> may be a <code class="literal">Point</code>.
+ In this the case the Value closest to <code class="literal">Point</code> is returned.
</p>
+<p>
+ It is possible to define how distance to Value is calculated. This is
+ done by passing PointRelation. It can be generated by following functions:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ bgi::to_nearest(Point) - default,
+ </li>
+<li class="listitem">
+ bgi::to_centroid(Point),
+ </li>
+<li class="listitem">
+ bgi::to_furthest(Point).
+ </li>
+</ul></div>
+<p>
+ It is possible to define define distances bounds, for example that some
+ distance must be between min_distance and max_distance. This is done
+ by passing DistancesPredicates which can be generated by following functions:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ bgi::unbounded(PointRelation) - default,
+ </li>
+<li class="listitem">
+ bgi::min_bounded(PointRelation, MinRelation),
+ </li>
+<li class="listitem">
+ bgi::max_bounded(PointRelation, MaxRelation),
+ </li>
+<li class="listitem">
+ bgi::bounded(PointRelation, MinRelation, MaxRelation).
+ </li>
+</ul></div>
+<p>
+ MinRelation and MaxRelation describes bounds and can be generated by
+ following functions:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ bgi::to_nearest(some_distance),
+ </li>
+<li class="listitem">
+ bgi::to_centroid(some_distance),
+ </li>
+<li class="listitem">
+ bgi::to_furthest(some_distance).
+ </li>
+</ul></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -2431,7 +2653,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -2496,14 +2718,14 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.returns">Returns</a>
</h6>
<p>
The number of values found.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.h4"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws.
@@ -2520,32 +2742,111 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.description">Description</a>
</h6>
<p>
- 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).
- </p>
-<p>
- 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.
+ <span class="bold"><strong>Distances predicates</strong></span> may be a <code class="literal">Point</code>.
+ In this the case the Value closest to <code class="literal">Point</code> is returned.
+ </p>
+<p>
+ It is possible to define how distance to Value is calculated. This is
+ done by passing PointRelation. It can be generated by following functions:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ bgi::to_nearest(Point) - default,
+ </li>
+<li class="listitem">
+ bgi::to_centroid(Point),
+ </li>
+<li class="listitem">
+ bgi::to_furthest(Point).
+ </li>
+</ul></div>
+<p>
+ It is possible to define define distances bounds, for example that some
+ distance must be between min_distance and max_distance. This is done
+ by passing DistancesPredicates which can be generated by following functions:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ bgi::unbounded(PointRelation) - default,
+ </li>
+<li class="listitem">
+ bgi::min_bounded(PointRelation, MinRelation),
+ </li>
+<li class="listitem">
+ bgi::max_bounded(PointRelation, MaxRelation),
+ </li>
+<li class="listitem">
+ bgi::bounded(PointRelation, MinRelation, MaxRelation).
+ </li>
+</ul></div>
+<p>
+ MinRelation and MaxRelation describes bounds and can be generated by
+ following functions:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ bgi::to_nearest(some_distance),
+ </li>
+<li class="listitem">
+ bgi::to_centroid(some_distance),
+ </li>
+<li class="listitem">
+ bgi::to_furthest(some_distance).
+ </li>
+</ul></div>
+<p>
+ <span class="bold"><strong>Spatial predicates</strong></span> may be a <code class="literal">Geometry</code>.
+ In this case Values intersecting the <code class="literal">Geometry</code> are
+ returned.
+ </p>
+<p>
+ It may be generated by one of the functions listed below:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <code class="literal">bgi::covered_by(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::disjoint(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::intersects(geometry)</code> - default,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::overlaps(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::within(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">!bgi::covered_by(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">!bgi::disjoint(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">!bgi::intersects(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">!bgi::overlaps(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">!bgi::within(geometry)</code>
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::value(func)</code>.
+ </li>
+</ul></div>
+<p>
+ Those predicates may be passed together in <code class="literal">std::pair<</code>...>
+ or <code class="literal">boost::tuple<</code>...>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -2557,7 +2858,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -2639,14 +2940,14 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.returns">Returns</a>
</h6>
<p>
The number of values found.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.h4"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws.
@@ -2663,24 +2964,64 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.description">Description</a>
</h6>
<p>
- 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="bold"><strong>Distances predicates</strong></span> may be a <code class="literal">Point</code>.
+ In this the case the Value closest to <code class="literal">Point</code> is returned.
</p>
+<p>
+ It is possible to define how distance to Value is calculated. This is
+ done by passing PointRelation. It can be generated by following functions:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ bgi::to_nearest(Point) - default,
+ </li>
+<li class="listitem">
+ bgi::to_centroid(Point),
+ </li>
+<li class="listitem">
+ bgi::to_furthest(Point).
+ </li>
+</ul></div>
+<p>
+ It is possible to define define distances bounds, for example that some
+ distance must be between min_distance and max_distance. This is done
+ by passing DistancesPredicates which can be generated by following functions:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ bgi::unbounded(PointRelation) - default,
+ </li>
+<li class="listitem">
+ bgi::min_bounded(PointRelation, MinRelation),
+ </li>
+<li class="listitem">
+ bgi::max_bounded(PointRelation, MaxRelation),
+ </li>
+<li class="listitem">
+ bgi::bounded(PointRelation, MinRelation, MaxRelation).
+ </li>
+</ul></div>
+<p>
+ MinRelation and MaxRelation describes bounds and can be generated by
+ following functions:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ bgi::to_nearest(some_distance),
+ </li>
+<li class="listitem">
+ bgi::to_centroid(some_distance),
+ </li>
+<li class="listitem">
+ bgi::to_furthest(some_distance).
+ </li>
+</ul></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -2692,7 +3033,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -2774,14 +3115,14 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.returns">Returns</a>
</h6>
<p>
The number of values found.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.h4"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws. If OutIter dereference
@@ -2799,32 +3140,111 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.description">Description</a>
</h6>
<p>
- 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).
- </p>
-<p>
- 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.
+ <span class="bold"><strong>Distances predicates</strong></span> may be a <code class="literal">Point</code>.
+ In this the case the Value closest to <code class="literal">Point</code> is returned.
+ </p>
+<p>
+ It is possible to define how distance to Value is calculated. This is
+ done by passing PointRelation. It can be generated by following functions:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ bgi::to_nearest(Point) - default,
+ </li>
+<li class="listitem">
+ bgi::to_centroid(Point),
+ </li>
+<li class="listitem">
+ bgi::to_furthest(Point).
+ </li>
+</ul></div>
+<p>
+ It is possible to define define distances bounds, for example that some
+ distance must be between min_distance and max_distance. This is done
+ by passing DistancesPredicates which can be generated by following functions:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ bgi::unbounded(PointRelation) - default,
+ </li>
+<li class="listitem">
+ bgi::min_bounded(PointRelation, MinRelation),
+ </li>
+<li class="listitem">
+ bgi::max_bounded(PointRelation, MaxRelation),
+ </li>
+<li class="listitem">
+ bgi::bounded(PointRelation, MinRelation, MaxRelation).
+ </li>
+</ul></div>
+<p>
+ MinRelation and MaxRelation describes bounds and can be generated by
+ following functions:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ bgi::to_nearest(some_distance),
+ </li>
+<li class="listitem">
+ bgi::to_centroid(some_distance),
+ </li>
+<li class="listitem">
+ bgi::to_furthest(some_distance).
+ </li>
+</ul></div>
+<p>
+ <span class="bold"><strong>Spatial predicates</strong></span> may be a <code class="literal">Geometry</code>.
+ In this case Values intersecting the <code class="literal">Geometry</code> are
+ returned.
+ </p>
+<p>
+ It may be generated by one of the functions listed below:
+ </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <code class="literal">bgi::covered_by(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::disjoint(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::intersects(geometry)</code> - default,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::overlaps(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::within(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">!bgi::covered_by(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">!bgi::disjoint(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">!bgi::intersects(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">!bgi::overlaps(geometry)</code>,
+ </li>
+<li class="listitem">
+ <code class="literal">!bgi::within(geometry)</code>
+ </li>
+<li class="listitem">
+ <code class="literal">bgi::value(func)</code>.
+ </li>
+</ul></div>
+<p>
+ Those predicates may be passed together in <code class="literal">std::pair<</code>...>
+ or <code class="literal">boost::tuple<</code>...>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -2839,7 +3259,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -2938,14 +3358,14 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.returns">Returns</a>
</h6>
<p>
The number of values found.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.h4"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws. If OutIter dereference
@@ -2961,7 +3381,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -2970,14 +3390,14 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.returns">Returns</a>
</h6>
<p>
The number of stored values.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.throws">Throws</a>
</h6>
<p>
Nothing.
@@ -2992,7 +3412,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -3001,14 +3421,14 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.returns">Returns</a>
</h6>
<p>
true if the container is empty.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.throws">Throws</a>
</h6>
<p>
Nothing.
@@ -3023,7 +3443,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member24.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member24.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member24.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member24.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member24.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -3032,7 +3452,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member24.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member24.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member24.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member24.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member24.throws">Throws</a>
</h6>
<p>
Nothing.
@@ -3047,15 +3467,16 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.description">Description</a>
</h6>
<p>
Returns the box containing all values stored in the container. If the
- container is empty the result of geometry::assign_inverse() is returned.
+ container is empty the result of <code class="literal">geometry::assign_inverse()</code>
+ is returned.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -3064,7 +3485,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.returns">Returns</a>
</h6>
<p>
The box containing all values stored in the container or an invalid box
@@ -3072,7 +3493,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.throws">Throws</a>
</h6>
<p>
Nothing.
@@ -3088,7 +3509,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.description">Description</a>
</h6>
<p>
For indexable_type it returns the number of values which indexables equals
@@ -3097,7 +3518,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -3107,7 +3528,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -3153,14 +3574,14 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.returns">Returns</a>
</h6>
<p>
The number of values found.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.h4"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.throws">Throws</a>
</h6>
<p>
Nothing.
@@ -3175,7 +3596,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -3184,14 +3605,14 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.returns">Returns</a>
</h6>
<p>
The parameters object.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.throws">Throws</a>
</h6>
<p>
Nothing.
@@ -3206,7 +3627,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -3215,14 +3636,14 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.returns">Returns</a>
</h6>
<p>
The translator object.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.throws">Throws</a>
</h6>
<p>
Nothing.
@@ -3237,7 +3658,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -3246,14 +3667,14 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.returns">Returns</a>
</h6>
<p>
The allocator.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.throws">Throws</a>
+ <span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.throws">Throws</a>
</h6>
<p>
If allocator copy constructor throws.
@@ -3510,7 +3931,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function0.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function0.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function0.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -3523,7 +3944,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function0.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function0.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function0.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function0.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function0.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -3602,7 +4023,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function1.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function1.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function1.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -3618,7 +4039,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function1.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function1.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function1.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function1.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function1.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -3713,7 +4134,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function2.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function2.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function2.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -3727,7 +4148,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function2.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function2.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function2.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function2.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function2.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -3806,15 +4227,16 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function3.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function3.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function3.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function3.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function3.description">Description</a>
</h6>
<p>
- Remove a value from the container. In contrast to the STL set/map erase()
- method this function removes only one value from the container.
+ Remove a value from the container. In contrast to the <code class="literal">std::set</code>
+ or <code class="literal">std::map</code><code class="literal">erase()</code> method this
+ function removes only one value from the container.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function3.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function3.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function3.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function3.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function3.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -3827,7 +4249,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function3.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function3.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function3.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function3.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function3.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -3897,7 +4319,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function3.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function3.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function3.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function3.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function3.returns">Returns</a>
</h6>
<p>
1 if value was removed, 0 otherwise.
@@ -3913,18 +4335,18 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function4.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function4.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function4.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function4.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function4.description">Description</a>
</h6>
<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 function removes only one value for each one passed in the range,
- not all equal values.
+ Remove a range of values from the container. In contrast to the <code class="literal">std::set</code>
+ or <code class="literal">std::map</code><code class="literal">erase()</code> 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.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function4.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function4.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function4.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function4.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function4.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -3940,7 +4362,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function4.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function4.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function4.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function4.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function4.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -4026,7 +4448,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function4.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function4.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function4.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function4.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function4.returns">Returns</a>
</h6>
<p>
The number of removed values.
@@ -4042,17 +4464,17 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function5.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function5.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function5.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function5.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function5.description">Description</a>
</h6>
<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. In contrast to the <code class="literal">std::set</code>
+ or <code class="literal">std::map</code><code class="literal">erase()</code> 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.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function5.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function5.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function5.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function5.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function5.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -4066,7 +4488,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function5.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function5.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function5.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function5.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function5.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -4136,7 +4558,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function5.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function5.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function5.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function5.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function5.returns">Returns</a>
</h6>
<p>
The number of removed values.
@@ -4152,7 +4574,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function6.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function6.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function6.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function6.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function6.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -4169,7 +4591,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function6.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function6.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function6.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function6.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function6.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -4255,7 +4677,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function6.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function6.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function6.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function6.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function6.returns">Returns</a>
</h6>
<p>
The number of found values.
@@ -4271,7 +4693,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function7.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function7.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function7.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function7.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function7.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -4287,7 +4709,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function7.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function7.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function7.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function7.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function7.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -4374,7 +4796,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function7.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function7.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function7.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function7.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function7.returns">Returns</a>
</h6>
<p>
The number of found values.
@@ -4391,7 +4813,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function8.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function8.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function8.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function8.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function8.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -4409,7 +4831,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function8.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function8.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function8.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function8.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function8.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -4513,7 +4935,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function8.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function8.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function8.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function8.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function8.returns">Returns</a>
</h6>
<p>
The number of found values.
@@ -4529,7 +4951,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function9.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function9.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function9.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function9.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function9.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -4547,7 +4969,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function9.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function9.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function9.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function9.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function9.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -4651,7 +5073,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function9.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function9.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function9.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function9.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function9.returns">Returns</a>
</h6>
<p>
The number of found values.
@@ -4668,7 +5090,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function10.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function10.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function10.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function10.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function10.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -4688,7 +5110,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function10.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function10.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function10.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function10.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function10.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -4809,7 +5231,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function10.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function10.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function10.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function10.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function10.returns">Returns</a>
</h6>
<p>
The number of found values.
@@ -4825,7 +5247,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function11.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function11.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function11.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function11.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function11.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -4838,7 +5260,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function11.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function11.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function11.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function11.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function11.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -4897,7 +5319,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function12.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function12.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function12.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function12.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function12.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -4910,7 +5332,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function12.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function12.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function12.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function12.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function12.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -4960,7 +5382,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function12.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function12.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function12.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function12.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function12.returns">Returns</a>
</h6>
<p>
The number of values stored in the index.
@@ -4976,7 +5398,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function13.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function13.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function13.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function13.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function13.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -4989,7 +5411,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function13.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function13.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function13.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function13.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function13.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -5039,7 +5461,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function13.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function13.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function13.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function13.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function13.returns">Returns</a>
</h6>
<p>
true if there are no values in the index.
@@ -5056,7 +5478,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function14.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function14.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function14.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function14.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function14.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -5069,7 +5491,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function14.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function14.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function14.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function14.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function14.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -5119,7 +5541,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function14.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function14.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function14.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.function14.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function14.returns">Returns</a>
</h6>
<p>
The box containing all stored values or an invalid box.
@@ -5183,7 +5605,7 @@
</td>
<td>
<p>
- Generate covered_by() predicate.
+ Generate <code class="literal">covered_by()</code> predicate.
</p>
</td>
</tr>
@@ -5196,7 +5618,7 @@
</td>
<td>
<p>
- Generate disjoint() predicate.
+ Generate <code class="literal">disjoint()</code> predicate.
</p>
</td>
</tr>
@@ -5209,7 +5631,7 @@
</td>
<td>
<p>
- Generate intersects() predicate.
+ Generate <code class="literal">intersects()</code> predicate.
</p>
</td>
</tr>
@@ -5222,7 +5644,7 @@
</td>
<td>
<p>
- Generate overlaps() predicate.
+ Generate <code class="literal">overlaps()</code> predicate.
</p>
</td>
</tr>
@@ -5235,7 +5657,7 @@
</td>
<td>
<p>
- Generate within() predicate.
+ Generate <code class="literal">within()</code> predicate.
</p>
</td>
</tr>
@@ -5250,7 +5672,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function0.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function0.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function0.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -5268,7 +5690,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function1.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function1.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function1.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function1.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function1.description">Description</a>
</h6>
<p>
A wrapper around user-defined functor describing if Value should be returned
@@ -5276,7 +5698,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function1.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function1.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function1.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -5286,7 +5708,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function1.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function1.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function1.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function1.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function1.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -5336,20 +5758,20 @@
const &)</a>
</h5></div></div></div>
<p>
- Generate covered_by() predicate.
+ Generate <code class="literal">covered_by()</code> predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function2.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function2.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function2.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function2.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function2.description">Description</a>
</h6>
<p>
Generate a predicate defining Value and Geometry relationship. Value
- will be returned by the query if bg::covered_by(Indexable, Geometry)
+ will be returned by the query if <code class="literal">bg::covered_by(Indexable, Geometry)</code>
returns true.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function2.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function2.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function2.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -5359,7 +5781,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function2.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function2.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function2.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function2.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function2.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -5410,20 +5832,20 @@
const &)</a>
</h5></div></div></div>
<p>
- Generate disjoint() predicate.
+ Generate <code class="literal">disjoint()</code> predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function3.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function3.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function3.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function3.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function3.description">Description</a>
</h6>
<p>
Generate a predicate defining Value and Geometry relationship. Value
- will be returned by the query if bg::disjoint(Indexable, Geometry) returns
- true.
+ will be returned by the query if <code class="literal">bg::disjoint(Indexable, Geometry)</code>
+ returns true.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function3.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function3.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function3.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function3.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function3.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -5433,7 +5855,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function3.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function3.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function3.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function3.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function3.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -5484,20 +5906,20 @@
const &)</a>
</h5></div></div></div>
<p>
- Generate intersects() predicate.
+ Generate <code class="literal">intersects()</code> predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function4.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function4.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function4.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function4.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function4.description">Description</a>
</h6>
<p>
Generate a predicate defining Value and Geometry relationship. Value
- will be returned by the query if bg::intersects(Indexable, Geometry)
+ will be returned by the query if <code class="literal">bg::intersects(Indexable, Geometry)</code>
returns true.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function4.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function4.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function4.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function4.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function4.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -5507,7 +5929,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function4.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function4.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function4.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function4.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function4.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -5558,20 +5980,20 @@
const &)</a>
</h5></div></div></div>
<p>
- Generate overlaps() predicate.
+ Generate <code class="literal">overlaps()</code> predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function5.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function5.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function5.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function5.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function5.description">Description</a>
</h6>
<p>
Generate a predicate defining Value and Geometry relationship. Value
- will be returned by the query if bg::overlaps(Indexable, Geometry) returns
- true.
+ will be returned by the query if <code class="literal">bg::overlaps(Indexable, Geometry)</code>
+ returns true.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function5.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function5.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function5.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function5.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function5.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -5581,7 +6003,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function5.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function5.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function5.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function5.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function5.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -5632,20 +6054,20 @@
const &)</a>
</h5></div></div></div>
<p>
- Generate within() predicate.
+ Generate <code class="literal">within()</code> predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function6.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function6.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function6.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function6.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function6.description">Description</a>
</h6>
<p>
Generate a predicate defining Value and Geometry relationship. Value
- will be returned by the query if bg::within(Indexable, Geometry) returns
- true.
+ will be returned by the query if <code class="literal">bg::within(Indexable, Geometry)</code>
+ returns true.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function6.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function6.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function6.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function6.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function6.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -5655,7 +6077,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function6.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function6.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function6.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.function6.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function6.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -5832,7 +6254,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function0.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function0.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function0.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function0.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function0.description">Description</a>
</h6>
<p>
Generate a nearest query Point and Value's Indexable relationship while
@@ -5845,7 +6267,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function0.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function0.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function0.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -5855,7 +6277,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function0.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function0.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function0.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function0.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function0.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -5910,7 +6332,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function1.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function1.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function1.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function1.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function1.description">Description</a>
</h6>
<p>
Generate a nearest query Point and Value's Indexable relationship while
@@ -5921,7 +6343,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function1.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function1.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function1.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -5931,7 +6353,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function1.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function1.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function1.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function1.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function1.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -5986,7 +6408,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function2.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function2.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function2.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function2.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function2.description">Description</a>
</h6>
<p>
Generate a nearest query Point and Value's Indexable relationship while
@@ -5999,7 +6421,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function2.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function2.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function2.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -6009,7 +6431,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function2.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function2.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function2.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function2.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function2.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -6064,7 +6486,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function3.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function3.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function3.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function3.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function3.description">Description</a>
</h6>
<p>
Generate a distance predicate. This defines distances bounds which are
@@ -6075,7 +6497,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function3.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function3.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function3.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function3.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function3.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -6085,7 +6507,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function3.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function3.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function3.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function3.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function3.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -6140,7 +6562,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function4.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function4.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function4.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function4.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function4.description">Description</a>
</h6>
<p>
Generate a distance predicate. This defines distances bounds which are
@@ -6153,7 +6575,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function4.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function4.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function4.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function4.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function4.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -6163,7 +6585,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function4.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function4.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function4.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function4.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function4.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -6202,8 +6624,8 @@
</td>
<td>
<p>
- The point relation. This may be generated by bgi::to_nearest(Point),
- bgi::to_centroid(Point) or bgi::to_furthest(Point).
+ The point relation. This may be generated by <code class="literal">bgi::to_nearest(Point)</code>,
+ <code class="literal">bgi::to_centroid(Point)</code> or <code class="literal">bgi::to_furthest(Point)</code>.
</p>
</td>
</tr>
@@ -6220,8 +6642,8 @@
</td>
<td>
<p>
- The minimum bound relation. This may be generated by bgi::to_nearest(min_distance),
- bgi::to_centroid(min_distance) or bgi::to_furthest(min_distance).
+ The minimum bound relation. This may be generated by <code class="literal">bgi::to_nearest(min_distance)</code>,
+ <code class="literal">bgi::to_centroid(min_distance)</code> or <code class="literal">bgi::to_furthest(min_distance)</code>.
</p>
</td>
</tr>
@@ -6238,7 +6660,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function5.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function5.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function5.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function5.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function5.description">Description</a>
</h6>
<p>
Generate a distance predicate. This defines distances bounds which are
@@ -6251,7 +6673,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function5.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function5.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function5.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function5.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function5.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -6261,7 +6683,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function5.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function5.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function5.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function5.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function5.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -6300,8 +6722,8 @@
</td>
<td>
<p>
- The point relation. This may be generated by bgi::to_nearest(Point),
- bgi::to_centroid(Point) or bgi::to_furthest(Point).
+ The point relation. This may be generated by <code class="literal">bgi::to_nearest(Point)</code>,
+ <code class="literal">bgi::to_centroid(Point)</code> or <code class="literal">bgi::to_furthest(Point)</code>.
</p>
</td>
</tr>
@@ -6318,8 +6740,8 @@
</td>
<td>
<p>
- The maximum bound relation. This may be generated by bgi::to_nearest(max_distance),
- bgi::to_centroid(max_distance) or bgi::to_furthest(max_distance).
+ The maximum bound relation. This may be generated by <code class="literal">bgi::to_nearest(max_distance)</code>,
+ <code class="literal">bgi::to_centroid(max_distance)</code> or <code class="literal">bgi::to_furthest(max_distance)</code>.
</p>
</td>
</tr>
@@ -6336,7 +6758,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function6.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function6.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function6.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function6.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function6.description">Description</a>
</h6>
<p>
Generate a distance predicate. This defines distances bounds which are
@@ -6350,7 +6772,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function6.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function6.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function6.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function6.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function6.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -6364,7 +6786,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function6.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function6.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function6.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.function6.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function6.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -6403,8 +6825,8 @@
</td>
<td>
<p>
- The point relation. This may be generated by bgi::to_nearest(Point),
- bgi::to_centroid(Point) or bgi::to_furthest(Point).
+ The point relation. This may be generated by <code class="literal">bgi::to_nearest(Point)</code>,
+ <code class="literal">bgi::to_centroid(Point)</code> or <code class="literal">bgi::to_furthest(Point)</code>.
</p>
</td>
</tr>
@@ -6421,8 +6843,8 @@
</td>
<td>
<p>
- The minimum bound relation. This may be generated by bgi::to_nearest(min_distance),
- bgi::to_centroid(min_distance) or bgi::to_furthest(min_distance).
+ The minimum bound relation. This may be generated by <code class="literal">bgi::to_nearest(min_distance)</code>,
+ <code class="literal">bgi::to_centroid(min_distance)</code> or <code class="literal">bgi::to_furthest(min_distance)</code>.
</p>
</td>
</tr>
@@ -6439,8 +6861,8 @@
</td>
<td>
<p>
- The maximum bound relation. This may be generated by bgi::to_nearest(max_distance),
- bgi::to_centroid(max_distance) or bgi::to_furthest(max_distance).
+ The maximum bound relation. This may be generated by <code class="literal">bgi::to_nearest(max_distance)</code>,
+ <code class="literal">bgi::to_centroid(max_distance)</code> or <code class="literal">bgi::to_furthest(max_distance)</code>.
</p>
</td>
</tr>
@@ -6523,7 +6945,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__adaptors.function0.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function0.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__adaptors.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function0.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -6535,7 +6957,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__adaptors.function0.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function0.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function0.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__adaptors.function0.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function0.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -6626,7 +7048,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__adaptors.function1.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function1.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__adaptors.function1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function1.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -6636,7 +7058,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__adaptors.function1.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function1.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function1.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__adaptors.function1.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function1.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -6710,7 +7132,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__adaptors.function2.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function2.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__adaptors.function2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function2.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -6720,7 +7142,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__adaptors.function2.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function2.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function2.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__adaptors.function2.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function2.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -6775,12 +7197,12 @@
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def" title="boost::geometry::index::translator::def">boost::geometry::index::translator::def</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="id935919"></a><a class="indexterm" name="id935924"></a><a class="indexterm" name="id935929"></a><a class="indexterm" name="id935934"></a><a class="indexterm" name="id935938"></a>
+ <a class="indexterm" name="idp11573536"></a><a class="indexterm" name="idp11573864"></a><a class="indexterm" name="idp11574208"></a><a class="indexterm" name="idp11574552"></a><a class="indexterm" name="idp11574896"></a>
The default translator.
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.description">Description</a>
</h6>
<p>
It translates Value object to Indexable object. The default version handles
@@ -6789,14 +7211,14 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.header">Header</a>
+ <span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.header">Header</a>
</h6>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">extensions</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">translator</span><span class="special">/</span><span class="identifier">def</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -6810,7 +7232,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.template_parameter_s_">Template
+ <span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -6849,12 +7271,12 @@
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index" title="boost::geometry::index::translator::index">boost::geometry::index::translator::index</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="id936193"></a><a class="indexterm" name="id936198"></a><a class="indexterm" name="id936202"></a><a class="indexterm" name="id936207"></a><a class="indexterm" name="id936212"></a>
+ <a class="indexterm" name="idp11597120"></a><a class="indexterm" name="idp11597448"></a><a class="indexterm" name="idp11597792"></a><a class="indexterm" name="idp11598136"></a><a class="indexterm" name="idp11598480"></a>
The index translator.
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.description">Description</a>
</h6>
<p>
This translator translates from index of an element in an external Container
@@ -6865,14 +7287,14 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.header">Header</a>
+ <span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.header">Header</a>
</h6>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">extensions</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">translator</span><span class="special">/</span><span class="identifier">index</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -6886,7 +7308,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.template_parameter_s_">Template
+ <span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -6921,7 +7343,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.h4"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.constructor_s__and_destructor"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.constructor_s__and_destructor">Constructor(s)
+ <span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.constructor_s__and_destructor"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.constructor_s__and_destructor">Constructor(s)
and destructor</a>
</h6>
<div class="informaltable"><table class="table">
@@ -6964,14 +7386,14 @@
The constructor.
</p>
<h7><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.synopsis">Synopsis</a>
</h7><p>
</p>
<pre class="programlisting"><span class="identifier">index</span><span class="special">(</span><span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">c</span><span class="special">)</span></pre>
<p>
</p>
<h7><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.parameter_s_">Parameter(s)</a>
</h7><div class="informaltable"><table class="table">
<colgroup>
<col>
@@ -7061,7 +7483,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__inserters.function0.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.function0.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.description">Description</a>
+ <span><a name="geometry_index.r_tree.reference.group__inserters.function0.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.description">Description</a>
</h6>
<p>
Returns insert iterator capable to insert values to the container (spatial
@@ -7069,7 +7491,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__inserters.function0.h1"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.synopsis">Synopsis</a>
+ <span><a name="geometry_index.r_tree.reference.group__inserters.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.synopsis">Synopsis</a>
</h6>
<p>
</p>
@@ -7079,7 +7501,7 @@
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__inserters.function0.h2"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.function0.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.parameters">Parameters</a>
+ <span><a name="geometry_index.r_tree.reference.group__inserters.function0.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -7125,7 +7547,7 @@
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__inserters.function0.h3"></a>
- <span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.function0.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.returns">Returns</a>
+ <span><a name="geometry_index.r_tree.reference.group__inserters.function0.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.returns">Returns</a>
</h6>
<p>
The insert iterator inserting values to the container.
==============================================================================
--- sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/rtree_quickstart.html (original)
+++ sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/rtree_quickstart.html 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Quick Start</title>
<link rel="stylesheet" href="http://www.boost.org/doc/libs/release/doc/src/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../../index.html" title="Chapter 1. Geometry Index">
<link rel="up" href="../r_tree.html" title="R-tree">
<link rel="prev" href="introduction.html" title="Introduction">
@@ -150,7 +150,7 @@
</p>
<h4>
<a name="geometry_index.r_tree.rtree_quickstart.h0"></a>
- <span class="phrase"><a name="geometry_index.r_tree.rtree_quickstart.more"></a></span><a class="link" href="rtree_quickstart.html#geometry_index.r_tree.rtree_quickstart.more">More</a>
+ <span><a name="geometry_index.r_tree.rtree_quickstart.more"></a></span><a class="link" href="rtree_quickstart.html#geometry_index.r_tree.rtree_quickstart.more">More</a>
</h4>
<p>
More information about the R-tree implementation, other algorithms and queries
==============================================================================
--- sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/spatial_queries.html (original)
+++ sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/spatial_queries.html 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Spatial queries</title>
<link rel="stylesheet" href="http://www.boost.org/doc/libs/release/doc/src/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../../index.html" title="Chapter 1. Geometry Index">
<link rel="up" href="../r_tree.html" title="R-tree">
<link rel="prev" href="creation_and_modification.html" title="Creation and modification">
==============================================================================
--- sandbox-branches/geometry/index/doc/html/index.html (original)
+++ sandbox-branches/geometry/index/doc/html/index.html 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Chapter 1. Geometry Index</title>
<link rel="stylesheet" href="http://www.boost.org/doc/libs/release/doc/src/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Chapter 1. Geometry Index">
<link rel="next" href="geometry_index/introduction.html" title="Introduction">
</head>
@@ -56,7 +56,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 10, 2013 at 20:11:29 GMT</small></p></td>
+<td align="left"><p><small>Last revised: January 11, 2013 at 04:03:52 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
==============================================================================
--- sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/doxygen_elements.hpp (original)
+++ sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/doxygen_elements.hpp 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -110,6 +110,8 @@
std::vector<parameter> parameters;
std::vector<paragraph> paragraphs;
+ std::string warning;
+ std::string note;
element()
: line(0)
==============================================================================
--- sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/doxygen_xml_parser.hpp (original)
+++ sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/doxygen_xml_parser.hpp 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -77,7 +77,7 @@
}
else if ( boost::equals(name, "itemizedlist") )
{
- contents += "\n";
+ contents += "\n\n";
parse_para(node->first_node(), contents, skip);
contents += "\n";
parse_para(node->next_sibling(), contents, skip);
@@ -402,6 +402,14 @@
el.paragraphs.push_back(p);
}
+ else if (kind == "warning")
+ {
+ parse_para(node->first_node("para"), el.warning, el.skip);
+ }
+ else if (kind == "note")
+ {
+ parse_para(node->first_node("para"), el.note, el.skip);
+ }
}
else if (full == ".param")
{
==============================================================================
--- sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp (original)
+++ sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp 2013-01-10 23:09:30 EST (Thu, 10 Jan 2013)
@@ -748,6 +748,37 @@
<< std::endl;
}
+void output_paragraphs_note_warning(element const& el, std::ostream & out)
+{
+ // Additional paragraphs
+ if ( !el.paragraphs.empty() )
+ {
+ BOOST_FOREACH(paragraph const& p, el.paragraphs)
+ {
+ if ( !p.title.empty() )
+ out << "[heading " << p.title << "]" << std::endl;
+ else
+ out << "\n\n" << std::endl;
+ out << p.text << std::endl;
+ out << std::endl;
+ }
+ }
+
+ // Note
+ if ( !el.note.empty() )
+ {
+ out << "[note " << el.note << "]" << std::endl;
+ out << std::endl;
+ }
+
+ // Warning
+ if ( !el.warning.empty() )
+ {
+ out << "[warning " << el.warning << "]" << std::endl;
+ out << std::endl;
+ }
+}
+
void quickbook_output_detail_function(std::vector<function> const& functions,
function_type type,
configuration const& config,
@@ -813,19 +844,8 @@
out << f.return_description << std::endl;
}
- // Additional paragraphs
- if ( !f.paragraphs.empty() )
- {
- BOOST_FOREACH(paragraph const& p, f.paragraphs)
- {
- if ( !p.title.empty() )
- out << "[heading " << p.title << "]" << std::endl;
- else
- out << "\n\n" << std::endl;
- out << p.text << std::endl;
- out << std::endl;
- }
- }
+ // Additional paragraphs, note, warning
+ output_paragraphs_note_warning(f, out);
// QBK markup
quickbook_markup(f.qbk_markup, markup_any, markup_default, out);
@@ -903,6 +923,10 @@
quickbook_string_with_heading_if_present("Description", cos.detailed_description, out);
+ // Additional paragraphs, note, warning
+ output_paragraphs_note_warning(cos, out);
+
+ // Markup
quickbook_markup(cos.qbk_markup, markup_any, markup_default, out);
// Header
