|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r82428 - in sandbox-branches/geometry/index: boost/geometry/extensions/index/rtree doc doc/generated doc/html doc/html/geometry_index/r_tree
From: adam.wulkiewicz_at_[hidden]
Date: 2013-01-09 18:48:25
Author: awulkiew
Date: 2013-01-09 18:48:23 EST (Wed, 09 Jan 2013)
New Revision: 82428
URL: http://svn.boost.org/trac/boost/changeset/82428
Log:
Docs improved.
Text files modified:
sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp | 152 +++++++++++++++-------------------------
sandbox-branches/geometry/index/doc/generated/rtree.qbk | 110 +++++++++++++---------------
sandbox-branches/geometry/index/doc/generated/translator_def.qbk | 2
sandbox-branches/geometry/index/doc/generated/translator_index.qbk | 2
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html | 32 +++++---
sandbox-branches/geometry/index/doc/html/index.html | 2
sandbox-branches/geometry/index/doc/make_qbk.py | 2
7 files changed, 131 insertions(+), 171 deletions(-)
Modified: sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp
==============================================================================
--- sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp (original)
+++ sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp 2013-01-09 18:48:23 EST (Wed, 09 Jan 2013)
@@ -62,6 +62,7 @@
The R-tree spatial index. This is self-balancing spatial index capable to store various types
of Values and balancing algorithms.
+\par Parameters
The user must pass a type defining the Parameters which will
be used in rtree creation process. This type is used e.g. to specify balancing algorithm
with specific parameters like min and max number of elements in node.
@@ -74,6 +75,7 @@
bgi::runtime::quadratic,
bgi::runtime::rstar.
+\par Translator
The Translator translates from Value to Indexable each time r-tree requires it. Which means that this
operation is done for each Value access. Therefore the Translator should return the Indexable by
const reference instead of a value. Default translator can translate all types adapted to Point
@@ -131,9 +133,8 @@
\param parameters The parameters object.
\param translator The translator object.
- \bgi_throws{
+ \par Throws
If allocator default constructor throws.
- }
*/
inline explicit rtree(parameters_type parameters = parameters_type(),
translator_type const& translator = translator_type())
@@ -152,9 +153,8 @@
\param translator The translator object.
\param allocator The allocator object.
- \bgi_throws{
+ \par Throws
If allocator copy constructor throws.
- }
*/
inline rtree(parameters_type parameters,
translator_type const& translator,
@@ -176,10 +176,9 @@
\param translator The translator object.
\param allocator The allocator object.
- \bgi_throws{
+ \par Throws
If allocator copy constructor throws. If Value copy constructor or copy assignment throws.
When nodes allocation fails.
- }
*/
template<typename Iterator>
inline rtree(Iterator first, Iterator last,
@@ -212,10 +211,9 @@
\param translator The translator object.
\param allocator The allocator object.
- \bgi_throws{
+ \par Throws
If allocator copy constructor throws. If Value copy constructor or copy assignment throws.
When nodes allocation fails.
- }
*/
template<typename Range>
inline explicit rtree(Range const& rng,
@@ -243,9 +241,8 @@
/*!
\brief The destructor.
- \bgi_throws{
+ \par Throws
Nothing.
- }
*/
inline ~rtree()
{
@@ -259,10 +256,9 @@
\param src The rtree which content will be copied.
- \bgi_throws{
+ \par Throws
If allocator copy constructor throws. If Value copy constructor throws.
When nodes allocation fails.
- }
*/
inline rtree(rtree const& src)
: m_translator(src.m_translator) // SHOULDN'T THROW
@@ -285,10 +281,9 @@
\param src The rtree which content will be copied.
\param allocator The allocator which will be used.
- \bgi_throws{
+ \par Throws
If allocator copy constructor throws. If Value copy constructor throws.
When nodes allocation fails.
- }
*/
inline rtree(rtree const& src, allocator_type const& allocator)
: m_translator(src.m_translator) // SHOULDN'T THROW
@@ -308,9 +303,8 @@
\param src The rtree which content will be moved.
- \bgi_throws{
+ \par Throws
If allocator move constructor throws.
- }
*/
inline rtree(BOOST_RV_REF(rtree) src)
// TODO - use boost::move()
@@ -333,10 +327,9 @@
\param src The rtree which content will be copied.
- \bgi_throws{
+ \par Throws
If Value copy constructor throws.
When nodes allocation fails.
- }
*/
inline rtree & operator=(BOOST_COPY_ASSIGN_REF(rtree) src)
{
@@ -358,9 +351,8 @@
\param src The rtree which content will be moved.
- \bgi_throws{
+ \par Throws
Only if allocators aren't equal. If Value copy constructor throws. When nodes allocation fails.
- }
*/
inline rtree & operator=(BOOST_RV_REF(rtree) src)
{
@@ -400,9 +392,8 @@
\param other The rtree which content will be swapped with this rtree content.
- \bgi_throws{
+ \par Throws
If allocators swap throws.
- }
*/
void swap(rtree & other)
{
@@ -420,13 +411,12 @@
\param value The value which will be stored in the container.
- \bgi_throws{
+ \par Throws
If Value copy constructor or copy assignment throws. When nodes allocation fails.
- }
- \bgi_exception{
+
+ \par 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.
- }
*/
inline void insert(value_type const& value)
{
@@ -442,13 +432,12 @@
\param first The beginning of the range of values.
\param last The end of the range of values.
- \bgi_throws{
+ \par Throws
If Value copy constructor or copy assignment throws. When nodes allocation fails.
- }
- \bgi_exception{
+
+ \par 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.
- }
*/
template <typename Iterator>
inline void insert(Iterator first, Iterator last)
@@ -465,13 +454,12 @@
\param rng The range of values.
- \bgi_throws{
+ \par Throws
If Value copy constructor or copy assignment throws. When nodes allocation fails.
- }
- \bgi_exception{
+
+ \par 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.
- }
*/
template <typename Range>
inline void insert(Range const& rng)
@@ -494,13 +482,12 @@
\return 1 if the value was removed, 0 otherwise.
- \bgi_throws{
+ \par Throws
If Value copy constructor or copy assignment throws. When nodes allocation fails.
- }
- \bgi_exception{
+
+ \par 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.
- }
*/
inline size_type remove(value_type const& value)
{
@@ -520,13 +507,12 @@
\return The number of removed values.
- \bgi_throws{
+ \par Throws
If Value copy constructor or copy assignment throws. When nodes allocation fails.
- }
- \bgi_exception{
+
+ \par 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.
- }
*/
template <typename Iterator>
inline size_type remove(Iterator first, Iterator last)
@@ -548,13 +534,12 @@
\return The number of removed values.
- \bgi_throws{
+ \par Throws
If Value copy constructor or copy assignment throws. When nodes allocation fails.
- }
- \bgi_exception{
+
+ \par 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.
- }
*/
template <typename Range>
inline size_type remove(Range const& rng)
@@ -583,9 +568,8 @@
\return The number of values found.
- \bgi_throws{
+ \par Throws
If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
- }
*/
template <typename Predicates, typename OutIter>
inline size_type spatial_query(Predicates const& pred, OutIter out_it) const
@@ -620,9 +604,8 @@
\return The number of values found.
- \bgi_throws{
+ \par Throws
If Value copy constructor or copy assignment throws.
- }
*/
template <typename DistancesPredicates>
inline size_type nearest_query(DistancesPredicates const& dpred, value_type & v) const
@@ -658,9 +641,8 @@
\return The number of values found.
- \bgi_throws{
+ \par Throws
If Value copy constructor or copy assignment throws.
- }
*/
template <typename DistancesPredicates, typename Predicates>
inline size_type nearest_query(DistancesPredicates const& dpred, Predicates const& pred, value_type & v) const
@@ -687,9 +669,8 @@
\return The number of values found.
- \bgi_throws{
+ \par Throws
If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
- }
*/
template <typename DistancesPredicates, typename OutIter>
inline size_type nearest_query(DistancesPredicates const& dpred, size_t k, OutIter out_it) const
@@ -726,9 +707,8 @@
\return The number of values found.
- \bgi_throws{
+ \par Throws
If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
- }
*/
template <typename DistancesPredicates, typename Predicates, typename OutIter>
inline size_type nearest_query(DistancesPredicates const& dpred, size_t k, Predicates const& pred, OutIter out_it) const
@@ -741,9 +721,8 @@
\return The number of stored values.
- \bgi_throws{
+ \par Throws
Nothing.
- }
*/
inline size_type size() const
{
@@ -755,9 +734,8 @@
\return true if the container is empty.
- \bgi_throws{
+ \par Throws
Nothing.
- }
*/
inline bool empty() const
{
@@ -767,9 +745,8 @@
/*!
\brief Removes all values stored in the container.
- \bgi_throws{
+ \par Throws
Nothing.
- }
*/
inline void clear()
{
@@ -785,9 +762,8 @@
\return The box containing all values stored in the container or an invalid box if
there are no values in the container.
- \bgi_throws{
+ \par Throws
Nothing.
- }
*/
inline box_type box() const
{
@@ -816,9 +792,8 @@
\return The number of values found.
- \bgi_throws{
+ \par Throws
Nothing.
- }
*/
template <typename ValueOrIndexable>
size_type count(ValueOrIndexable const& vori) const
@@ -839,9 +814,8 @@
\return The parameters object.
- \bgi_throws{
+ \par Throws
Nothing.
- }
*/
inline parameters_type const& parameters() const
{
@@ -853,9 +827,8 @@
\return The translator object.
- \bgi_throws{
+ \par Throws
Nothing.
- }
*/
inline translator_type const& translator() const
{
@@ -867,9 +840,8 @@
\return The allocator.
- \bgi_throws{
+ \par Throws
If allocator copy constructor throws.
- }
*/
allocator_type get_allocator() const
{
@@ -887,9 +859,8 @@
\param visitor The visitor object.
- \bgi_exception{
- the same as Visitor::operator().
- }
+ \par Throws
+ If Visitor::operator() throws.
*/
template <typename Visitor>
inline void apply_visitor(Visitor & visitor) const
@@ -905,9 +876,8 @@
\return The number of stored objects.
- \bgi_exception{
- nothrow
- }
+ \par Throws
+ Nothing.
*/
inline size_type values_count() const
{
@@ -921,9 +891,8 @@
\return The depth of the R-tree.
- \bgi_exception{
- nothrow
- }
+ \par Throws
+ Nothing.
*/
inline size_type depth() const
{
@@ -938,9 +907,8 @@
\param value The value which will be stored in the container.
- \bgi_exception{
+ \par Exception-safety
basic
- }
*/
inline void raw_insert(value_type const& value)
{
@@ -969,9 +937,8 @@
\param value The value which will be removed from the container.
- \bgi_exception{
+ \par Exception-safety
basic
- }
*/
inline size_type raw_remove(value_type const& value)
{
@@ -999,9 +966,8 @@
/*!
\brief Create an empty R-tree i.e. new empty root node and clear other attributes.
- \bgi_exception{
+ \par Exception-safety
strong
- }
*/
inline void raw_create()
{
@@ -1017,9 +983,8 @@
\param t The container which is going to be destroyed.
- \bgi_exception{
+ \par Exception-safety
nothrow
- }
*/
inline void raw_destroy(rtree & t)
{
@@ -1041,9 +1006,8 @@
\param src The source R-tree.
\param dst The destination R-tree.
- \bgi_exception{
+ \par Exception-safety
strong
- }
*/
inline void raw_copy(rtree const& src, rtree & dst, bool copy_all_internals) const
{
@@ -1075,9 +1039,8 @@
/*!
\brief Find one value meeting distances and spatial predicates.
- \bgi_exception{
+ \par Exception-safety
strong
- }
*/
template <typename DistancesPredicates, typename Predicates>
inline size_type raw_nearest_one(DistancesPredicates const& dpred, Predicates const& pred, value_type & v) const
@@ -1115,9 +1078,8 @@
/*!
\brief Find k values meeting distances and spatial predicates.
- \bgi_exception{
+ \par Exception-safety
strong
- }
*/
template <typename DistancesPredicates, typename Predicates, typename OutIter>
inline size_type raw_nearest_k(DistancesPredicates const& dpred, size_t k, Predicates const& pred, OutIter out_it) const
Modified: sandbox-branches/geometry/index/doc/generated/rtree.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/rtree.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/rtree.qbk 2013-01-09 18:48:23 EST (Wed, 09 Jan 2013)
@@ -8,12 +8,13 @@
[heading Description]
The R-tree spatial index. This is self-balancing spatial index capable to store various types of Values and balancing algorithms.
+[heading Parameters]
The user must pass a type defining the Parameters which will be used in rtree creation process. This type is used e.g. to specify balancing algorithm with specific parameters like min and max number of elements in node. Predefined algorithms with compile-time parameters are: bgi::linear<MinElements, MaxElements>, bgi::quadratic<MinElements, MaxElements>, bgi::rstar<MinElements, MaxElements, OverlapCostThreshold = 0, ReinsertedElements = MaxElements * 0.3>. Predefined algorithms with run-time parameters are: bgi::runtime::linear, bgi::runtime::quadratic, bgi::runtime::rstar.
-
+[heading Translator]
The Translator translates from Value to Indexable each time r-tree requires it. Which means that this operation is done for each Value access. Therefore the Translator should return the Indexable by const reference instead of a value. Default translator can translate all types adapted to Point or Box concepts (which are Indexables). It also handles std::pair<Indexable, T>, pointers, smart pointers, and iterators. E.g. If std::pair<Box, int> is stored, the default translator translates from std::pair<Box, int> const& to Box const&.
[heading Header]
-`#include <.hpp>`
+`#include <boost/geometry/extensions/index/rtree/rtree.hpp>`
[heading Synopsis]
``template<typename Value,
@@ -98,7 +99,7 @@
[[ `parameters_type` ][ `parameters` ][The parameters object. ]]
[[ `translator_type const &` ][ `translator` ][The translator object.]]
]
-[heading Throws]
+[heading Throws]
If allocator default constructor throws.
[endsect]
@@ -117,7 +118,7 @@
[[ `translator_type const &` ][ `translator` ][The translator object. ]]
[[ `allocator_type` ][ `allocator` ][The allocator object.]]
]
-[heading Throws]
+[heading Throws]
If allocator copy constructor throws.
[endsect]
@@ -141,9 +142,8 @@
[[ `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.
+[heading Throws]
+If allocator copy constructor throws. If Value copy constructor or copy assignment throws. When nodes allocation fails.
[endsect]
[br]
@@ -164,9 +164,8 @@
[[ `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.
+[heading Throws]
+If allocator copy constructor throws. If Value copy constructor or copy assignment throws. When nodes allocation fails.
[endsect]
[br]
@@ -175,7 +174,7 @@
The destructor. [heading Synopsis]
``~rtree()``
-[heading Throws]
+[heading Throws]
Nothing.
[endsect]
@@ -191,9 +190,8 @@
[[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.
+[heading Throws]
+If allocator copy constructor throws. If Value copy constructor throws. When nodes allocation fails.
[endsect]
[br]
@@ -209,9 +207,8 @@
[[ `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.
+[heading Throws]
+If allocator copy constructor throws. If Value copy constructor throws. When nodes allocation fails.
[endsect]
[br]
@@ -226,7 +223,7 @@
[[Type][Name][Description]]
[[ `rtree &&` ][ `src` ][The rtree which content will be moved.]]
]
-[heading Throws]
+[heading Throws]
If allocator move constructor throws.
[endsect]
@@ -242,9 +239,8 @@
[[Type][Name][Description]]
[[ `const rtree &` ][ `src` ][The rtree which content will be copied.]]
]
-[heading Throws]
-If Value copy constructor throws.
-When nodes allocation fails.
+[heading Throws]
+If Value copy constructor throws. When nodes allocation fails.
[endsect]
[br]
@@ -259,7 +255,7 @@
[[Type][Name][Description]]
[[ `rtree &&` ][ `src` ][The rtree which content will be moved.]]
]
-[heading Throws]
+[heading Throws]
Only if allocators aren't equal. If Value copy constructor throws. When nodes allocation fails.
[endsect]
@@ -275,7 +271,7 @@
[[Type][Name][Description]]
[[ `rtree &` ][ `other` ][The rtree which content will be swapped with this rtree content.]]
]
-[heading Throws]
+[heading Throws]
If allocators swap throws.
[endsect]
@@ -290,11 +286,10 @@
[[Type][Name][Description]]
[[ `value_type const &` ][ `value` ][The value which will be stored in the container.]]
]
-[heading Throws]
+[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.
+[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]
@@ -310,11 +305,10 @@
[[ `Iterator` ][ `first` ][The beginning of the range of values. ]]
[[ `Iterator` ][ `last` ][The end of the range of values.]]
]
-[heading Throws]
+[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.
+[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]
@@ -329,11 +323,10 @@
[[Type][Name][Description]]
[[ `Range const &` ][ `rng` ][The range of values.]]
]
-[heading Throws]
+[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.
+[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]
@@ -350,11 +343,10 @@
]
[heading Returns]
1 if the value was removed, 0 otherwise.
-[heading Throws]
+[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.
+[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]
@@ -373,11 +365,10 @@
]
[heading Returns]
The number of removed values.
-[heading Throws]
+[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.
+[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]
@@ -395,11 +386,10 @@
]
[heading Returns]
The number of removed values.
-[heading Throws]
+[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.
+[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]
@@ -418,7 +408,7 @@
]
[heading Returns]
The number of values found.
-[heading Throws]
+[heading Throws]
If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
[endsect]
@@ -438,7 +428,7 @@
]
[heading Returns]
The number of values found.
-[heading Throws]
+[heading Throws]
If Value copy constructor or copy assignment throws.
[endsect]
@@ -463,7 +453,7 @@
]
[heading Returns]
The number of values found.
-[heading Throws]
+[heading Throws]
If Value copy constructor or copy assignment throws.
[endsect]
@@ -486,7 +476,7 @@
]
[heading Returns]
The number of values found.
-[heading Throws]
+[heading Throws]
If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
[endsect]
@@ -515,7 +505,7 @@
]
[heading Returns]
The number of values found.
-[heading Throws]
+[heading Throws]
If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
[endsect]
@@ -527,7 +517,7 @@
[heading Returns]
The number of stored values.
-[heading Throws]
+[heading Throws]
Nothing.
[endsect]
@@ -539,7 +529,7 @@
[heading Returns]
true if the container is empty.
-[heading Throws]
+[heading Throws]
Nothing.
[endsect]
@@ -549,7 +539,7 @@
Removes all values stored in the container. [heading Synopsis]
``void clear()``
-[heading Throws]
+[heading Throws]
Nothing.
[endsect]
@@ -562,7 +552,7 @@
[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]
+[heading Throws]
Nothing.
[endsect]
@@ -581,7 +571,7 @@
]
[heading Returns]
The number of values found.
-[heading Throws]
+[heading Throws]
Nothing.
[endsect]
@@ -593,7 +583,7 @@
[heading Returns]
The parameters object.
-[heading Throws]
+[heading Throws]
Nothing.
[endsect]
@@ -605,7 +595,7 @@
[heading Returns]
The translator object.
-[heading Throws]
+[heading Throws]
Nothing.
[endsect]
@@ -617,7 +607,7 @@
[heading Returns]
The allocator.
-[heading Throws]
+[heading Throws]
If allocator copy constructor throws.
[endsect]
Modified: sandbox-branches/geometry/index/doc/generated/translator_def.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/translator_def.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/translator_def.qbk 2013-01-09 18:48:23 EST (Wed, 09 Jan 2013)
@@ -9,7 +9,7 @@
It translates Value object to Indexable object. The default version handles Values which are Indexables. This translator is also specialized for std::pair<Indexable, Second> and boost::tuple<Indexable, ...>.
[heading Header]
-`#include <.hpp>`
+`#include <boost/geometry/extensions/index/translator/def.hpp>`
[heading Synopsis]
``template<typename Value>
Modified: sandbox-branches/geometry/index/doc/generated/translator_index.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/translator_index.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/translator_index.qbk 2013-01-09 18:48:23 EST (Wed, 09 Jan 2013)
@@ -9,7 +9,7 @@
This translator translates from index of an element in an external Container to the Indexable. The container should have operator[](size\u005ftype) defined. Index translator uses translator::def<...> to translate from Container::value\u005ftype to the Indexable which means that it can handle Indexables, std::pairs and boost::tuples stored in an external Container.
[heading Header]
-`#include <.hpp>`
+`#include <boost/geometry/extensions/index/translator/index.hpp>`
[heading Synopsis]
``template<typename Container>
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-01-09 18:48:23 EST (Wed, 09 Jan 2013)
@@ -45,7 +45,7 @@
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree" title="boost::geometry::index::rtree">boost::geometry::index::rtree</a>
</h4></div></div></div>
<p>
- <a class="indexterm" name="id902772"></a><a class="indexterm" name="id902776"></a><a class="indexterm" name="id902781"></a><a class="indexterm" name="id902786"></a>
+ <a class="indexterm" name="id886388"></a><a class="indexterm" name="id886392"></a><a class="indexterm" name="id886397"></a><a class="indexterm" name="id886402"></a>
The R-tree spatial index.
</p>
<h6>
@@ -56,6 +56,10 @@
The R-tree spatial index. This is self-balancing spatial index capable
to store various types of Values and balancing algorithms.
</p>
+<h6>
+<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h1"></a>
+ <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters">Parameters</a>
+ </h6>
<p>
The user must pass a type defining the Parameters which will be used in
rtree creation process. This type is used e.g. to specify balancing algorithm
@@ -66,6 +70,10 @@
* 0.3>. Predefined algorithms with run-time parameters are: bgi::runtime::linear,
bgi::runtime::quadratic, bgi::runtime::rstar.
</p>
+<h6>
+<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h2"></a>
+ <span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.translator">Translator</a>
+ </h6>
<p>
The Translator translates from Value to Indexable each time r-tree requires
it. Which means that this operation is done for each Value access. Therefore
@@ -77,14 +85,14 @@
int> const& to Box const&.
</p>
<h6>
-<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h1"></a>
+<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.header">Header</a>
</h6>
<p>
- <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><.</span><span class="identifier">hpp</span><span class="special">></span></code>
+ <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">extensions</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">rtree</span><span class="special">/</span><span class="identifier">rtree</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
</p>
<h6>
-<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h2"></a>
+<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.synopsis">Synopsis</a>
</h6>
<p>
@@ -101,7 +109,7 @@
<p>
</p>
<h6>
-<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h3"></a>
+<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h5"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.template_parameter_s_">Template
parameter(s)</a>
</h6>
@@ -175,7 +183,7 @@
</tbody>
</table></div>
<h6>
-<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h4"></a>
+<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h6"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.typedef_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.typedef_s_">Typedef(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -283,7 +291,7 @@
</tbody>
</table></div>
<h6>
-<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h5"></a>
+<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h7"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.constructor_s__and_destructor"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.constructor_s__and_destructor">Constructor(s)
and destructor</a>
</h6>
@@ -411,7 +419,7 @@
</tbody>
</table></div>
<h6>
-<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h6"></a>
+<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h8"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member_s_">Member(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -6956,7 +6964,7 @@
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def" title="boost::geometry::index::translator::def">boost::geometry::index::translator::def</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="id939489"></a><a class="indexterm" name="id939494"></a><a class="indexterm" name="id939499"></a><a class="indexterm" name="id939504"></a><a class="indexterm" name="id939509"></a>
+ <a class="indexterm" name="id923026"></a><a class="indexterm" name="id923031"></a><a class="indexterm" name="id923036"></a><a class="indexterm" name="id923041"></a><a class="indexterm" name="id923045"></a>
The default translator.
</p>
<h6>
@@ -6973,7 +6981,7 @@
<span class="phrase"><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.header">Header</a>
</h6>
<p>
- <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><.</span><span class="identifier">hpp</span><span class="special">></span></code>
+ <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">extensions</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">translator</span><span class="special">/</span><span class="identifier">def</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.h2"></a>
@@ -7030,7 +7038,7 @@
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index" title="boost::geometry::index::translator::index">boost::geometry::index::translator::index</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="id939720"></a><a class="indexterm" name="id939725"></a><a class="indexterm" name="id939729"></a><a class="indexterm" name="id939734"></a><a class="indexterm" name="id939739"></a>
+ <a class="indexterm" name="id923300"></a><a class="indexterm" name="id923305"></a><a class="indexterm" name="id923309"></a><a class="indexterm" name="id923314"></a><a class="indexterm" name="id923319"></a>
The index translator.
</p>
<h6>
@@ -7049,7 +7057,7 @@
<span class="phrase"><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.header">Header</a>
</h6>
<p>
- <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><.</span><span class="identifier">hpp</span><span class="special">></span></code>
+ <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">extensions</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">translator</span><span class="special">/</span><span class="identifier">index</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.h2"></a>
Modified: sandbox-branches/geometry/index/doc/html/index.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/index.html (original)
+++ sandbox-branches/geometry/index/doc/html/index.html 2013-01-09 18:48:23 EST (Wed, 09 Jan 2013)
@@ -56,7 +56,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: January 09, 2013 at 18:40:07 GMT</small></p></td>
+<td align="left"><p><small>Last revised: January 09, 2013 at 23:45:57 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
Modified: sandbox-branches/geometry/index/doc/make_qbk.py
==============================================================================
--- sandbox-branches/geometry/index/doc/make_qbk.py (original)
+++ sandbox-branches/geometry/index/doc/make_qbk.py 2013-01-09 18:48:23 EST (Wed, 09 Jan 2013)
@@ -12,7 +12,7 @@
cmd = "doxygen_xml2qbk"
cmd = cmd + " --xml xml/%s.xml"
-cmd = cmd + " --start_include ."
+cmd = cmd + " --start_include boost/"
cmd = cmd + " --index_id_path %s"
cmd = cmd + " --output_style alt"
cmd = cmd + " > generated/%s.qbk"
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