From a90b56de261db5bb21d1a79ae05be36ab71e4ffd Mon Sep 17 00:00:00 2001
From: Adam Wulkiewicz
Date: Wed, 6 Feb 2013 20:56:29 +0000
Subject: [PATCH] boost::container::vector used in dynamic nodes.
detail::static_vector renamed to detail::varray. Added Alloc parameter to
varray. rtree::envelope() renamed to rtree::bounds(). Tests moddified. Docs
tweaked.
[SVN r82766]
---
doc/generated/rtree.qbk | 106 +-
doc/generated/rtree_functions.qbk | 10 +-
doc/generated/translator_index.qbk | 3 +-
doc/html/geometry_index/introduction.html | 2 +-
doc/html/geometry_index/r_tree.html | 14 +-
.../r_tree/creation_and_modification.html | 46 +-
.../geometry_index/r_tree/introduction.html | 35 +-
doc/html/geometry_index/r_tree/queries.html | 34 +-
doc/html/geometry_index/r_tree/reference.html | 1099 +++++++----------
.../r_tree/rtree_quickstart.html | 4 +-
doc/html/index.html | 4 +-
doc/rtree/creation.qbk | 18 +-
doc/rtree/introduction.qbk | 4 +
doc/rtree/query.qbk | 16 +-
.../detail/rtree/node/node_d_mem_dynamic.hpp | 8 +-
.../detail/rtree/node/node_d_mem_static.hpp | 27 +-
.../detail/rtree/node/node_s_mem_dynamic.hpp | 6 +-
.../detail/rtree/node/node_s_mem_static.hpp | 13 +-
.../index/detail/rtree/visitors/insert.hpp | 2 +-
.../detail/{static_vector.hpp => varray.hpp} | 67 +-
include/boost/geometry/index/rtree.hpp | 84 +-
test/rtree/rtree_exceptions.cpp | 40 +-
test/rtree/test_rtree.hpp | 49 +-
test/rtree/test_rtree_exceptions.hpp | 8 +-
test/rtree/test_throwing.hpp | 18 +-
tests/additional_speed.cpp | 2 +-
26 files changed, 699 insertions(+), 1020 deletions(-)
rename include/boost/geometry/index/detail/{static_vector.hpp => varray.hpp} (94%)
diff --git a/doc/generated/rtree.qbk b/doc/generated/rtree.qbk
index 5dcc7d03d..b00bb7df3 100644
--- a/doc/generated/rtree.qbk
+++ b/doc/generated/rtree.qbk
@@ -70,7 +70,7 @@ The Translator translates from Value to Indexable each time r-tree requires it.
[[[#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d] `allocator_type`][The type of allocator used by the container. ]]
[[[#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6] `size_type`][Unsigned integral type used by the container. ]]
[[[#classboost_1_1geometry_1_1index_1_1rtree_1ac011da09678f034a7fab487a9b973bfc] `indexable_type`][The Indexable type to which Value is translated. ]]
-[[[#classboost_1_1geometry_1_1index_1_1rtree_1a2803990c71c40e6770744d29e5bbd093] `envelope_type`][The Box type used by the R-tree. ]]
+[[[#classboost_1_1geometry_1_1index_1_1rtree_1a653555282525601512c3b1bed1e9590f] `bounds_type`][The Box type used by the R-tree. ]]
]
[heading Constructor(s) and destructor]
@@ -89,31 +89,31 @@ The Translator translates from Value to Indexable each time r-tree requires it.
[heading Member(s)]
[table
-[[Modifier][Function][Description]]
-[[][[link classboost_1_1geometry_1_1index_1_1rtree_1ab823a214501cb0f9fd00ba12a1ade179 `operator=(const rtree &)`]][The assignment operator. ]]
-[[][[link classboost_1_1geometry_1_1index_1_1rtree_1a44bd4edee49db92c18b6bbbba77b42be `operator=(rtree &&)`]][The moving assignment. ]]
-[[][[link classboost_1_1geometry_1_1index_1_1rtree_1aad0285d25f96341a8dd6cc22feb3bd73 `swap(rtree &)`]][Swaps contents of two rtrees. ]]
-[[][[link classboost_1_1geometry_1_1index_1_1rtree_1af6d5bd81e46cb4ff89277c753133664c `insert(value_type const &)`]][Insert a value to the index. ]]
-[[][[link classboost_1_1geometry_1_1index_1_1rtree_1a5263a3faac7b4f0090d4ad1d44cc540d `insert(Iterator, Iterator)`]][Insert a range of values to the index. ]]
-[[][[link classboost_1_1geometry_1_1index_1_1rtree_1abb624abd9268b41e815d40342b2634c2 `insert(Range const &)`]][Insert a range of values to the index. ]]
-[[][[link classboost_1_1geometry_1_1index_1_1rtree_1af6ca6909354a997f89411ef40ea5688a `remove(value_type const &)`]][Remove a value from the container. ]]
-[[][[link classboost_1_1geometry_1_1index_1_1rtree_1a6e9123114697d65b16ebc49cd5371fbd `remove(Iterator, Iterator)`]][Remove a range of values from the container. ]]
-[[][[link classboost_1_1geometry_1_1index_1_1rtree_1a5a57bb93b0b2d7ea1c659e925f918e9c `remove(Range const &)`]][Remove a range of values from the container. ]]
-[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a25ce2ead0e8a2d270105f4958237e949 `query(Predicates const &, OutIter)`]][Finds values meeting passed predicates e.g. nearest to some Point and/or intersecting some Box. ]]
-[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1abd965047110c9f8ef6ff097e97487312 `query(Predicates const &, value_type &)`]][Finds value meeting passed predicates e.g. nearest to some Point and intersecting some Box. ]]
-[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a930bf17d595a91d8ae924383a0387920 `spatial_query(Predicates const &, OutIter)`]][Finds values meeting spatial predicates, e.g. intersecting some Box. ]]
-[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a788295b315bd0ddeb93b1cc050fdf909 `nearest_query(DistancesPredicates const &, value_type &)`]][Finds one value meeting distances predicates, e.g. nearest to some Point. ]]
-[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a6552331dca4d67647ef2a03bd0fbedcc `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. ]]
-[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a3101652211c9f2d6ed8626dae6ff5f9d `nearest_query(DistancesPredicates const &, size_type, OutIter)`]][Finds k values meeting distances predicates, e.g. k nearest values to some Point. ]]
-[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a31c23b87b01f12282ef0df6404ab7301 `nearest_query(DistancesPredicates const &, size_type, Predicates const &, OutIter)`]][Finds k values meeting distances predicates and spatial predicates, e.g. k nearest values to some Point and intersecting some Box. ]]
-[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a89561a834563f2ed6fc782bad16143fd `size()`]][Returns the number of stored values. ]]
-[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1ae889567443b0ba0dbdb975564c55804c `empty()`]][Query if the container is empty. ]]
-[[][[link classboost_1_1geometry_1_1index_1_1rtree_1ae6027e42d28a4bf93e74b055c79e6b09 `clear()`]][Removes all values stored in the container. ]]
-[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a131c273b6fc7e1c6d62cc5ebd015e77e `envelope()`]][Returns the box able to contain all values stored in the container. ]]
-[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a17fce1fac81f6460d2c3a5744f4963ee `count(ValueOrIndexable const &)`]][Count Values or Indexables stored in the container. ]]
-[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a18910715f67608ff010556ac41f51606 `parameters()`]][Returns parameters. ]]
-[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1afc7e9a4bd53a58552c17c1e7cb997258 `translator()`]][Returns the translator object. ]]
-[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a1eeb303253f4cabe3a89a82ed41247ff `get_allocator()`]][Returns allocator used by the rtree. ]]
+[[Function][Description]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1ab823a214501cb0f9fd00ba12a1ade179 `operator=(const rtree &)`]][The assignment operator. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a44bd4edee49db92c18b6bbbba77b42be `operator=(rtree &&)`]][The moving assignment. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1aad0285d25f96341a8dd6cc22feb3bd73 `swap(rtree &)`]][Swaps contents of two rtrees. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1af6d5bd81e46cb4ff89277c753133664c `insert(value_type const &)`]][Insert a value to the index. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a5263a3faac7b4f0090d4ad1d44cc540d `insert(Iterator, Iterator)`]][Insert a range of values to the index. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1abb624abd9268b41e815d40342b2634c2 `insert(Range const &)`]][Insert a range of values to the index. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1af6ca6909354a997f89411ef40ea5688a `remove(value_type const &)`]][Remove a value from the container. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a6e9123114697d65b16ebc49cd5371fbd `remove(Iterator, Iterator)`]][Remove a range of values from the container. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a5a57bb93b0b2d7ea1c659e925f918e9c `remove(Range const &)`]][Remove a range of values from the container. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a25ce2ead0e8a2d270105f4958237e949 `query(Predicates const &, OutIter)`]][Finds values meeting passed predicates e.g. nearest to some Point and/or intersecting some Box. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1abd965047110c9f8ef6ff097e97487312 `query(Predicates const &, value_type &)`]][Finds value meeting passed predicates e.g. nearest to some Point and intersecting some Box. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a930bf17d595a91d8ae924383a0387920 `spatial_query(Predicates const &, OutIter)`]][Finds values meeting spatial predicates, e.g. intersecting some Box. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a788295b315bd0ddeb93b1cc050fdf909 `nearest_query(DistancesPredicates const &, value_type &)`]][Finds one value meeting distances predicates, e.g. nearest to some Point. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a6552331dca4d67647ef2a03bd0fbedcc `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 classboost_1_1geometry_1_1index_1_1rtree_1a3101652211c9f2d6ed8626dae6ff5f9d `nearest_query(DistancesPredicates const &, size_type, OutIter)`]][Finds k values meeting distances predicates, e.g. k nearest values to some Point. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a31c23b87b01f12282ef0df6404ab7301 `nearest_query(DistancesPredicates const &, size_type, 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 classboost_1_1geometry_1_1index_1_1rtree_1a89561a834563f2ed6fc782bad16143fd `size()`]][Returns the number of stored values. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1ae889567443b0ba0dbdb975564c55804c `empty()`]][Query if the container is empty. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1ae6027e42d28a4bf93e74b055c79e6b09 `clear()`]][Removes all values stored in the container. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1ace84997927e26d7cdb5aa67f14cdf6cc `bounds()`]][Returns the box able to contain all values stored in the container. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a17fce1fac81f6460d2c3a5744f4963ee `count(ValueOrIndexable const &)`]][Count Values or Indexables stored in the container. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a18910715f67608ff010556ac41f51606 `parameters()`]][Returns parameters. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1afc7e9a4bd53a58552c17c1e7cb997258 `translator()`]][Returns the translator object. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a1eeb303253f4cabe3a89a82ed41247ff `get_allocator()`]][Returns allocator used by the rtree. ]]
]
[#classboost_1_1geometry_1_1index_1_1rtree_1afa64d1b825b06d196b1164aec27c2d7b]
@@ -126,8 +126,7 @@ The constructor.
`rtree``(`[^[link classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a parameters_type]] `parameters` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a parameters_type]]`()``,` [^[link classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91 translator_type]]` const &` `translator` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91 translator_type]]`()``)`
]
-[heading Modifier(s)]
-``explicit ``[heading Parameter(s)]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a parameters_type]]][ `parameters` ][The parameters object. ]]
@@ -210,8 +209,7 @@ The constructor.
[^[link classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d allocator_type]] `allocator` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d allocator_type]]`()``)`
]
-[heading Modifier(s)]
-``explicit ``[heading Parameter(s)]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[`Range const &`][ `rng` ][The range of Values. ]]
@@ -659,8 +657,7 @@ A set of predicates may be generated by:
[^[link classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6 size_type]] `query``(``Predicates const &` `predicates``,` `OutIter` `out_it``)`
]
-[heading Modifier(s)]
-``const ``[heading Parameter(s)]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[`Predicates const &`][ `predicates` ][Predicates. ]]
@@ -738,8 +735,7 @@ A set of predicates may be generated by:
[^[link classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6 size_type]] `query``(``Predicates const &` `predicates``,` [^[link classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb value_type]]` &` `value``)`
]
-[heading Modifier(s)]
-``const ``[heading Parameter(s)]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[`Predicates const &`][ `predicates` ][Predicates. ]]
@@ -790,8 +786,7 @@ Those predicates may be passed together in [^`std::pair`] or [^`boost::tuple`].[
[^[link classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6 size_type]] `spatial_query``(``Predicates const &` `pred``,` `OutIter` `out_it``)`
]
-[heading Modifier(s)]
-``const ``[heading Parameter(s)]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[`Predicates const &`][ `pred` ][The spatial predicates or a Geometry. ]]
@@ -843,8 +838,7 @@ MinRelation and MaxRelation describes bounds and can be generated by following f
[^[link classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6 size_type]] `nearest_query``(``DistancesPredicates const &` `dpred``,` [^[link classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb value_type]]` &` `v``)`
]
-[heading Modifier(s)]
-``const ``[heading Parameter(s)]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[`DistancesPredicates const &`][ `dpred` ][The distances predicates or a Point.]]
@@ -910,8 +904,7 @@ Those predicates may be passed together in [^`std::pair`] or [^`boost::tuple`].[
[^[link classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb value_type]]` &` `v``)`
]
-[heading Modifier(s)]
-``const ``[heading Parameter(s)]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[`DistancesPredicates const &`][ `dpred` ][The distances predicates or a Point. ]]
@@ -961,8 +954,7 @@ MinRelation and MaxRelation describes bounds and can be generated by following f
`OutIter` `out_it``)`
]
-[heading Modifier(s)]
-``const ``[heading Parameter(s)]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[`DistancesPredicates const &`][ `dpred` ][The distances predicates or a Point. ]]
@@ -1032,8 +1024,7 @@ Those predicates may be passed together in [^`std::pair`] or [^`boost::tuple`].[
`OutIter` `out_it``)`
]
-[heading Modifier(s)]
-``const ``[heading Parameter(s)]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[`DistancesPredicates const &`][ `dpred` ][The distances predicates or a Point ]]
@@ -1058,8 +1049,7 @@ Returns the number of stored values.
[^[link classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6 size_type]] `size``()`
]
-[heading Modifier(s)]
-``const ``[heading Returns]
+[heading Returns]
The number of stored values.
[heading Throws]
Nothing.
@@ -1076,8 +1066,7 @@ Query if the container is empty.
`bool` `empty``()`
]
-[heading Modifier(s)]
-``const ``[heading Returns]
+[heading Returns]
true if the container is empty.
[heading Throws]
Nothing.
@@ -1099,19 +1088,18 @@ Nothing.
[endsect]
-[#classboost_1_1geometry_1_1index_1_1rtree_1a131c273b6fc7e1c6d62cc5ebd015e77e]
-[section envelope()]
+[#classboost_1_1geometry_1_1index_1_1rtree_1ace84997927e26d7cdb5aa67f14cdf6cc]
+[section bounds()]
Returns the box able to contain all values stored in the container.
[heading Description]
Returns the box able to contain all values stored in the container. If the container is empty the result of [^`geometry::assign_inverse()`] is returned.[heading Synopsis]
[pre
-[^[link classboost_1_1geometry_1_1index_1_1rtree_1a2803990c71c40e6770744d29e5bbd093 envelope_type]]` const &` `envelope``()`
+[^[link classboost_1_1geometry_1_1index_1_1rtree_1a653555282525601512c3b1bed1e9590f bounds_type]]` const &` `bounds``()`
]
-[heading Modifier(s)]
-``const ``[heading Returns]
+[heading Returns]
The box able to contain all values stored in the container or an invalid box if there are no values in the container.
[heading Throws]
Nothing.
@@ -1129,8 +1117,7 @@ For indexable_type it returns the number of values which indexables equals the p
[^[link classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6 size_type]] `count``(``ValueOrIndexable const &` `vori``)`
]
-[heading Modifier(s)]
-``const ``[heading Parameter(s)]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[`ValueOrIndexable const &`][ `vori` ][The value or indexable which will be counted.]]
@@ -1152,8 +1139,7 @@ Returns parameters.
[^[link classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a parameters_type]]` const &` `parameters``()`
]
-[heading Modifier(s)]
-``const ``[heading Returns]
+[heading Returns]
The parameters object.
[heading Throws]
Nothing.
@@ -1170,8 +1156,7 @@ Returns the translator object.
[^[link classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91 translator_type]]` const &` `translator``()`
]
-[heading Modifier(s)]
-``const ``[heading Returns]
+[heading Returns]
The translator object.
[heading Throws]
Nothing.
@@ -1188,8 +1173,7 @@ Returns allocator used by the rtree.
[^[link classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d allocator_type]] `get_allocator``()`
]
-[heading Modifier(s)]
-``const ``[heading Returns]
+[heading Returns]
The allocator.
[heading Throws]
If allocator copy constructor throws.
diff --git a/doc/generated/rtree_functions.qbk b/doc/generated/rtree_functions.qbk
index 166edb286..c51a47873 100644
--- a/doc/generated/rtree_functions.qbk
+++ b/doc/generated/rtree_functions.qbk
@@ -20,7 +20,7 @@
[[[link group__rtree__functions_1ga0c65d7b29b1edf72f1d236ccf211f63c `clear(rtree<...> &)`]][Remove all values from the index. ]]
[[[link group__rtree__functions_1gaec0b88a9d8b408753e3069134f1598c7 `size(rtree<...> const &)`]][Get the number of values stored in the index. ]]
[[[link group__rtree__functions_1ga459e3d404fec7cbd66794714cbdd129e `empty(rtree<...> const &)`]][Query if there are no values stored in the index. ]]
-[[[link group__rtree__functions_1ga73a9002187db81c57c71f9ec204d57e4 `envelope(rtree<...> const &)`]][Get the box containing all stored values or an invalid box if the index has no values. ]]
+[[[link group__rtree__functions_1gae10fbc3d536235b89aa3cb3641768bca `bounds(rtree<...> const &)`]][Get the box containing all stored values or an invalid box if the index has no values. ]]
]
[#group__rtree__functions_1gac0ac9ed0e01f7494a5a3059e75d3c5cc]
@@ -565,18 +565,18 @@ It calls [^[link classboost_1_1geometry_1_1index_1_1rtree_1ae889567443b0ba0dbdb9
true if there are no values in the index.
[endsect]
-[#group__rtree__functions_1ga73a9002187db81c57c71f9ec204d57e4]
-[section envelope(rtree<...> const &)]
+[#group__rtree__functions_1gae10fbc3d536235b89aa3cb3641768bca]
+[section bounds(rtree<...> const &)]
Get the box containing all stored values or an invalid box if the index has no values.
[heading Description]
-It calls [^[link classboost_1_1geometry_1_1index_1_1rtree_1a131c273b6fc7e1c6d62cc5ebd015e77e rtree::envelope()]].[heading Synopsis]
+It calls [^`rtree::envelope()`].[heading Synopsis]
[pre
`template<``typename Value``,`
`typename Options``,`
`typename Translator``,`
`typename Allocator``>`
-`rtree::box_type const& boost::geometry::index::envelope``(``rtree< Value, Options, Translator, Allocator > const &` `tree``)`
+`rtree::bounds_type const& boost::geometry::index::bounds``(``rtree< Value, Options, Translator, Allocator > const &` `tree``)`
]
[heading Parameter(s)]
diff --git a/doc/generated/translator_index.qbk b/doc/generated/translator_index.qbk
index 12c4725ca..186c971cb 100644
--- a/doc/generated/translator_index.qbk
+++ b/doc/generated/translator_index.qbk
@@ -43,8 +43,7 @@ The constructor.
`index``(``Container const &` `c``)`
]
-[heading Modifier(s)]
-``explicit ``[heading Parameter(s)]
+[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[`Container const &`][ `c` ][The container which stores indexed values. ]]
diff --git a/doc/html/geometry_index/introduction.html b/doc/html/geometry_index/introduction.html
index c00e43835..dd5718dbb 100644
--- a/doc/html/geometry_index/introduction.html
+++ b/doc/html/geometry_index/introduction.html
@@ -3,7 +3,7 @@
Introduction
-
+
diff --git a/doc/html/geometry_index/r_tree.html b/doc/html/geometry_index/r_tree.html
index d8f3103ee..d90bd1ce7 100644
--- a/doc/html/geometry_index/r_tree.html
+++ b/doc/html/geometry_index/r_tree.html
@@ -3,7 +3,7 @@
R-tree
-
+
@@ -36,14 +36,14 @@
parameters
Values may be inserted to the R-tree in many various ways.
Final internal structure of the R-tree depends on algorithms used in the
- insertion process and parameters. The most important is nodes' splitting
+ insertion process and parameters. The most important is nodes' balancing
algorithm. Currently, three well-known types of R-trees may be created.
- Linear - classic R-tree using splitting algorithm of linear complexity
+ Linear - classic R-tree using balancing algorithm of linear complexity
index::rtree< Value,index::linear<32,8>>rt;
- Quadratic - classic R-tree using splitting algorithm of quadratic complexity
+ Quadratic - classic R-tree using balancing algorithm of quadratic complexity
- Splitting algorithm parameters may be passed to the R-tree in run time.
+ Balancing algorithm parameters may be passed to the R-tree in run time.
To use run-time versions of the R-tree one may pass parameters defined
in index::runtime namespace.
R-tree is a tree data structure used for spatial searching. It was proposed
- by Antonin Guttman in 1984 [1] as an expansion of B-tree for multi-dimensional data. It may
+ by Antonin Guttman in 1984 [1] 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].
+ close to some point in space [2].
The R-tree structure is presented on the image below. Each R-tree's node
@@ -51,7 +51,7 @@
The R-tree is a self-balanced data structure. The key part of balancing algorithm
- is node splitting algorithm [3][4]. Each algorithm produces different splits so the internal structure
+ is node splitting algorithm [3][4]. 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
@@ -179,13 +179,13 @@
[4]
Beckmann, N.; Kriegel, H. P.; Schneider, R.; Seeger, B. (1990). The
R*-tree: an efficient and robust access method for points and rectangles
diff --git a/doc/html/geometry_index/r_tree/queries.html b/doc/html/geometry_index/r_tree/queries.html
index 7c642bc32..7a9de8480 100644
--- a/doc/html/geometry_index/r_tree/queries.html
+++ b/doc/html/geometry_index/r_tree/queries.html
@@ -3,7 +3,7 @@
Queries
-
+
@@ -41,10 +41,10 @@
query results into the other R-tree
- Queries returns Values which
- meets some predicates. Currently supported are three types of predicates:
+ Queries returns Values which meets some predicates. Currently
+ supported are three types of predicates:
-
+
spatial predicates - defining relationship between stored Values and
some Geometry,
@@ -60,7 +60,7 @@
For example queries may be used to retrieve Values:
-
+
intersecting some area but not within other area,
@@ -81,7 +81,7 @@
is used as the predicate, this is a default spatial predicate described
in the following section. Following queries returns Values
intersecting some region defined as a Box.
- These three methods are:
+ These three ways are:
Method call
@@ -111,9 +111,9 @@
queries
- Spatial query returns Values which are related somehow to a geometry or
- some number of geometries. Names of spatial predicates corresponds to names
- of Boost.Geometry
+ Spatial query returns Values which are related somehow to
+ a geometry or some number of geometries. Names of spatial predicates corresponds
+ to names of Boost.Geometry
algorithms. Examples of some basic queries may be found in tables below.
The query region and result Values
are orange.
@@ -248,11 +248,12 @@
neighbours queries
- Nearest neighbours queries returns Values
- which are closest to some point in space. Additionally it is possible to
- pass distance predicates in order to define how the distance to the Value should be calculated or minimal
- and maximal distances. The examples of some knn queries may be found in
- the table below. All queries returns 5 closest Values.
+ Nearest neighbours queries returns Values which are closest
+ to some point in space. Additionally it is possible to pass define how
+ the distance to the Value
+ should be calculated or distance predicates defining minimal and maximal
+ distances. The examples of some knn queries may be found in the table below.
+ All queries returns 5 closest Values.
The query point, region and result Values are orange.
@@ -305,7 +306,8 @@
There are three ways of performing knn queries. Following queries returns
- k Values closest to some point in space. For Boxes
+ kValues
+ closest to some point in space. For Boxes
Indexables the distance to the nearest point is calculated
by default.
@@ -440,7 +442,7 @@ must be greater than 10 */
It's possible to use some number of predicates in one query by passing:
This query function performs spatial and k-nearest neighbor searches.
@@ -2672,7 +2558,7 @@ The R-tree spatial index.
are returned. More spatial predicates may be generated by one of the
functions listed below:
This query function performs k-nearest neighbor searches. It allows to
@@ -2900,7 +2777,7 @@ The R-tree spatial index.
are returned. More spatial predicates may be generated by one of the
functions listed below:
Distances predicates may be a Point. In this the case the
@@ -3276,7 +3135,7 @@ The R-tree spatial index.
It is possible to define how distance to Value is calculated. This is
done by passing PointRelation. It can be generated by following functions:
-
+
boost::geometry::index::to_nearest()
- default,
@@ -3293,7 +3152,7 @@ The R-tree spatial index.
distance must be between min_distance and max_distance. This is done
by passing DistancesPredicates which can be generated by following functions:
-
+
boost::geometry::index::unbounded()
- default,
@@ -3312,7 +3171,7 @@ The R-tree spatial index.
MinRelation and MaxRelation describes bounds and can be generated by
following functions:
-
Distances predicates may be a Point. In this the case the
@@ -3442,7 +3292,7 @@ The R-tree spatial index.
It is possible to define how distance to Value is calculated. This is
done by passing PointRelation. It can be generated by following functions:
-
+
boost::geometry::index::to_nearest()
- default,
@@ -3459,7 +3309,7 @@ The R-tree spatial index.
distance must be between min_distance and max_distance. This is done
by passing DistancesPredicates which can be generated by following functions:
-
+
boost::geometry::index::unbounded()
- default,
@@ -3478,7 +3328,7 @@ The R-tree spatial index.
MinRelation and MaxRelation describes bounds and can be generated by
following functions:
-
Distances predicates may be a Point. In this the case the
@@ -3675,7 +3516,7 @@ The R-tree spatial index.
It is possible to define how distance to Value is calculated. This is
done by passing PointRelation. It can be generated by following functions:
-
+
boost::geometry::index::to_nearest()
- default,
@@ -3692,7 +3533,7 @@ The R-tree spatial index.
distance must be between min_distance and max_distance. This is done
by passing DistancesPredicates which can be generated by following functions:
-
+
boost::geometry::index::unbounded()
- default,
@@ -3711,7 +3552,7 @@ The R-tree spatial index.
MinRelation and MaxRelation describes bounds and can be generated by
following functions:
-
Distances predicates may be a Point. In this the case the
@@ -3860,7 +3692,7 @@ The R-tree spatial index.
It is possible to define how distance to Value is calculated. This is
done by passing PointRelation. It can be generated by following functions:
-
+
boost::geometry::index::to_nearest()
- default,
@@ -3877,7 +3709,7 @@ The R-tree spatial index.
distance must be between min_distance and max_distance. This is done
by passing DistancesPredicates which can be generated by following functions:
-
+
boost::geometry::index::unbounded()
- default,
@@ -3896,7 +3728,7 @@ The R-tree spatial index.
MinRelation and MaxRelation describes bounds and can be generated by
following functions:
-
Remove a value from the container. In contrast to the std::set or std::maperase() method this function removes
@@ -5047,7 +4807,7 @@ The R-tree spatial index.
Remove a range of values from the container. In contrast to the std::set or std::maperase() method it doesn't take iterators
@@ -5157,7 +4917,7 @@ The R-tree spatial index.
Remove a range of values from the container. In contrast to the std::set or std::maperase() method it removes values
@@ -5285,7 +5045,7 @@ The R-tree spatial index.
This query function performs spatial and k-nearest neighbor searches.
@@ -5399,7 +5159,7 @@ The R-tree spatial index.
are returned. More spatial predicates may be generated by one of the
functions listed below:
This query function performs k-nearest neighbor searches. It allows to
@@ -5648,7 +5408,7 @@ The R-tree spatial index.
are returned. More spatial predicates may be generated by one of the
functions listed below:
When nearest predicate is passed to the query, k-nearest neighbour search
@@ -8409,7 +8169,7 @@ R*-tree creation algorithm parameters.
is calculated. This is done by passing PointRelation. It can be generated
by following functions:
-
+
boost::geometry::index::to_nearest()
- default,
@@ -8426,7 +8186,7 @@ R*-tree creation algorithm parameters.
must be between min_distance and max_distance. This is done by passing
DistancesPredicates which can be generated by following functions:
-
+
boost::geometry::index::unbounded()
- default,
@@ -8445,7 +8205,7 @@ R*-tree creation algorithm parameters.
MinRelation and MaxRelation describes bounds and can be generated by
following functions:
-