Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r83315 - in sandbox-branches/geometry/index: boost/geometry/index doc/generated doc/html doc/html/geometry_index/r_tree doc/rtree
From: adam.wulkiewicz_at_[hidden]
Date: 2013-03-05 13:26:58

Next message: john_at_[hidden]: "[Boost-commit] svn:boost r83316 - in trunk: boost/math/special_functions libs/math/test"
Previous message: oliver.kowalke_at_[hidden]: "[Boost-commit] svn:boost r83314 - trunk/libs/coroutine/doc"

Author: awulkiew
Date: 2013-03-05 13:26:56 EST (Tue, 05 Mar 2013)
New Revision: 83315
URL: http://svn.boost.org/trac/boost/changeset/83315

Log:
rtree: cosmetic changes
allocator passed to ctors by const ref instead of a value,
some parameters names changed,
docs updated.
Text files modified:
   sandbox-branches/geometry/index/boost/geometry/index/rtree.hpp | 66 ++++++++++----------
   sandbox-branches/geometry/index/doc/generated/equal_to.qbk | 2
   sandbox-branches/geometry/index/doc/generated/indexable.qbk | 2
   sandbox-branches/geometry/index/doc/generated/rtree.qbk | 64 ++++++++++----------
   sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/creation_and_modification.html | 17 +++--
   sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html | 128 ++++++++++++++++++++++-----------------
   sandbox-branches/geometry/index/doc/html/index.html | 2
   sandbox-branches/geometry/index/doc/rtree/creation.qbk | 9 +-
   8 files changed, 156 insertions(+), 134 deletions(-)

Modified: sandbox-branches/geometry/index/boost/geometry/index/rtree.hpp
==============================================================================
--- sandbox-branches/geometry/index/boost/geometry/index/rtree.hpp (original)
+++ sandbox-branches/geometry/index/boost/geometry/index/rtree.hpp 2013-03-05 13:26:56 EST (Tue, 05 Mar 2013)
@@ -155,46 +155,46 @@
 /*!
 \brief The constructor.

- \param parameters The parameters object.
- \param indexable_getter The function object extracting Indexable from Value.
- \param equal_to The function object comparing Values.
+ \param parameters The parameters object.
+ \param getter The function object extracting Indexable from Value.
+ \param equal The function object comparing Values.

 \par Throws
 If allocator default constructor throws.
 */
 inline explicit rtree(parameters_type const& parameters = parameters_type(),
- IndexableGetter const& indexable_getter = IndexableGetter(),
- EqualTo const& equal_to = EqualTo())
- : m_members(indexable_getter, equal_to, parameters)
+ indexable_getter const& getter = indexable_getter(),
+ value_equal const& equal = value_equal())
+ : m_members(getter, equal, parameters)
 {}

 /*!
 \brief The constructor.

- \param parameters The parameters object.
- \param indexable_getter The function object extracting Indexable from Value.
- \param equal_to The function object comparing Values.
- \param allocator The allocator object.
+ \param parameters The parameters object.
+ \param getter The function object extracting Indexable from Value.
+ \param equal The function object comparing Values.
+ \param allocator The allocator object.

 \par Throws
 If allocator copy constructor throws.
 */
 inline rtree(parameters_type const& parameters,
- IndexableGetter const& indexable_getter,
- EqualTo const& equal_to,
- allocator_type allocator)
- : m_members(indexable_getter, equal_to, parameters, allocator)
+ indexable_getter const& getter,
+ value_equal const& equal,
+ allocator_type const& allocator)
+ : m_members(getter, equal, parameters, allocator)
 {}

 /*!
 \brief The constructor.

- \param first The beginning of the range of Values.
- \param last The end of the range of Values.
- \param parameters The parameters object.
- \param indexable_getter The function object extracting Indexable from Value.
- \param equal_to The function object comparing Values.
- \param allocator The allocator object.
+ \param first The beginning of the range of Values.
+ \param last The end of the range of Values.
+ \param parameters The parameters object.
+ \param getter The function object extracting Indexable from Value.
+ \param equal_to The function object comparing Values.
+ \param allocator The allocator object.

 \par Throws
 \li If allocator copy constructor throws.
@@ -205,10 +205,10 @@
 template<typename Iterator>
 inline rtree(Iterator first, Iterator last,
 parameters_type const& parameters = parameters_type(),
- IndexableGetter const& indexable_getter = IndexableGetter(),
- EqualTo const& equal_to = EqualTo(),
- allocator_type allocator = allocator_type())
- : m_members(indexable_getter, equal_to, parameters, allocator)
+ indexable_getter const& getter = indexable_getter(),
+ value_equal const& equal = value_equal(),
+ allocator_type const& allocator = allocator_type())
+ : m_members(getter, equal, parameters, allocator)
 {
 try
 {
@@ -224,11 +224,11 @@
 /*!
 \brief The constructor.

- \param rng The range of Values.
- \param parameters The parameters object.
- \param indexable_getter The function object extracting Indexable from Value.
- \param equal_to The function object comparing Values.
- \param allocator The allocator object.
+ \param rng The range of Values.
+ \param parameters The parameters object.
+ \param getter The function object extracting Indexable from Value.
+ \param equal The function object comparing Values.
+ \param allocator The allocator object.

 \par Throws
 \li If allocator copy constructor throws.
@@ -239,10 +239,10 @@
 template<typename Range>
 inline explicit rtree(Range const& rng,
 parameters_type const& parameters = parameters_type(),
- IndexableGetter const& indexable_getter = IndexableGetter(),
- EqualTo const& equal_to = EqualTo(),
- allocator_type allocator = allocator_type())
- : m_members(indexable_getter, equal_to, parameters, allocator)
+ indexable_getter const& getter = indexable_getter(),
+ value_equal const& equal = value_equal(),
+ allocator_type const& allocator = allocator_type())
+ : m_members(getter, equal, parameters, allocator)
 {
 try
 {

Modified: sandbox-branches/geometry/index/doc/generated/equal_to.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/equal_to.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/equal_to.qbk 2013-03-05 13:26:56 EST (Tue, 05 Mar 2013)
@@ -9,7 +9,7 @@
It compares Geometries using geometry::equals() function. Other types are compared using operator==. The default version handles Values which are Indexables. This template is also specialized for std::pair<T1, T2> and boost::tuple<...>.

[heading Header]
-`#include <boost/geometry/index/translator.hpp>`
+`#include <boost/geometry/index/equal_to.hpp>`

[heading Synopsis]
[pre

Modified: sandbox-branches/geometry/index/doc/generated/indexable.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/indexable.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/indexable.qbk 2013-03-05 13:26:56 EST (Tue, 05 Mar 2013)
@@ -9,7 +9,7 @@
It translates Value object to Indexable object. The default version handles Values which are Indexables. This template is also specialized for std::pair<Indexable, T2> and boost::tuple<Indexable, ...>.

[heading Header]
-`#include <boost/geometry/index/translator.hpp>`
+`#include <boost/geometry/index/indexable.hpp>`

[heading Synopsis]
[pre

Modified: sandbox-branches/geometry/index/doc/generated/rtree.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/rtree.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/rtree.qbk 2013-03-05 13:26:56 EST (Tue, 05 Mar 2013)
@@ -71,17 +71,17 @@
[[[#classboost_1_1geometry_1_1index_1_1rtree_1a4b7187ed28a9035d68b2f7125ffae5b4] `size_type`][Unsigned integral type used by the container. ]]
[[[#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5] `indexable_getter`][The function object extracting Indexable from Value. ]]
[[[#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b] `value_equal`][The function object comparing objects of type Value. ]]
-[[[#classboost_1_1geometry_1_1index_1_1rtree_1a4175e946d14b08f20f7126e2434e5646] `indexable_type`][The Indexable type to which Value is translated. ]]
+[[[#classboost_1_1geometry_1_1index_1_1rtree_1a28e88e55d260a454688fe1bd5e5af96b] `indexable_type`][The Indexable type to which Value is translated. ]]
[[[#classboost_1_1geometry_1_1index_1_1rtree_1a89a6fd9a7c24f9d30422ef81ce2b959f] `bounds_type`][The Box type used by the R-tree. ]]
]

[heading Constructor(s) and destructor]
[table
[[Function][Description]]
-[[[link classboost_1_1geometry_1_1index_1_1rtree_1a55da92f65c8718efd65ef520ad058b28 `rtree()`]][The constructor. ]]
-[[[link classboost_1_1geometry_1_1index_1_1rtree_1afb26a28fd2309fd70e5f84ea20dc899d `rtree(parameters_type const &, IndexableGetter const &, EqualTo const &, allocator_type)`]][The constructor. ]]
-[[[link classboost_1_1geometry_1_1index_1_1rtree_1a07c03c285279cc976cc045f80265ee39 `rtree(Iterator, Iterator)`]][The constructor. ]]
-[[[link classboost_1_1geometry_1_1index_1_1rtree_1adc4c1b5fce889a3755eb916fdd021bf1 `rtree(Range const &)`]][The constructor. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a55d5fd5d205df08db5267253689ccf0c `rtree()`]][The constructor. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a1a6b696d4855cbf1866196fe058c3a87 `rtree(parameters_type const &, indexable_getter const &, value_equal const &, allocator_type const &)`]][The constructor. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a037f17d8a1dfa4a818ff471dec61c912 `rtree(Iterator, Iterator)`]][The constructor. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1a7b96b715c52ddc13d7a81db344825848 `rtree(Range const &)`]][The constructor. ]]
[[[link classboost_1_1geometry_1_1index_1_1rtree_1af8db72811d2be53c409240204e63fb5a `~rtree()`]][The destructor. ]]
[[[link classboost_1_1geometry_1_1index_1_1rtree_1a826fc3236e181ad718d5283e95d7866f `rtree(rtree const &)`]][The copy constructor. ]]
[[[link classboost_1_1geometry_1_1index_1_1rtree_1a72b6b75e083eea2ed26f54d4a2265375 `rtree(rtree const &, allocator_type const &)`]][The copy constructor. ]]
@@ -113,7 +113,7 @@
[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a17d9cef211feb7f674a5b4602f4cc81e `get_allocator()`]][Returns allocator used by the rtree. ]]
]

-[#classboost_1_1geometry_1_1index_1_1rtree_1a55da92f65c8718efd65ef520ad058b28]
+[#classboost_1_1geometry_1_1index_1_1rtree_1a55d5fd5d205df08db5267253689ccf0c]
[section rtree()]
The constructor.

@@ -121,8 +121,8 @@
[pre

`rtree``(`[^[link classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17 parameters_type]]` const &` `parameters` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17 parameters_type]]`()``,`
- `IndexableGetter const &` `indexable_getter` = `IndexableGetter()``,`
- `EqualTo const &` `equal_to` = `EqualTo()``)`
+ [^[link classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5 indexable_getter]]` const &` `getter` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5 indexable_getter]]`()``,`
+ [^[link classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b value_equal]]` const &` `equal` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b value_equal]]`()``)`
]

[heading Modifier(s)]
@@ -130,41 +130,41 @@
[table
[[Type][Name][Description]]
[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17 parameters_type]]` const &`][ `parameters` ][The parameters object. ]]
-[[`IndexableGetter const &`][ `indexable_getter` ][The function object extracting Indexable from Value. ]]
-[[`EqualTo const &`][ `equal_to` ][]]
+[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5 indexable_getter]]` const &`][ `getter` ][The function object extracting Indexable from Value. ]]
+[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b value_equal]]` const &`][ `equal` ][The function object comparing Values.]]
]
[heading Throws]
If allocator default constructor throws.

[endsect]

-[#classboost_1_1geometry_1_1index_1_1rtree_1afb26a28fd2309fd70e5f84ea20dc899d]
-[section rtree(parameters_type const &, IndexableGetter const &, EqualTo const &, allocator_type)]
+[#classboost_1_1geometry_1_1index_1_1rtree_1a1a6b696d4855cbf1866196fe058c3a87]
+[section rtree(parameters_type const &, indexable_getter const &, value_equal const &, allocator_type const &)]
The constructor.

[heading Synopsis]
[pre

`rtree``(`[^[link classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17 parameters_type]]` const &` `parameters``,`
- `IndexableGetter const &` `indexable_getter``,`
- `EqualTo const &` `equal_to``,`
- [^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]] `allocator``)`
+ [^[link classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5 indexable_getter]]` const &` `getter``,`
+ [^[link classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b value_equal]]` const &` `equal``,`
+ [^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]]` const &` `allocator``)`
]

[heading Parameter(s)]
[table
[[Type][Name][Description]]
[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17 parameters_type]]` const &`][ `parameters` ][The parameters object. ]]
-[[`IndexableGetter const &`][ `indexable_getter` ][The function object extracting Indexable from Value. ]]
-[[`EqualTo const &`][ `equal_to` ][]]
-[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]]][ `allocator` ][The allocator object.]]
+[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5 indexable_getter]]` const &`][ `getter` ][The function object extracting Indexable from Value. ]]
+[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b value_equal]]` const &`][ `equal` ][The function object comparing Values. ]]
+[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]]` const &`][ `allocator` ][The allocator object.]]
]
[heading Throws]
If allocator copy constructor throws.

[endsect]

-[#classboost_1_1geometry_1_1index_1_1rtree_1a07c03c285279cc976cc045f80265ee39]
+[#classboost_1_1geometry_1_1index_1_1rtree_1a037f17d8a1dfa4a818ff471dec61c912]
[section rtree(Iterator, Iterator)]
The constructor.

@@ -174,9 +174,9 @@
`rtree``(``Iterator` `first``,`
 `Iterator` `last``,`
 [^[link classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17 parameters_type]]` const &` `parameters` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17 parameters_type]]`()``,`
- `IndexableGetter const &` `indexable_getter` = `IndexableGetter()``,`
- `EqualTo const &` `equal_to` = `EqualTo()``,`
- [^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]] `allocator` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]]`()``)`
+ [^[link classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5 indexable_getter]]` const &` `getter` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5 indexable_getter]]`()``,`
+ [^[link classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b value_equal]]` const &` `equal` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b value_equal]]`()``,`
+ [^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]]` const &` `allocator` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]]`()``)`
]

[heading Parameter(s)]
@@ -185,9 +185,9 @@
[[`Iterator`][ `first` ][The beginning of the range of Values. ]]
[[`Iterator`][ `last` ][The end of the range of Values. ]]
[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17 parameters_type]]` const &`][ `parameters` ][The parameters object. ]]
-[[`IndexableGetter const &`][ `indexable_getter` ][The function object extracting Indexable from Value. ]]
-[[`EqualTo const &`][ `equal_to` ][]]
-[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]]][ `allocator` ][The allocator object.]]
+[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5 indexable_getter]]` const &`][ `getter` ][The function object extracting Indexable from Value. ]]
+[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b value_equal]]` const &`][ `equal` ][]]
+[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]]` const &`][ `allocator` ][The allocator object.]]
]
[heading Throws]

@@ -201,7 +201,7 @@

[endsect]

-[#classboost_1_1geometry_1_1index_1_1rtree_1adc4c1b5fce889a3755eb916fdd021bf1]
+[#classboost_1_1geometry_1_1index_1_1rtree_1a7b96b715c52ddc13d7a81db344825848]
[section rtree(Range const &)]
The constructor.

@@ -210,9 +210,9 @@
`template<``typename Range``>`
`rtree``(``Range const &` `rng``,`
 [^[link classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17 parameters_type]]` const &` `parameters` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17 parameters_type]]`()``,`
- `IndexableGetter const &` `indexable_getter` = `IndexableGetter()``,`
- `EqualTo const &` `equal_to` = `EqualTo()``,`
- [^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]] `allocator` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]]`()``)`
+ [^[link classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5 indexable_getter]]` const &` `getter` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5 indexable_getter]]`()``,`
+ [^[link classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b value_equal]]` const &` `equal` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b value_equal]]`()``,`
+ [^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]]` const &` `allocator` = [^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]]`()``)`
]

[heading Modifier(s)]
@@ -221,9 +221,9 @@
[[Type][Name][Description]]
[[`Range const &`][ `rng` ][The range of Values. ]]
[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17 parameters_type]]` const &`][ `parameters` ][The parameters object. ]]
-[[`IndexableGetter const &`][ `indexable_getter` ][The function object extracting Indexable from Value. ]]
-[[`EqualTo const &`][ `equal_to` ][]]
-[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]]][ `allocator` ][The allocator object.]]
+[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5 indexable_getter]]` const &`][ `getter` ][The function object extracting Indexable from Value. ]]
+[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b value_equal]]` const &`][ `equal` ][The function object comparing Values. ]]
+[[[^[link classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e allocator_type]]` const &`][ `allocator` ][The allocator object.]]
]
[heading Throws]

Modified: sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/creation_and_modification.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/creation_and_modification.html (original)
+++ sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/creation_and_modification.html 2013-03-05 13:26:56 EST (Tue, 05 Mar 2013)
@@ -89,13 +89,16 @@
and Indexables</a>
</h4></div></div></div>

- R-tree may store <code class="computeroutput">Value</code>s of any type as passed function objects
- knows how to interpret those <code class="computeroutput">Value</code>s, that is extract an <code class="computeroutput">Indexable</code>
- that the R-tree can handle and compare <code class="computeroutput">__values__</code>.
- Each type adapted to <code class="computeroutput">Point</code>
- or <code class="computeroutput">Box</code>
- concept is an <code class="computeroutput">Indexable</code>. <code class="computeroutput">Value</code>s types which can
- be handled by the predefined function objects <code class="computeroutput">index::indexable<Value></code> and <code class="computeroutput">index::equal_to<Value></code> are defined as follows:
+ R-tree may store <code class="computeroutput">Value</code>s of any type as long as passed function
+ objects know how to interpret those <code class="computeroutput">Value</code>s, that is extract
+ an <code class="computeroutput">Indexable</code> that the R-tree can handle and compare <code class="computeroutput">__values__</code>.
+ 
+
+ By default function objects <code class="computeroutput">index::indexable<Value></code> and <code class="computeroutput">index::equal_to<Value></code> are defined for some typically used
+ <code class="computeroutput">Value</code> types which may be stored without defining any additional
+ classes. By default the rtree may store pure <code class="computeroutput">Indexable</code>s, pairs
+ and tuples. In the case of those two collection types, the <code class="computeroutput">Indexable</code>
+ must be the first stored type.

<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">

Modified: sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html (original)
+++ sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html 2013-03-05 13:26:56 EST (Tue, 05 Mar 2013)
@@ -315,7 +315,7 @@
<tr>
<td>
 
- <a name="classboost_1_1geometry_1_1index_1_1rtree_1a4175e946d14b08f20f7126e2434e5646"></a><code class="computeroutput">indexable_type</code>
+ <a name="classboost_1_1geometry_1_1index_1_1rtree_1a28e88e55d260a454688fe1bd5e5af96b"></a><code class="computeroutput">indexable_type</code>
 
 </td>
<td>
@@ -364,7 +364,7 @@
<tr>
<td>
 
- <a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a55da92f65c8718efd65ef520ad058b28"><code class="computeroutput">rtree()</code></a>
+ <a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a55d5fd5d205df08db5267253689ccf0c"><code class="computeroutput">rtree()</code></a>
 
 </td>
<td>
@@ -376,11 +376,12 @@
<tr>
<td>
 
- <a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1afb26a28fd2309fd70e5f84ea20dc899d"><code class="computeroutput">rtree(parameters_type const
- &, IndexableGetter
+ <a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a1a6b696d4855cbf1866196fe058c3a87"><code class="computeroutput">rtree(parameters_type const
+ &, indexable_getter
 const &,
- EqualTo const
- &, allocator_type)</code></a>
+ value_equal const
+ &, allocator_type
+ const &)</code></a>
 
 </td>
<td>
@@ -392,7 +393,7 @@
<tr>
<td>
 
- <a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a07c03c285279cc976cc045f80265ee39"><code class="computeroutput">rtree(Iterator,
+ <a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a037f17d8a1dfa4a818ff471dec61c912"><code class="computeroutput">rtree(Iterator,
 Iterator)</code></a>
 
 </td>
@@ -405,7 +406,7 @@
<tr>
<td>
 
- <a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adc4c1b5fce889a3755eb916fdd021bf1"><code class="computeroutput">rtree(Range const
+ <a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a7b96b715c52ddc13d7a81db344825848"><code class="computeroutput">rtree(Range const
 &)</code></a>
 
 </td>
@@ -817,7 +818,7 @@
</table></div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a55da92f65c8718efd65ef520ad058b28"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__" title="rtree()">rtree()</a>
+<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a55d5fd5d205df08db5267253689ccf0c"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__" title="rtree()">rtree()</a>
</h5></div></div></div>

 The constructor.
@@ -827,8 +828,8 @@
 <a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__.synopsis"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__.synopsis">Synopsis</a>
 </h6>
<pre class="programlisting"><code class="computeroutput">rtree</code><code class="computeroutput">(</code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17">parameters_type</a></code><code class="computeroutput"> const &</code> <code class="computeroutput">parameters</code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17">parameters_type</a></code><code class="computeroutput">()</code><code class="computeroutput">,</code>
- <code class="computeroutput">IndexableGetter const &</code> <code class="computeroutput">indexable_getter</code> = <code class="computeroutput">IndexableGetter()</code><code class="computeroutput">,</code>
- <code class="computeroutput">EqualTo const &</code> <code class="computeroutput">equal_to</code> = <code class="computeroutput">EqualTo()</code><code class="computeroutput">)</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5">indexable_getter</a></code><code class="computeroutput"> const &</code> <code class="computeroutput">getter</code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5">indexable_getter</a></code><code class="computeroutput">()</code><code class="computeroutput">,</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b">value_equal</a></code><code class="computeroutput"> const &</code> <code class="computeroutput">equal</code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b">value_equal</a></code><code class="computeroutput">()</code><code class="computeroutput">)</code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__.h1"></a>
@@ -888,12 +889,13 @@
<tr>
<td>
 
- <code class="computeroutput">IndexableGetter const &</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5">indexable_getter</a></code><code class="computeroutput">
+ const &</code>
 
 </td>
<td>
 
- <code class="computeroutput">indexable_getter</code>
+ <code class="computeroutput">getter</code>
 
 </td>
<td>
@@ -905,16 +907,19 @@
<tr>
<td>
 
- <code class="computeroutput">EqualTo const
- &</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b">value_equal</a></code><code class="computeroutput">
+ const &</code>
 
 </td>
<td>
 
- <code class="computeroutput">equal_to</code>
+ <code class="computeroutput">equal</code>
 
 </td>
<td>
+ 
+ The function object comparing Values.
+ 
 </td>
</tr>
</tbody>
@@ -929,24 +934,25 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexablegetter_const____equalto_const____allocator_type_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1afb26a28fd2309fd70e5f84ea20dc899d"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexablegetter_const____equalto_const____allocator_type_" title="rtree(parameters_type const &, IndexableGetter const &, EqualTo const &, allocator_type)">rtree(parameters_type
- const &, IndexableGetter const &, EqualTo const &, allocator_type)</a>
+<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexable_getter_const____value_equal_const____allocator_type_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a1a6b696d4855cbf1866196fe058c3a87"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexable_getter_const____value_equal_const____allocator_type_const___" title="rtree(parameters_type const &, indexable_getter const &, value_equal const &, allocator_type const &)">rtree(parameters_type
+ const &, indexable_getter const &, value_equal const &, allocator_type
+ const &)</a>
</h5></div></div></div>

 The constructor.
 
<h6>
-<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexablegetter_const____equalto_const____allocator_type_.h0"></a>
- <a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexablegetter_const____equalto_const____allocator_type_.synopsis"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexablegetter_const____equalto_const____allocator_type_.synopsis">Synopsis</a>
+<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexable_getter_const____value_equal_const____allocator_type_const___.h0"></a>
+ <a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexable_getter_const____value_equal_const____allocator_type_const___.synopsis"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexable_getter_const____value_equal_const____allocator_type_const___.synopsis">Synopsis</a>
 </h6>
<pre class="programlisting"><code class="computeroutput">rtree</code><code class="computeroutput">(</code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17">parameters_type</a></code><code class="computeroutput"> const &</code> <code class="computeroutput">parameters</code><code class="computeroutput">,</code>
- <code class="computeroutput">IndexableGetter const &</code> <code class="computeroutput">indexable_getter</code><code class="computeroutput">,</code>
- <code class="computeroutput">EqualTo const &</code> <code class="computeroutput">equal_to</code><code class="computeroutput">,</code>
- <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code> <code class="computeroutput">allocator</code><code class="computeroutput">)</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5">indexable_getter</a></code><code class="computeroutput"> const &</code> <code class="computeroutput">getter</code><code class="computeroutput">,</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b">value_equal</a></code><code class="computeroutput"> const &</code> <code class="computeroutput">equal</code><code class="computeroutput">,</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code><code class="computeroutput"> const &</code> <code class="computeroutput">allocator</code><code class="computeroutput">)</code>
</pre>
<h6>
-<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexablegetter_const____equalto_const____allocator_type_.h1"></a>
- <a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexablegetter_const____equalto_const____allocator_type_.parameter_s_"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexablegetter_const____equalto_const____allocator_type_.parameter_s_">Parameter(s)</a>
+<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexable_getter_const____value_equal_const____allocator_type_const___.h1"></a>
+ <a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexable_getter_const____value_equal_const____allocator_type_const___.parameter_s_"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexable_getter_const____value_equal_const____allocator_type_const___.parameter_s_">Parameter(s)</a>
 </h6>
<div class="informaltable"><table class="table">
<colgroup>
@@ -993,12 +999,13 @@
<tr>
<td>
 
- <code class="computeroutput">IndexableGetter const &</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5">indexable_getter</a></code><code class="computeroutput">
+ const &</code>
 
 </td>
<td>
 
- <code class="computeroutput">indexable_getter</code>
+ <code class="computeroutput">getter</code>
 
 </td>
<td>
@@ -1010,22 +1017,26 @@
<tr>
<td>
 
- <code class="computeroutput">EqualTo const
- &</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b">value_equal</a></code><code class="computeroutput">
+ const &</code>
 
 </td>
<td>
 
- <code class="computeroutput">equal_to</code>
+ <code class="computeroutput">equal</code>
 
 </td>
<td>
+ 
+ The function object comparing Values.
+ 
 </td>
</tr>
<tr>
<td>
 
- <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code><code class="computeroutput">
+ const &</code>
 
 </td>
<td>
@@ -1042,8 +1053,8 @@
</tbody>
</table></div>
<h6>
-<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexablegetter_const____equalto_const____allocator_type_.h2"></a>
- <a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexablegetter_const____equalto_const____allocator_type_.throws"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexablegetter_const____equalto_const____allocator_type_.throws">Throws</a>
+<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexable_getter_const____value_equal_const____allocator_type_const___.h2"></a>
+ <a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexable_getter_const____value_equal_const____allocator_type_const___.throws"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____indexable_getter_const____value_equal_const____allocator_type_const___.throws">Throws</a>
 </h6>

 If allocator copy constructor throws.
@@ -1051,7 +1062,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a07c03c285279cc976cc045f80265ee39"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_" title="rtree(Iterator, Iterator)">rtree(Iterator,
+<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a037f17d8a1dfa4a818ff471dec61c912"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_" title="rtree(Iterator, Iterator)">rtree(Iterator,
 Iterator)</a>
</h5></div></div></div>

@@ -1065,9 +1076,9 @@
<code class="computeroutput">rtree</code><code class="computeroutput">(</code><code class="computeroutput">Iterator</code> <code class="computeroutput">first</code><code class="computeroutput">,</code>
 <code class="computeroutput">Iterator</code> <code class="computeroutput">last</code><code class="computeroutput">,</code>
 <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17">parameters_type</a></code><code class="computeroutput"> const &</code> <code class="computeroutput">parameters</code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17">parameters_type</a></code><code class="computeroutput">()</code><code class="computeroutput">,</code>
- <code class="computeroutput">IndexableGetter const &</code> <code class="computeroutput">indexable_getter</code> = <code class="computeroutput">IndexableGetter()</code><code class="computeroutput">,</code>
- <code class="computeroutput">EqualTo const &</code> <code class="computeroutput">equal_to</code> = <code class="computeroutput">EqualTo()</code><code class="computeroutput">,</code>
- <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code> <code class="computeroutput">allocator</code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code><code class="computeroutput">()</code><code class="computeroutput">)</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5">indexable_getter</a></code><code class="computeroutput"> const &</code> <code class="computeroutput">getter</code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5">indexable_getter</a></code><code class="computeroutput">()</code><code class="computeroutput">,</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b">value_equal</a></code><code class="computeroutput"> const &</code> <code class="computeroutput">equal</code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b">value_equal</a></code><code class="computeroutput">()</code><code class="computeroutput">,</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code><code class="computeroutput"> const &</code> <code class="computeroutput">allocator</code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code><code class="computeroutput">()</code><code class="computeroutput">)</code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_.h1"></a>
@@ -1152,12 +1163,13 @@
<tr>
<td>
 
- <code class="computeroutput">IndexableGetter const &</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5">indexable_getter</a></code><code class="computeroutput">
+ const &</code>
 
 </td>
<td>
 
- <code class="computeroutput">indexable_getter</code>
+ <code class="computeroutput">getter</code>
 
 </td>
<td>
@@ -1169,13 +1181,13 @@
<tr>
<td>
 
- <code class="computeroutput">EqualTo const
- &</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b">value_equal</a></code><code class="computeroutput">
+ const &</code>
 
 </td>
<td>
 
- <code class="computeroutput">equal_to</code>
+ <code class="computeroutput">equal</code>
 
 </td>
<td>
@@ -1184,7 +1196,8 @@
<tr>
<td>
 
- <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code><code class="computeroutput">
+ const &</code>
 
 </td>
<td>
@@ -1221,7 +1234,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1adc4c1b5fce889a3755eb916fdd021bf1"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___" title="rtree(Range const &)">rtree(Range
+<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a7b96b715c52ddc13d7a81db344825848"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___" title="rtree(Range const &)">rtree(Range
 const &)</a>
</h5></div></div></div>

@@ -1234,9 +1247,9 @@
<pre class="programlisting"><code class="computeroutput">template<</code><code class="computeroutput">typename Range</code><code class="computeroutput">></code>
<code class="computeroutput">rtree</code><code class="computeroutput">(</code><code class="computeroutput">Range const &</code> <code class="computeroutput">rng</code><code class="computeroutput">,</code>
 <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17">parameters_type</a></code><code class="computeroutput"> const &</code> <code class="computeroutput">parameters</code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17">parameters_type</a></code><code class="computeroutput">()</code><code class="computeroutput">,</code>
- <code class="computeroutput">IndexableGetter const &</code> <code class="computeroutput">indexable_getter</code> = <code class="computeroutput">IndexableGetter()</code><code class="computeroutput">,</code>
- <code class="computeroutput">EqualTo const &</code> <code class="computeroutput">equal_to</code> = <code class="computeroutput">EqualTo()</code><code class="computeroutput">,</code>
- <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code> <code class="computeroutput">allocator</code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code><code class="computeroutput">()</code><code class="computeroutput">)</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5">indexable_getter</a></code><code class="computeroutput"> const &</code> <code class="computeroutput">getter</code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5">indexable_getter</a></code><code class="computeroutput">()</code><code class="computeroutput">,</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b">value_equal</a></code><code class="computeroutput"> const &</code> <code class="computeroutput">equal</code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b">value_equal</a></code><code class="computeroutput">()</code><code class="computeroutput">,</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code><code class="computeroutput"> const &</code> <code class="computeroutput">allocator</code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code><code class="computeroutput">()</code><code class="computeroutput">)</code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___.h1"></a>
@@ -1314,12 +1327,13 @@
<tr>
<td>
 
- <code class="computeroutput">IndexableGetter const &</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5">indexable_getter</a></code><code class="computeroutput">
+ const &</code>
 
 </td>
<td>
 
- <code class="computeroutput">indexable_getter</code>
+ <code class="computeroutput">getter</code>
 
 </td>
<td>
@@ -1331,22 +1345,26 @@
<tr>
<td>
 
- <code class="computeroutput">EqualTo const
- &</code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b">value_equal</a></code><code class="computeroutput">
+ const &</code>
 
 </td>
<td>
 
- <code class="computeroutput">equal_to</code>
+ <code class="computeroutput">equal</code>
 
 </td>
<td>
+ 
+ The function object comparing Values.
+ 
 </td>
</tr>
<tr>
<td>
 
- <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code>
+ <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code><code class="computeroutput">
+ const &</code>
 
 </td>
<td>
@@ -5490,7 +5508,7 @@
 <a name="geometry_index.r_tree.reference.boost__geometry__index__indexable.header"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__indexable.header">Header</a>
 </h6>

- <code class="computeroutput">#include <boost/geometry/index/translator.hpp></code>
+ <code class="computeroutput">#include <boost/geometry/index/indexable.hpp></code>
 
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__indexable.h2"></a>
@@ -5560,7 +5578,7 @@
 <a name="geometry_index.r_tree.reference.boost__geometry__index__equal_to.header"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__equal_to.header">Header</a>
 </h6>

- <code class="computeroutput">#include <boost/geometry/index/translator.hpp></code>
+ <code class="computeroutput">#include <boost/geometry/index/equal_to.hpp></code>
 
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__equal_to.h2"></a>

Modified: sandbox-branches/geometry/index/doc/html/index.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/index.html (original)
+++ sandbox-branches/geometry/index/doc/html/index.html 2013-03-05 13:26:56 EST (Tue, 05 Mar 2013)
@@ -51,7 +51,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: March 03, 2013 at 13:54:15 GMT</td>
+<td align="left">Last revised: March 05, 2013 at 18:22:50 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Modified: sandbox-branches/geometry/index/doc/rtree/creation.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/rtree/creation.qbk (original)
+++ sandbox-branches/geometry/index/doc/rtree/creation.qbk 2013-03-05 13:26:56 EST (Tue, 05 Mar 2013)
@@ -30,11 +30,12 @@

[section Values and Indexables]

-__rtree__ may store `__value__`s of any type as passed function objects knows how to interpret those `__value__`s, that is
+__rtree__ may store `__value__`s of any type as long as passed function objects know how to interpret those `__value__`s, that is
extract an `__indexable__` that the __rtree__ can handle and compare `__values__`.
-Each type adapted to `__point__` or `__box__` concept is an `__indexable__`.
-`__value__`s types which can be handled by the predefined function objects `index::indexable<Value>` and `index::equal_to<Value>`
-are defined as follows:
+
+By default function objects `index::indexable<Value>` and `index::equal_to<Value>` are defined for some typically used `__value__`
+types which may be stored without defining any additional classes. By default the rtree may store pure `__indexable__`s, pairs
+and tuples. In the case of those two collection types, the `__indexable__` must be the first stored type.

* `__indexable__ = __point__ | __box__`
* `__value__ = Indexable | std::pair<__indexable__, T> | boost::tuple<__indexable__, ...>`

Next message: john_at_[hidden]: "[Boost-commit] svn:boost r83316 - in trunk: boost/math/special_functions libs/math/test"
Previous message: oliver.kowalke_at_[hidden]: "[Boost-commit] svn:boost r83314 - trunk/libs/coroutine/doc"

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk