diff --git a/doc/Doxyfile b/doc/Doxyfile index 36e493d78..b6153ae9c 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -203,7 +203,7 @@ TAB_SIZE = 8 # will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. -ALIASES = +ALIASES = bgi_exception{1}="\xmlonly [heading Exception-safety] \1 \endxmlonly \htmlonly
Exception-safety
\1
\endhtmlonly \latexonly \begin{DoxyReturn}{Exception-safety} \1 \end{DoxyReturn} \endlatexonly" # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding diff --git a/doc/html/geometry_index/r_tree/index.html b/doc/html/geometry_index/r_tree/index.html index a9be6e8e1..a18d7704f 100644 --- a/doc/html/geometry_index/r_tree/index.html +++ b/doc/html/geometry_index/r_tree/index.html @@ -31,7 +31,7 @@ boost::geometry::index::rtree

- + The R-tree spatial index.

diff --git a/doc/html/index.html b/doc/html/index.html index 644cc71bb..ea50d3b3a 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -57,7 +57,7 @@ - +

Last revised: January 08, 2013 at 15:52:09 GMT

Last revised: January 08, 2013 at 17:43:46 GMT
diff --git a/include/boost/geometry/extensions/index/rtree/rtree.hpp b/include/boost/geometry/extensions/index/rtree/rtree.hpp index b68530ab0..0f1ef1091 100644 --- a/include/boost/geometry/extensions/index/rtree/rtree.hpp +++ b/include/boost/geometry/extensions/index/rtree/rtree.hpp @@ -128,12 +128,9 @@ public: \param translator The translator object. \param allocator The allocator object. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow - - \endxmlonly + } */ inline explicit rtree(parameters_type parameters = parameters_type(), translator_type const& translator = translator_type(), @@ -155,12 +152,9 @@ public: \param translator The translator object. \param allocator The allocator object. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ template inline rtree(Iterator first, Iterator last, @@ -193,12 +187,9 @@ public: \param translator The translator object. \param allocator The allocator object. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ template inline explicit rtree(Range const& rng, @@ -226,12 +217,9 @@ public: /*! \brief The destructor. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow - - \endxmlonly + } */ inline ~rtree() { @@ -245,12 +233,9 @@ public: \param src The rtree which content will be copied. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ inline rtree(rtree const& src) : m_translator(src.m_translator) // SHOULDN'T THROW @@ -273,12 +258,9 @@ public: \param src The rtree which content will be copied. \param allocator The allocator which will be used. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ inline rtree(rtree const& src, allocator_type const& allocator) : m_translator(src.m_translator) // SHOULDN'T THROW @@ -298,12 +280,9 @@ public: \param src The rtree which content will be moved. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow - - \endxmlonly + } */ inline rtree(BOOST_RV_REF(rtree) src) // TODO - use boost::move() @@ -326,12 +305,9 @@ public: \param src The rtree which content will be copied. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ inline rtree & operator=(BOOST_COPY_ASSIGN_REF(rtree) src) { @@ -353,12 +329,9 @@ public: \param src The rtree which content will be moved. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow (if allocators are equal), strong (if allocators aren't equal) - - \endxmlonly + } */ inline rtree & operator=(BOOST_RV_REF(rtree) src) { @@ -398,12 +371,9 @@ public: \param other The rtree which content will be swapped with this rtree content. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow - - \endxmlonly + } */ void swap(rtree & other) { @@ -423,13 +393,10 @@ public: \param value The value which will be stored in the container. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. - - \endxmlonly + } */ inline void insert(value_type const& value) { @@ -445,13 +412,10 @@ public: \param first The beginning of the range of values. \param last The end of the range of values. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. - - \endxmlonly + } */ template inline void insert(Iterator first, Iterator last) @@ -468,13 +432,10 @@ public: \param rng The range of values. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. - - \endxmlonly + } */ template inline void insert(Range const& rng) @@ -497,13 +458,10 @@ public: \return 1 if the value was removed, 0 otherwise. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. - - \endxmlonly + } */ inline size_type remove(value_type const& value) { @@ -523,13 +481,10 @@ public: \return The number of removed values. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. - - \endxmlonly + } */ template inline size_type remove(Iterator first, Iterator last) @@ -551,13 +506,10 @@ public: \return The number of removed values. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. - - \endxmlonly + } */ template inline size_type remove(Range const& rng) @@ -575,12 +527,9 @@ public: \param first The beginning of the range of values. \param last The end of the range of values. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ /*template inline void assign(Iterator first, Iterator last) @@ -594,12 +543,9 @@ public: \param rng The range of values. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ /*template inline void assign(Range const& rng) @@ -625,12 +571,9 @@ public: \return The number of values found. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ template inline size_type spatial_query(Predicates const& pred, OutIter out_it) const @@ -665,12 +608,9 @@ public: \return The number of values found. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ template inline size_type nearest_query(DistancesPredicates const& dpred, value_type & v) const @@ -706,12 +646,9 @@ public: \return The number of values found. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ template inline size_type nearest_query(DistancesPredicates const& dpred, Predicates const& pred, value_type & v) const @@ -738,12 +675,9 @@ public: \return The number of values found. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ template inline size_type nearest_query(DistancesPredicates const& dpred, size_t k, OutIter out_it) const @@ -780,12 +714,9 @@ public: \return The number of values found. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ template inline size_type nearest_query(DistancesPredicates const& dpred, size_t k, Predicates const& pred, OutIter out_it) const @@ -798,12 +729,9 @@ public: \return The number of stored values. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow - - \endxmlonly + } */ inline size_type size() const { @@ -815,12 +743,9 @@ public: \return true if the container is empty. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow - - \endxmlonly + } */ inline bool empty() const { @@ -830,12 +755,9 @@ public: /*! \brief Removes all values stored in the container. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow - - \endxmlonly + } */ inline void clear() { @@ -851,13 +773,10 @@ public: \return The box containing all values stored in the container or an invalid box if there are no values in the container. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow (if Indexable's CoordinateType copy assignment doesn't throw), strong (if Indexable's CoordinateType copy assignment throws). - - \endxmlonly + } */ inline box_type box() const { @@ -886,12 +805,9 @@ public: \return The number of values found. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow - - \endxmlonly + } */ template size_type count(ValueOrIndexable const& vori) const @@ -912,12 +828,9 @@ public: \return The parameters object. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow - - \endxmlonly + } */ inline parameters_type const& parameters() const { @@ -929,12 +842,9 @@ public: \return The translator object. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow - - \endxmlonly + } */ inline translator_type const& translator() const { @@ -946,12 +856,9 @@ public: \return The allocator. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow - - \endxmlonly + } */ allocator_type get_allocator() const { @@ -969,12 +876,9 @@ private: \param visitor The visitor object. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ the same as Visitor::operator(). - - \endxmlonly + } */ template inline void apply_visitor(Visitor & visitor) const @@ -990,12 +894,9 @@ private: \return The number of stored objects. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow - - \endxmlonly + } */ inline size_type values_count() const { @@ -1009,12 +910,9 @@ private: \return The depth of the R-tree. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow - - \endxmlonly + } */ inline size_type depth() const { @@ -1029,12 +927,9 @@ private: \param value The value which will be stored in the container. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ basic - - \endxmlonly + } */ inline void raw_insert(value_type const& value) { @@ -1063,12 +958,9 @@ private: \param value The value which will be removed from the container. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ basic - - \endxmlonly + } */ inline size_type raw_remove(value_type const& value) { @@ -1096,12 +988,9 @@ private: /*! \brief Create an empty R-tree i.e. new empty root node and clear other attributes. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ inline void raw_create() { @@ -1117,12 +1006,9 @@ private: \param t The container which is going to be destroyed. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ nothrow - - \endxmlonly + } */ inline void raw_destroy(rtree & t) { @@ -1144,12 +1030,9 @@ private: \param src The source R-tree. \param dst The destination R-tree. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ inline void raw_copy(rtree const& src, rtree & dst, bool copy_all_internals) const { @@ -1181,12 +1064,9 @@ private: /*! \brief Find one value meeting distances and spatial predicates. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ template inline size_type raw_nearest_one(DistancesPredicates const& dpred, Predicates const& pred, value_type & v) const @@ -1224,12 +1104,9 @@ private: /*! \brief Find k values meeting distances and spatial predicates. - \xmlonly - - [heading Exception-safety] + \bgi_exception{ strong - - \endxmlonly + } */ template inline size_type raw_nearest_k(DistancesPredicates const& dpred, size_t k, Predicates const& pred, OutIter out_it) const @@ -1274,6 +1151,10 @@ private: node * m_root; }; +/*! +\defgroup rtree_functions Global functions +*/ + /*! \brief Insert a value to the index.