[Boost-commit] svn:boost r82422 - in sandbox-branches/geometry/index: doc/generated test

Subject: [Boost-commit] svn:boost r82422 - in sandbox-branches/geometry/index: doc/generated test
From: adam.wulkiewicz_at_[hidden]
Date: 2013-01-09 13:33:44

Author: awulkiew
Date: 2013-01-09 13:33:43 EST (Wed, 09 Jan 2013)
New Revision: 82422
URL: http://svn.boost.org/trac/boost/changeset/82422

Log:
static_vector test moddified, added generated reference files
Added:
   sandbox-branches/geometry/index/doc/generated/adaptors.qbk   (contents, props changed)
   sandbox-branches/geometry/index/doc/generated/distance_predicates.qbk   (contents, props changed)
   sandbox-branches/geometry/index/doc/generated/predicates.qbk   (contents, props changed)
   sandbox-branches/geometry/index/doc/generated/rtree.qbk   (contents, props changed)
   sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk   (contents, props changed)
Text files modified: 
   sandbox-branches/geometry/index/test/static_vector.cpp |    21 +++++++--------------                   
   1 files changed, 7 insertions(+), 14 deletions(-)

Added: sandbox-branches/geometry/index/doc/generated/adaptors.qbk
==============================================================================
--- (empty file)
+++ sandbox-branches/geometry/index/doc/generated/adaptors.qbk	2013-01-09 13:33:43 EST (Wed, 09 Jan 2013)
@@ -0,0 +1,56 @@
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
+[/ Generated from xml/group__adaptors.xml]
+[section:group__adaptors Spatial indexes adaptors (boost::geometry::index::adaptors::)]
+[table
+[[Function][Description]]
+[[[link geometry_index.r_tree.reference.group__adaptors.function0 `nearest_queried(DistancesPredicates const &, size_t, Predicates const &)`]][The nearest query index adaptor generator. ]]
+[[[link geometry_index.r_tree.reference.group__adaptors.function1 `nearest_queried(DistancesPredicates const &, size_t)`]][The nearest query index adaptor generator. ]]
+[[[link geometry_index.r_tree.reference.group__adaptors.function2 `spatial_queried(Predicates const &)`]][The spatial query index adaptor generator. ]]
+]
+
+[section:function0 nearest_queried(DistancesPredicates const &, size_t, Predicates const &)]
+The nearest query index adaptor generator. [heading Synopsis]
+``template<typename DistancesPredicates, typename Predicates>
+detail::nearest_query<DistancesPredicates, Predicates> boost::geometry::index::adaptors::nearest_queried(DistancesPredicates const & dpred,
+                                                                                                         size_t k,
+                                                                                                         Predicates const & pred)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `DistancesPredicates const &` ][ `dpred` ][Distance predicates. ]]
+[[ `size_t` ][ `k` ][The number of values to find. ]]
+[[ `Predicates const &` ][ `pred` ][Spatial predicates. ]]
+]
+[endsect]
+[br]
+
+[section:function1 nearest_queried(DistancesPredicates const &, size_t)]
+The nearest query index adaptor generator. [heading Synopsis]
+``template<typename DistancesPredicates>
+detail::nearest_query<DistancesPredicates, index::detail::empty> boost::geometry::index::adaptors::nearest_queried(DistancesPredicates const & dpred, size_t k)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `DistancesPredicates const &` ][ `dpred` ][Distance predicates. ]]
+[[ `size_t` ][ `k` ][The number of values to find. ]]
+]
+[endsect]
+[br]
+
+[section:function2 spatial_queried(Predicates const &)]
+The spatial query index adaptor generator. [heading Synopsis]
+``template<typename Predicates>
+detail::spatial_query<Predicates> boost::geometry::index::adaptors::spatial_queried(Predicates const & pred)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `Predicates const &` ][ `pred` ][Spatial predicates. ]]
+]
+[endsect]
+[br]
+
+[endsect]
+

Added: sandbox-branches/geometry/index/doc/generated/distance_predicates.qbk
==============================================================================
--- (empty file)
+++ sandbox-branches/geometry/index/doc/generated/distance_predicates.qbk	2013-01-09 13:33:43 EST (Wed, 09 Jan 2013)
@@ -0,0 +1,122 @@
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
+[/ Generated from xml/group__distance__predicates.xml]
+[section:group__distance__predicates Distance predicates (boost::geometry::index::)]
+[table
+[[Function][Description]]
+[[[link geometry_index.r_tree.reference.group__distance__predicates.function0 `to_nearest(T const &)`]][Generate to_nearest() Point-Indexable relationship. ]]
+[[[link geometry_index.r_tree.reference.group__distance__predicates.function1 `to_centroid(T const &)`]][Generate to_centroid() Point-Indexable relationship. ]]
+[[[link geometry_index.r_tree.reference.group__distance__predicates.function2 `to_furthest(T const &)`]][Generate to_furthest() Point-Indexable relationship. ]]
+[[[link geometry_index.r_tree.reference.group__distance__predicates.function3 `unbounded(PointRelation const &)`]][Generate unbounded() distance predicate. ]]
+[[[link geometry_index.r_tree.reference.group__distance__predicates.function4 `min_bounded(PointRelation const &, MinRelation const &)`]][Generate min_bounded() distance predicate. ]]
+[[[link geometry_index.r_tree.reference.group__distance__predicates.function5 `max_bounded(PointRelation const &, MaxRelation const &)`]][Generate max_bounded() distance predicate. ]]
+[[[link geometry_index.r_tree.reference.group__distance__predicates.function6 `bounded(PointRelation const &, MinRelation const &, MaxRelation const &)`]][Generate bounded() distance predicate. ]]
+]
+
+[section:function0 to_nearest(T const &)]
+Generate to_nearest() Point-Indexable relationship. [heading Description]
+Generate a nearest query Point and Value's Indexable relationship while calculating distances. This function may be used to define that knn query should calculate distances as smallest as possible between query Point and Indexable's points. In other words it should be the distance to the nearest Indexable's point. This function may be also used to define distances bounds which indicates that Indexable's nearest point should be closer or further than value v. This is default relation.[heading Synopsis]
+``template<typename T>
+detail::to_nearest<T> boost::geometry::index::to_nearest(T const & v)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `T const &` ][ `v` ][Point or bound value. ]]
+]
+[endsect]
+[br]
+
+[section:function1 to_centroid(T const &)]
+Generate to_centroid() Point-Indexable relationship. [heading Description]
+Generate a nearest query Point and Value's Indexable relationship while calculating distances. This function may be used to define that knn query should calculate distances between query Point and Indexable's centroid. This function may be also used to define distances bounds which indicates that Indexable's centroid should be closer or further than value v.[heading Synopsis]
+``template<typename T>
+detail::to_centroid<T> boost::geometry::index::to_centroid(T const & v)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `T const &` ][ `v` ][Point or bound value. ]]
+]
+[endsect]
+[br]
+
+[section:function2 to_furthest(T const &)]
+Generate to_furthest() Point-Indexable relationship. [heading Description]
+Generate a nearest query Point and Value's Indexable relationship while calculating distances. This function may be used to define that knn query should calculate distances as biggest as possible between query Point and Indexable's points. In other words it should be the distance to the furthest Indexable's point. This function may be also used to define distances bounds which indicates that Indexable's furthest point should be closer or further than value v.[heading Synopsis]
+``template<typename T>
+detail::to_furthest<T> boost::geometry::index::to_furthest(T const & v)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `T const &` ][ `v` ][Point or bound value. ]]
+]
+[endsect]
+[br]
+
+[section:function3 unbounded(PointRelation const &)]
+Generate unbounded() distance predicate. [heading Description]
+Generate a distance predicate. This defines distances bounds which are used by knn query. This function indicates that there is no distance bounds and Values should be returned if distances between Point and Indexable are the smallest. Distance calculation is defined by PointRelation. This is default nearest predicate.[heading Synopsis]
+``template<typename PointRelation>
+detail::unbounded<PointRelation> boost::geometry::index::unbounded(PointRelation const & pr)``
+
+[heading Parameters]
+[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). ]]
+]
+[endsect]
+[br]
+
+[section:function4 min_bounded(PointRelation const &, MinRelation const &)]
+Generate min_bounded() distance predicate. [heading Description]
+Generate a distance predicate. This defines distances bounds which are used by knn query. This function indicates that Values should be returned only if distances between Point and Indexable are greater or equal to some min_distance passed in MinRelation. Check for closest Value is defined by PointRelation. So it is possible e.g. to return Values with centroids closest to some Point but only if nearest points are further than some distance.[heading Synopsis]
+``template<typename PointRelation, typename MinRelation>
+detail::min_bounded<PointRelation, MinRelation> boost::geometry::index::min_bounded(PointRelation const & pr, MinRelation const & minr)``
+
+[heading Parameters]
+[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). ]]
+]
+[endsect]
+[br]
+
+[section:function5 max_bounded(PointRelation const &, MaxRelation const &)]
+Generate max_bounded() distance predicate. [heading Description]
+Generate a distance predicate. This defines distances bounds which are used by knn query. This function indicates that Values should be returned only if distances between Point and Indexable are lesser or equal to some max_distance passed in MaxRelation. Check for closest Value is defined by PointRelation. So it is possible e.g. to return Values with centroids closest to some Point but only if nearest points are closer than some distance.[heading Synopsis]
+``template<typename PointRelation, typename MaxRelation>
+detail::max_bounded<PointRelation, MaxRelation> boost::geometry::index::max_bounded(PointRelation const & pr, MaxRelation const & maxr)``
+
+[heading Parameters]
+[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). ]]
+]
+[endsect]
+[br]
+
+[section:function6 bounded(PointRelation const &, MinRelation const &, MaxRelation const &)]
+Generate bounded() distance predicate. [heading Description]
+Generate a distance predicate. This defines distances bounds which are used by knn query. This function indicates that Values should be returned only if distances between Point and Indexable are greater or equal to some min_distance passed in MinRelation and lesser or equal to some max_distance passed in MaxRelation. Check for closest Value is defined by PointRelation. So it is possible e.g. to return Values with centroids closest to some Point but only if nearest points are further than some distance and closer than some other distance.[heading Synopsis]
+``template<typename PointRelation,
+         typename MinRelation,
+         typename MaxRelation>
+detail::bounded<PointRelation, MinRelation, MaxRelation> boost::geometry::index::bounded(PointRelation const & pr,
+                                                                                         MinRelation const & minr,
+                                                                                         MaxRelation const & maxr)``
+
+[heading Parameters]
+[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). ]]
+]
+[endsect]
+[br]
+
+[endsect]
+

Added: sandbox-branches/geometry/index/doc/generated/predicates.qbk
==============================================================================
--- (empty file)
+++ sandbox-branches/geometry/index/doc/generated/predicates.qbk	2013-01-09 13:33:43 EST (Wed, 09 Jan 2013)
@@ -0,0 +1,107 @@
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
+[/ Generated from xml/group__predicates.xml]
+[section:group__predicates Predicates (boost::geometry::index::)]
+[table
+[[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. ]]
+]
+
+[section:function0 empty()]
+Generate empty predicate. [heading Synopsis]
+``detail::empty boost::geometry::index::empty()``
+
+[endsect]
+[br]
+
+[section:function1 value(ValuePredicate const &)]
+Generate value predicate. [heading Description]
+A wrapper around user-defined functor describing if Value should be returned by spatial query.[heading Synopsis]
+``template<typename ValuePredicate>
+detail::value<ValuePredicate> boost::geometry::index::value(ValuePredicate const & vpred)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `ValuePredicate const &` ][ `vpred` ][The functor. ]]
+]
+[endsect]
+[br]
+
+[section:function2 covered_by(Geometry const &)]
+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]
+``template<typename Geometry>
+detail::covered_by<Geometry> boost::geometry::index::covered_by(Geometry const & g)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `Geometry const &` ][ `g` ][The Geometry object. ]]
+]
+[endsect]
+[br]
+
+[section:function3 disjoint(Geometry const &)]
+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]
+``template<typename Geometry>
+detail::disjoint<Geometry> boost::geometry::index::disjoint(Geometry const & g)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `Geometry const &` ][ `g` ][The Geometry object. ]]
+]
+[endsect]
+[br]
+
+[section:function4 intersects(Geometry const &)]
+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]
+``template<typename Geometry>
+detail::intersects<Geometry> boost::geometry::index::intersects(Geometry const & g)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `Geometry const &` ][ `g` ][The Geometry object. ]]
+]
+[endsect]
+[br]
+
+[section:function5 overlaps(Geometry const &)]
+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]
+``template<typename Geometry>
+detail::overlaps<Geometry> boost::geometry::index::overlaps(Geometry const & g)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `Geometry const &` ][ `g` ][The Geometry object. ]]
+]
+[endsect]
+[br]
+
+[section:function6 within(Geometry const &)]
+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]
+``template<typename Geometry>
+detail::within<Geometry> boost::geometry::index::within(Geometry const & g)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `Geometry const &` ][ `g` ][The Geometry object. ]]
+]
+[endsect]
+[br]
+
+[endsect]
+

Added: sandbox-branches/geometry/index/doc/generated/rtree.qbk
==============================================================================
--- (empty file)
+++ sandbox-branches/geometry/index/doc/generated/rtree.qbk	2013-01-09 13:33:43 EST (Wed, 09 Jan 2013)
@@ -0,0 +1,627 @@
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
+[/ Generated from xml/classboost_1_1geometry_1_1index_1_1rtree.xml]
+[section:boost_geometry_index_rtree boost::geometry::index::rtree]
+
+'''<indexterm><primary>boost</primary></indexterm><indexterm><primary>geometry</primary></indexterm><indexterm><primary>index</primary></indexterm><indexterm><primary>rtree</primary></indexterm>'''
+The R-tree spatial index. 
+
+[heading Description]
+The R-tree spatial index. This is self-balancing spatial index capable to store various types of Values and balancing algorithms.
+
+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 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&.
+
+[heading Header]
+`#include <.hpp>`
+
+[heading Synopsis]
+``template<typename Value,
+         typename Parameters,
+         typename Translator = translator::def<Value>,
+         typename Allocator = std::allocator<Value>>
+class rtree
+{
+  // ...
+};
+``
+
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`Value`][The type of objects stored in the container. ]]
+[[`Parameters`][Compile-time parameters. ]]
+[[`Translator`][The type of the translator which translates from Value to Indexable. ]]
+[[`Allocator`][The allocator used to allocate/deallocate memory, construct/destroy nodes and Values. ]]
+]
+
+[heading Typedef(s)]
+[table
+[[Type] [Description]]
+[[`value_type`][The type of Value stored in the container. ]]
+[[`parameters_type`][R-tree parameters type. ]]
+[[`translator_type`][Value to Indexable Translator type. ]]
+[[`allocator_type`][The type of allocator used by the container. ]]
+[[`size_type`][Unsigned integral type used by the container. ]]
+[[`indexable_type`][The Indexable type to which Value is translated. ]]
+[[`box_type`][The Box type used by the R-tree. ]]
+]
+
+[heading Constructor(s) and destructor]
+[table
+[[Function][Description]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member0 `rtree()`]][The constructor. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member1 `rtree(parameters_type, translator_type const &, allocator_type)`]][The constructor. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member2 `rtree(Iterator, Iterator)`]][The constructor. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member3 `rtree(Range const &)`]][The constructor. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member4 `~rtree()`]][The destructor. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member5 `rtree(rtree const &)`]][The copy constructor. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member6 `rtree(rtree const &, allocator_type const &)`]][The copy constructor. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member7 `rtree(rtree &&)`]][The moving constructor. ]]
+]
+
+[heading Member(s)]
+[table
+[[Function][Description]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member8 `operator=(const rtree &)`]][The assignment operator. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member9 `operator=(rtree &&)`]][The moving assignment. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member10 `swap(rtree &)`]][Swaps contents of two rtrees. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member11 `insert(value_type const &)`]][Insert a value to the index. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member12 `insert(Iterator, Iterator)`]][Insert a range of values to the index. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member13 `insert(Range const &)`]][Insert a range of values to the index. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member14 `remove(value_type const &)`]][Remove a value from the container. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member15 `remove(Iterator, Iterator)`]][Remove a range of values from the container. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member16 `remove(Range const &)`]][Remove a range of values from the container. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member17 `spatial_query(Predicates const &, OutIter)`]][Finds values meeting spatial predicates, e.g. intersecting some Box. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member18 `nearest_query(DistancesPredicates const &, value_type &)`]][Finds one value meeting distances predicates, e.g. nearest to some Point. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member19 `nearest_query(DistancesPredicates const &, Predicates const &, value_type &)`]][Finds one value meeting distances predicates and spatial predicates, e.g. nearest to some Point and intersecting some Box. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member20 `nearest_query(DistancesPredicates const &, size_t, OutIter)`]][Finds k values meeting distances predicates, e.g. k nearest values to some Point. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member21 `nearest_query(DistancesPredicates const &, size_t, Predicates const &, OutIter)`]][Finds k values meeting distances predicates and spatial predicates, e.g. k nearest values to some Point and intersecting some Box. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member22 `size()`]][Returns the number of stored values. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member23 `empty()`]][Query if the container is empty. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member24 `clear()`]][Removes all values stored in the container. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member25 `box()`]][Returns the box containing all values stored in the container. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member26 `count(ValueOrIndexable const &)`]][Count Values or Indexables stored in the container. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member27 `parameters()`]][Returns parameters. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member28 `translator()`]][Returns the translator object. ]]
+[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member29 `get_allocator()`]][Returns allocator used by the rtree. ]]
+]
+
+[br]
+[section:member0 rtree()]
+The constructor. [heading Synopsis]
+``rtree(parameters_type parameters = parameters_type(), translator_type const & translator = translator_type())``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `parameters_type` ][ `parameters` ][]]
+[[ `translator_type const &` ][ `translator` ][]]
+]
+[heading Throws] 
+If allocator default constructor throws.
+
+[endsect]
+[br]
+
+[section:member1 rtree(parameters_type, translator_type const &, allocator_type)]
+The constructor. [heading Synopsis]
+``rtree(parameters_type parameters,
+      translator_type const & translator,
+      allocator_type allocator)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `parameters_type` ][ `parameters` ][The parameters object. ]]
+[[ `translator_type const &` ][ `translator` ][The translator object. ]]
+[[ `allocator_type` ][ `allocator` ][The allocator object.]]
+]
+[heading Throws] 
+If allocator copy constructor throws.
+
+[endsect]
+[br]
+
+[section:member2 rtree(Iterator, Iterator)]
+The constructor. [heading Synopsis]
+``template<typename Iterator>
+rtree(Iterator first,
+      Iterator last,
+      parameters_type parameters = parameters_type(),
+      translator_type const & translator = translator_type(),
+      allocator_type allocator = allocator_type())``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `Iterator` ][ `first` ][The beginning of the range of Values. ]]
+[[ `Iterator` ][ `last` ][The end of the range of Values. ]]
+[[ `parameters_type` ][ `parameters` ][The parameters object. ]]
+[[ `translator_type const &` ][ `translator` ][The translator object. ]]
+[[ `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.
+
+[endsect]
+[br]
+
+[section:member3 rtree(Range const &)]
+The constructor. [heading Synopsis]
+``template<typename Range>
+rtree(Range const & rng,
+      parameters_type parameters = parameters_type(),
+      translator_type const & translator = translator_type(),
+      allocator_type allocator = allocator_type())``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `Range const &` ][ `rng` ][The range of Values. ]]
+[[ `parameters_type` ][ `parameters` ][The parameters object. ]]
+[[ `translator_type const &` ][ `translator` ][The translator object. ]]
+[[ `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.
+
+[endsect]
+[br]
+
+[section:member4 ~rtree()]
+The destructor. [heading Synopsis]
+``~rtree()``
+
+[heading Throws] 
+Nothing.
+
+[endsect]
+[br]
+
+[section:member5 rtree(rtree const &)]
+The copy constructor. [heading Description]
+It uses parameters, translator and allocator from the source tree.[heading Synopsis]
+``rtree(rtree const & src)``
+
+[heading Parameters]
+[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.
+
+[endsect]
+[br]
+
+[section:member6 rtree(rtree const &, allocator_type const &)]
+The copy constructor. [heading Description]
+It uses Parameters and translator from the source tree.[heading Synopsis]
+``rtree(rtree const & src, allocator_type const & allocator)``
+
+[heading Parameters]
+[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.
+
+[endsect]
+[br]
+
+[section:member7 rtree(rtree &&)]
+The moving constructor. [heading Description]
+It uses parameters, translator and allocator from the source tree.[heading Synopsis]
+``rtree(rtree && src)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree &&` ][ `src` ][The rtree which content will be moved.]]
+]
+[heading Throws] 
+If allocator move constructor throws.
+
+[endsect]
+[br]
+
+[section:member8 operator=(const rtree &)]
+The assignment operator. [heading Description]
+It uses parameters and translator from the source tree.[heading Synopsis]
+``rtree & operator=(const rtree & src)``
+
+[heading Parameters]
+[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.
+
+[endsect]
+[br]
+
+[section:member9 operator=(rtree &&)]
+The moving assignment. [heading Description]
+It uses parameters and translator from the source tree.[heading Synopsis]
+``rtree & operator=(rtree && src)``
+
+[heading Parameters]
+[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.
+
+[endsect]
+[br]
+
+[section:member10 swap(rtree &)]
+Swaps contents of two rtrees. [heading Description]
+Parameters, translator and allocators are swapped as well.[heading Synopsis]
+``void swap(rtree & other)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree &` ][ `other` ][The rtree which content will be swapped with this rtree content.]]
+]
+[heading Throws] 
+If allocators swap throws.
+
+[endsect]
+[br]
+
+[section:member11 insert(value_type const &)]
+Insert a value to the index. [heading Synopsis]
+``void insert(value_type const & value)``
+
+[heading Parameters]
+[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.
+
+[endsect]
+[br]
+
+[section:member12 insert(Iterator, Iterator)]
+Insert a range of values to the index. [heading Synopsis]
+``template<typename Iterator>
+void insert(Iterator first, Iterator last)``
+
+[heading Parameters]
+[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.
+
+[endsect]
+[br]
+
+[section:member13 insert(Range const &)]
+Insert a range of values to the index. [heading Synopsis]
+``template<typename Range>
+void insert(Range const & rng)``
+
+[heading Parameters]
+[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.
+
+[endsect]
+[br]
+
+[section:member14 remove(value_type const &)]
+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]
+``size_type remove(value_type const & value)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `value_type const &` ][ `value` ][The value which will be removed from the container.]]
+]
+[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.
+
+[endsect]
+[br]
+
+[section:member15 remove(Iterator, Iterator)]
+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]
+``template<typename Iterator>
+size_type remove(Iterator first, Iterator last)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `Iterator` ][ `first` ][The beginning of the range of values. ]]
+[[ `Iterator` ][ `last` ][The end of the range of values.]]
+]
+[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.
+
+[endsect]
+[br]
+
+[section:member16 remove(Range const &)]
+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]
+``template<typename Range>
+size_type remove(Range const & rng)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `Range const &` ][ `rng` ][The range of values.]]
+]
+[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.
+
+[endsect]
+[br]
+
+[section:member17 spatial_query(Predicates const &, OutIter)]
+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]
+``template<typename Predicates, typename OutIter>
+size_type spatial_query(Predicates const & pred, OutIter out_it)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `Predicates const &` ][ `pred` ][The spatial predicates or a Geometry. ]]
+[[ `OutIter` ][ `out_it` ][The output iterator of the result range. E.g. an iterator generated by std::back_inserter(container)]]
+]
+[heading Returns]
+The number of values found.
+[heading Throws] 
+If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
+
+[endsect]
+[br]
+
+[section:member18 nearest_query(DistancesPredicates const &, value_type &)]
+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]
+``template<typename DistancesPredicates>
+size_type nearest_query(DistancesPredicates const & dpred, value_type & v)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `DistancesPredicates const &` ][ `dpred` ][The distances predicates or a Point.]]
+[[ `value_type &` ][ `v` ][The reference to the object which will contain the result.]]
+]
+[heading Returns]
+The number of values found.
+[heading Throws] 
+If Value copy constructor or copy assignment throws.
+
+[endsect]
+[br]
+
+[section:member19 nearest_query(DistancesPredicates const &, Predicates const &, value_type &)]
+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).
+
+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]
+``template<typename DistancesPredicates, typename Predicates>
+size_type nearest_query(DistancesPredicates const & dpred,
+                        Predicates const & pred,
+                        value_type & v)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `DistancesPredicates const &` ][ `dpred` ][The distances predicates or a Point. ]]
+[[ `Predicates const &` ][ `pred` ][The spatial predicates or a Geometry ]]
+[[ `value_type &` ][ `v` ][The reference to the object which will contain the result.]]
+]
+[heading Returns]
+The number of values found.
+[heading Throws] 
+If Value copy constructor or copy assignment throws.
+
+[endsect]
+[br]
+
+[section:member20 nearest_query(DistancesPredicates const &, size_t, OutIter)]
+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]
+``template<typename DistancesPredicates, typename OutIter>
+size_type nearest_query(DistancesPredicates const & dpred,
+                        size_t k,
+                        OutIter out_it)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `DistancesPredicates const &` ][ `dpred` ][The distances predicates or a Point. ]]
+[[ `size_t` ][ `k` ][The max number of values. ]]
+[[ `OutIter` ][ `out_it` ][The output iterator of the result range. E.g. a back_insert_iterator.]]
+]
+[heading Returns]
+The number of values found.
+[heading Throws] 
+If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
+
+[endsect]
+[br]
+
+[section:member21 nearest_query(DistancesPredicates const &, size_t, Predicates const &, OutIter)]
+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).
+
+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]
+``template<typename DistancesPredicates,
+         typename Predicates,
+         typename OutIter>
+size_type nearest_query(DistancesPredicates const & dpred,
+                        size_t k,
+                        Predicates const & pred,
+                        OutIter out_it)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `DistancesPredicates const &` ][ `dpred` ][The distances predicates or a Point ]]
+[[ `size_t` ][ `k` ][The max number of values. ]]
+[[ `Predicates const &` ][ `pred` ][The spatial predicates or a Geometry. ]]
+[[ `OutIter` ][ `out_it` ][The output iterator of the result range. E.g. a back_insert_iterator.]]
+]
+[heading Returns]
+The number of values found.
+[heading Throws] 
+If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
+
+[endsect]
+[br]
+
+[section:member22 size()]
+Returns the number of stored values. [heading Synopsis]
+``size_type size()``
+
+[heading Returns]
+The number of stored values.
+[heading Throws] 
+Nothing.
+
+[endsect]
+[br]
+
+[section:member23 empty()]
+Query if the container is empty. [heading Synopsis]
+``bool empty()``
+
+[heading Returns]
+true if the container is empty.
+[heading Throws] 
+Nothing.
+
+[endsect]
+[br]
+
+[section:member24 clear()]
+Removes all values stored in the container. [heading Synopsis]
+``void clear()``
+
+[heading Throws] 
+Nothing.
+
+[endsect]
+[br]
+
+[section:member25 box()]
+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]
+``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.
+
+[endsect]
+[br]
+
+[section:member26 count(ValueOrIndexable const &)]
+Count Values or Indexables stored in the container. [heading Description]
+For indexable_type it returns the number of values which indexables equals the parameter. For value_type it returns the number of values which equals the parameter.[heading Synopsis]
+``template<typename ValueOrIndexable>
+size_type count(ValueOrIndexable const & vori)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `ValueOrIndexable const &` ][ `vori` ][The value or indexable which will be counted.]]
+]
+[heading Returns]
+The number of values found.
+[heading Throws] 
+Nothing.
+
+[endsect]
+[br]
+
+[section:member27 parameters()]
+Returns parameters. [heading Synopsis]
+``parameters_type const & parameters()``
+
+[heading Returns]
+The parameters object.
+[heading Throws] 
+Nothing.
+
+[endsect]
+[br]
+
+[section:member28 translator()]
+Returns the translator object. [heading Synopsis]
+``translator_type const & translator()``
+
+[heading Returns]
+The translator object.
+[heading Throws] 
+Nothing.
+
+[endsect]
+[br]
+
+[section:member29 get_allocator()]
+Returns allocator used by the rtree. [heading Synopsis]
+``allocator_type get_allocator()``
+
+[heading Returns]
+The allocator.
+[heading Throws] 
+If allocator copy constructor throws.
+
+[endsect]
+[br]
+
+[endsect]
+

Added: sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk
==============================================================================
--- (empty file)
+++ sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk	2013-01-09 13:33:43 EST (Wed, 09 Jan 2013)
@@ -0,0 +1,343 @@
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
+[/ Generated from xml/group__rtree__functions.xml]
+[section:group__rtree__functions Functions related to the rtree (boost::geometry::index::)]
+[table
+[[Function][Description]]
+[[[link geometry_index.r_tree.reference.group__rtree__functions.function0 `insert(rtree<...> &, Value const &)`]][Insert a value to the index. ]]
+[[[link geometry_index.r_tree.reference.group__rtree__functions.function1 `insert(rtree<...> &, Iterator, Iterator)`]][Insert a range of values to the index. ]]
+[[[link geometry_index.r_tree.reference.group__rtree__functions.function2 `insert(rtree<...> &, Range const &)`]][Insert a range of values to the index. ]]
+[[[link geometry_index.r_tree.reference.group__rtree__functions.function3 `remove(rtree<...> &, Value const &)`]][Remove a value from the container. ]]
+[[[link geometry_index.r_tree.reference.group__rtree__functions.function4 `remove(rtree<...> &, Iterator, Iterator)`]][Remove a range of values from the container. ]]
+[[[link geometry_index.r_tree.reference.group__rtree__functions.function5 `remove(rtree<...> &, Range const &)`]][Remove a range of values from the container. ]]
+[[[link geometry_index.r_tree.reference.group__rtree__functions.function6 `spatial_query(rtree<...> const &, Predicates const &, OutIter)`]][Find values meeting spatial predicates. ]]
+[[[link geometry_index.r_tree.reference.group__rtree__functions.function7 `nearest_query(rtree<...> const &, DistancesPredicates const &, Value &)`]][Find the value meeting distances predicates. ]]
+[[[link geometry_index.r_tree.reference.group__rtree__functions.function8 `nearest_query(rtree<...> const &, DistancesPredicates const &, Predicates const &, Value &)`]][Find the value meeting distances and spatial predicates. ]]
+[[[link geometry_index.r_tree.reference.group__rtree__functions.function9 `nearest_query(rtree<...> const &, DistancesPredicates const &, size_t, OutIter)`]][Find k values meeting distances predicates. ]]
+[[[link geometry_index.r_tree.reference.group__rtree__functions.function10 `nearest_query(rtree<...> const &, DistancesPredicates const &, size_t, Predicates const &, OutIter)`]][Find k values meeting distances and spatial predicates. ]]
+[[[link geometry_index.r_tree.reference.group__rtree__functions.function11 `clear(rtree<...> &)`]][Remove all values from the index. ]]
+[[[link geometry_index.r_tree.reference.group__rtree__functions.function12 `size(rtree<...> const &)`]][Get the number of values stored in the index. ]]
+[[[link geometry_index.r_tree.reference.group__rtree__functions.function13 `empty(rtree<...> const &)`]][Query if there are no values stored in the index. ]]
+[[[link geometry_index.r_tree.reference.group__rtree__functions.function14 `box(rtree<...> const &)`]][Get the box containing all stored values or an invalid box if the index has no values. ]]
+]
+
+[section:function0 insert(rtree<...> &, Value const &)]
+Insert a value to the index. [heading Synopsis]
+``template<typename Value,
+         typename Options,
+         typename Translator,
+         typename Allocator>
+void boost::geometry::index::insert(rtree< Value, Options, Translator, Allocator > & tree, Value const & v)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree< Value, Options, Translator, Allocator > &` ][ `tree` ][The spatial index. ]]
+[[ `Value const &` ][ `v` ][The value which will be stored in the index. ]]
+]
+[endsect]
+[br]
+
+[section:function1 insert(rtree<...> &, Iterator, Iterator)]
+Insert a range of values to the index. [heading Synopsis]
+``template<typename Value,
+         typename Options,
+         typename Translator,
+         typename Allocator,
+         typename Iterator>
+void boost::geometry::index::insert(rtree< Value, Options, Translator, Allocator > & tree,
+                                    Iterator first,
+                                    Iterator last)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree< Value, Options, Translator, Allocator > &` ][ `tree` ][The spatial index. ]]
+[[ `Iterator` ][ `first` ][The beginning of the range of values. ]]
+[[ `Iterator` ][ `last` ][The end of the range of values. ]]
+]
+[endsect]
+[br]
+
+[section:function2 insert(rtree<...> &, Range const &)]
+Insert a range of values to the index. [heading Synopsis]
+``template<typename Value,
+         typename Options,
+         typename Translator,
+         typename Allocator,
+         typename Range>
+void boost::geometry::index::insert(rtree< Value, Options, Translator, Allocator > & tree, Range const & rng)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree< Value, Options, Translator, Allocator > &` ][ `tree` ][The spatial index. ]]
+[[ `Range const &` ][ `rng` ][The range of values. ]]
+]
+[endsect]
+[br]
+
+[section:function3 remove(rtree<...> &, Value const &)]
+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]
+``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]
+[table 
+[[Type][Name][Description]]
+[[ `rtree< Value, Options, Translator, Allocator > &` ][ `tree` ][The spatial index. ]]
+[[ `Value const &` ][ `v` ][The value which will be removed from the index.]]
+]
+[heading Returns]
+1 if value was removed, 0 otherwise. 
+[endsect]
+[br]
+
+[section:function4 remove(rtree<...> &, Iterator, Iterator)]
+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]
+``template<typename Value,
+         typename Options,
+         typename Translator,
+         typename Allocator,
+         typename Iterator>
+rtree<Value, Options, Translator, Allocator>::size_type boost::geometry::index::remove(rtree< Value, Options, Translator, Allocator > & tree,
+                                                                                       Iterator first,
+                                                                                       Iterator last)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree< Value, Options, Translator, Allocator > &` ][ `tree` ][The spatial index. ]]
+[[ `Iterator` ][ `first` ][The beginning of the range of values. ]]
+[[ `Iterator` ][ `last` ][The end of the range of values.]]
+]
+[heading Returns]
+The number of removed values. 
+[endsect]
+[br]
+
+[section:function5 remove(rtree<...> &, Range const &)]
+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]
+``template<typename Value,
+         typename Options,
+         typename Translator,
+         typename Allocator,
+         typename Range>
+rtree<Value, Options, Translator, Allocator>::size_type boost::geometry::index::remove(rtree< Value, Options, Translator, Allocator > & tree, Range const & rng)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree< Value, Options, Translator, Allocator > &` ][ `tree` ][The spatial index. ]]
+[[ `Range const &` ][ `rng` ][The range of values.]]
+]
+[heading Returns]
+The number of removed values. 
+[endsect]
+[br]
+
+[section:function6 spatial_query(rtree<...> const &, Predicates const &, OutIter)]
+Find values meeting spatial predicates. [heading Synopsis]
+``template<typename Value,
+         typename Options,
+         typename Translator,
+         typename Allocator,
+         typename Predicates,
+         typename OutIter>
+size_t boost::geometry::index::spatial_query(rtree< Value, Options, Translator, Allocator > const & tree,
+                                             Predicates const & pred,
+                                             OutIter out_it)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index. ]]
+[[ `Predicates const &` ][ `pred` ][The spatial predicates. ]]
+[[ `OutIter` ][ `out_it` ][The output iterator of the result range.]]
+]
+[heading Returns]
+The number of found values. 
+[endsect]
+[br]
+
+[section:function7 nearest_query(rtree<...> const &, DistancesPredicates const &, Value &)]
+Find the value meeting distances predicates. [heading Synopsis]
+``template<typename Value,
+         typename Options,
+         typename Translator,
+         typename Allocator,
+         typename DistancesPredicates>
+size_t boost::geometry::index::nearest_query(rtree< Value, Options, Translator, Allocator > const & tree,
+                                             DistancesPredicates const & dpred,
+                                             Value & v)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index. ]]
+[[ `DistancesPredicates const &` ][ `dpred` ][The distances predicates. ]]
+[[ `Value &` ][ `v` ][The result.]]
+]
+[heading Returns]
+The number of found values. 
+[endsect]
+[br]
+
+[section:function8 nearest_query(rtree<...> const &, DistancesPredicates const &, Predicates const &, Value &)]
+Find the value meeting distances and spatial predicates. [heading Synopsis]
+``template<typename Value,
+         typename Options,
+         typename Translator,
+         typename Allocator,
+         typename DistancesPredicates,
+         typename Predicates>
+size_t boost::geometry::index::nearest_query(rtree< Value, Options, Translator, Allocator > const & tree,
+                                             DistancesPredicates const & dpred,
+                                             Predicates const & pred,
+                                             Value & v)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index. ]]
+[[ `DistancesPredicates const &` ][ `dpred` ][The distances predicates. ]]
+[[ `Predicates const &` ][ `pred` ][The spatial predicates. ]]
+[[ `Value &` ][ `v` ][The result.]]
+]
+[heading Returns]
+The number of found values. 
+[endsect]
+[br]
+
+[section:function9 nearest_query(rtree<...> const &, DistancesPredicates const &, size_t, OutIter)]
+Find k values meeting distances predicates. [heading Synopsis]
+``template<typename Value,
+         typename Options,
+         typename Translator,
+         typename Allocator,
+         typename DistancesPredicates,
+         typename OutIter>
+size_t boost::geometry::index::nearest_query(rtree< Value, Options, Translator, Allocator > const & tree,
+                                             DistancesPredicates const & dpred,
+                                             size_t k,
+                                             OutIter out_it)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index. ]]
+[[ `DistancesPredicates const &` ][ `dpred` ][The distances predicates. ]]
+[[ `size_t` ][ `k` ][The max number of values. ]]
+[[ `OutIter` ][ `out_it` ][The output iterator of the result range.]]
+]
+[heading Returns]
+The number of found values. 
+[endsect]
+[br]
+
+[section:function10 nearest_query(rtree<...> const &, DistancesPredicates const &, size_t, Predicates const &, OutIter)]
+Find k values meeting distances and spatial predicates. [heading Synopsis]
+``template<typename Value,
+         typename Options,
+         typename Translator,
+         typename Allocator,
+         typename DistancesPredicates,
+         typename Predicates,
+         typename OutIter>
+size_t boost::geometry::index::nearest_query(rtree< Value, Options, Translator, Allocator > const & tree,
+                                             DistancesPredicates const & dpred,
+                                             size_t k,
+                                             Predicates const & pred,
+                                             OutIter out_it)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index. ]]
+[[ `DistancesPredicates const &` ][ `dpred` ][The distances predicates. ]]
+[[ `size_t` ][ `k` ][The max number of values. ]]
+[[ `Predicates const &` ][ `pred` ][The spatial predicates. ]]
+[[ `OutIter` ][ `out_it` ][The output iterator of the result range.]]
+]
+[heading Returns]
+The number of found values. 
+[endsect]
+[br]
+
+[section:function11 clear(rtree<...> &)]
+Remove all values from the index. [heading Synopsis]
+``template<typename Value,
+         typename Options,
+         typename Translator,
+         typename Allocator>
+void boost::geometry::index::clear(rtree< Value, Options, Translator, Allocator > & tree)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree< Value, Options, Translator, Allocator > &` ][ `tree` ][The spatial index. ]]
+]
+[endsect]
+[br]
+
+[section:function12 size(rtree<...> const &)]
+Get the number of values stored in the index. [heading Synopsis]
+``template<typename Value,
+         typename Options,
+         typename Translator,
+         typename Allocator>
+size_t boost::geometry::index::size(rtree< Value, Options, Translator, Allocator > const & tree)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index.]]
+]
+[heading Returns]
+The number of values stored in the index. 
+[endsect]
+[br]
+
+[section:function13 empty(rtree<...> const &)]
+Query if there are no values stored in the index. [heading Synopsis]
+``template<typename Value,
+         typename Options,
+         typename Translator,
+         typename Allocator>
+bool boost::geometry::index::empty(rtree< Value, Options, Translator, Allocator > const & tree)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index.]]
+]
+[heading Returns]
+true if there are no values in the index. 
+[endsect]
+[br]
+
+[section:function14 box(rtree<...> const &)]
+Get the box containing all stored values or an invalid box if the index has no values. [heading Synopsis]
+``template<typename Value,
+         typename Options,
+         typename Translator,
+         typename Allocator>
+rtree<Value, Options, Translator, Allocator>::box_type boost::geometry::index::box(rtree< Value, Options, Translator, Allocator > const & tree)``
+
+[heading Parameters]
+[table 
+[[Type][Name][Description]]
+[[ `rtree< Value, Options, Translator, Allocator > const &` ][ `tree` ][The spatial index.]]
+]
+[heading Returns]
+The box containing all stored values or an invalid box. 
+[endsect]
+[br]
+
+[endsect]
+

Modified: sandbox-branches/geometry/index/test/static_vector.cpp
==============================================================================
--- sandbox-branches/geometry/index/test/static_vector.cpp	(original)
+++ sandbox-branches/geometry/index/test/static_vector.cpp	2013-01-09 13:33:43 EST (Wed, 09 Jan 2013)
@@ -78,14 +78,10 @@
     BOOST_CHECK(s.size() == n);
     BOOST_CHECK(s.capacity() == N);
     BOOST_CHECK_THROW( s.at(n), std::out_of_range );
-    if ( 1 < n )
+    if ( !boost::has_trivial_constructor<T>::value )
     {
-        s[0] = T(10);
-        BOOST_CHECK(T(10) == s[0]);
-        BOOST_CHECK(T(10) == s.at(0));
-        s.at(1) = T(20);
-        BOOST_CHECK(T(20) == s[1]);
-        BOOST_CHECK(T(20) == s.at(1));
+        for ( size_t i = 0 ; i < n ; ++i )
+            BOOST_CHECK(T() == s[i]);
     }
 }
 
@@ -120,14 +116,11 @@
     BOOST_CHECK(s.size() == n);
     BOOST_CHECK(s.capacity() == N);
     BOOST_CHECK_THROW( s.at(n), std::out_of_range );
-    if ( 1 < n )
+
+    if ( !boost::has_trivial_constructor<T>::value )
     {
-        s[0] = T(10);
-        BOOST_CHECK(T(10) == s[0]);
-        BOOST_CHECK(T(10) == s.at(0));
-        s.at(1) = T(20);
-        BOOST_CHECK(T(20) == s[1]);
-        BOOST_CHECK(T(20) == s.at(1));
+        for ( size_t i = 0 ; i < n ; ++i )
+            BOOST_CHECK(T() == s[i]);
     }
 }