Subject: [Boost-commit] svn:boost r83752 - in trunk/libs/geometry/doc: . index
From: adam.wulkiewicz_at_[hidden]
Date: 2013-04-03 15:05:34
Author: awulkiew
Date: 2013-04-03 15:05:33 EDT (Wed, 03 Apr 2013)
New Revision: 83752
URL: http://svn.boost.org/trac/boost/changeset/83752
Log:
geometry docs: Added spatial indexes to reference matrix + other minor documentation tweaks.
Text files modified:
trunk/libs/geometry/doc/index/Doxyfile | 2
trunk/libs/geometry/doc/quickref.xml | 123 ++++++++++++++++++++++++++++++++++++++++
trunk/libs/geometry/doc/reference.qbk | 13 +--
3 files changed, 129 insertions(+), 9 deletions(-)
Modified: trunk/libs/geometry/doc/index/Doxyfile
==============================================================================
--- trunk/libs/geometry/doc/index/Doxyfile (original)
+++ trunk/libs/geometry/doc/index/Doxyfile 2013-04-03 15:05:33 EDT (Wed, 03 Apr 2013)
@@ -285,7 +285,7 @@
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED = "BOOST_RV_REF(T)=T &&" \
- "BOOST_COPY_ASSIGN_REF(T)=const T &"
+ "BOOST_COPY_ASSIGN_REF(T)=T const &"
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
Modified: trunk/libs/geometry/doc/quickref.xml
==============================================================================
--- trunk/libs/geometry/doc/quickref.xml (original)
+++ trunk/libs/geometry/doc/quickref.xml 2013-04-03 15:05:33 EDT (Wed, 03 Apr 2013)
@@ -624,5 +624,128 @@
</row>
</tbody>
</tgroup>
+
+<!-- ###### SPATIAL INDEXES ######################################################################### -->
+<tgroup cols="3">
+ <colspec colname="a"/>
+ <colspec colname="b"/>
+ <colspec colname="c"/>
+ <thead>
+ <row>
+ <entry valign="center" namest="a" nameend="c">
+ <bridgehead renderas="sect2">Spatial indexes</bridgehead>
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry valign="top">
+ <bridgehead renderas="sect3">R-tree</bridgehead>
+ <simplelist type="vert" columns="1">
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree">boost::geometry::index::rtree</link></member>
+ </simplelist>
+ <bridgehead renderas="sect3">R-tree parameters</bridgehead>
+ <simplelist type="vert" columns="1">
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.parameters.boost__geometry__index__linear">boost::geometry::index::linear</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.parameters.boost__geometry__index__quadratic">boost::geometry::index::quadratic</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.parameters.boost__geometry__index__rstar">boost::geometry::index::rstar</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.parameters.boost__geometry__index__dynamic_linear">boost::geometry::index::dynamic_linear</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.parameters.boost__geometry__index__dynamic_quadratic">boost::geometry::index::dynamic_quadratic</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.parameters.boost__geometry__index__dynamic_rstar">boost::geometry::index::dynamic_rstar</link></member>
+ </simplelist>
+ <bridgehead renderas="sect3">R-tree constructors and destructor</bridgehead>
+ <simplelist type="vert" columns="1">
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.rtree__">rtree()</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.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 &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.rtree_iterator__iterator_">rtree(Iterator, Iterator)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.rtree_range_const___">rtree(Range const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.rtree_rtree_const___">rtree(rtree const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.rtree_rtree_const____allocator_type_const___">rtree(rtree const &, allocator_type const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.rtree_rtree____">rtree(rtree &&)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.rtree_rtree_____allocator_type_const___">rtree(rtree &&, allocator_type const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree._rtree__">~rtree()</link></member>
+ </simplelist>
+ </entry>
+ <entry valign="top">
+ <bridgehead renderas="sect3">R-tree member functions</bridgehead>
+ <simplelist type="vert" columns="1">
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.operator__rtree_const___">operator=(const rtree &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.operator__rtree____">operator=(rtree &&)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.swap_rtree___">swap(rtree &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.insert_value_type_const___">insert(value_type const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.insert_iterator__iterator_">insert(Iterator, Iterator)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.insert_range_const___">insert(Range const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.remove_value_type_const___">remove(value_type const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.remove_iterator__iterator_">remove(Iterator, Iterator)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.remove_range_const___">remove(Range const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.query_predicates_const____outiter_">query(Predicates const &, OutIter)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.size__">size()</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.empty__">empty()</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.clear__">clear()</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.bounds__">bounds()</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.count_valueorindexable_const___">count(ValueOrIndexable const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.parameters__">parameters()</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.indexable_get__">indexable_get()</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.value_eq__">value_eq()</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.boost__geometry__index__rtree.get_allocator__">get_allocator()</link></member>
+ </simplelist>
+ </entry>
+ <entry valign="top">
+ <bridgehead renderas="sect3">R-tree free functions (boost::geometry::index::)</bridgehead>
+ <simplelist type="vert" columns="1">
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.group__rtree__functions.insert_rtree_________value_const___">insert(rtree<...> &, Value const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.group__rtree__functions.insert_rtree_________iterator__iterator_">insert(rtree<...> &, Iterator, Iterator)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.group__rtree__functions.insert_rtree_________range_const___">insert(rtree<...> &, Range const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.group__rtree__functions.remove_rtree_________value_const___">remove(rtree<...> &, Value const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.group__rtree__functions.remove_rtree_________iterator__iterator_">remove(rtree<...> &, Iterator, Iterator)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.group__rtree__functions.remove_rtree_________range_const___">remove(rtree<...> &, Range const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.group__rtree__functions.query_rtree______const____predicates_const____outiter_">query(rtree<...> const &, Predicates const &, OutIter)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.group__rtree__functions.clear_rtree________">clear(rtree<...> &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.group__rtree__functions.size_rtree______const___">size(rtree<...> const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.group__rtree__functions.empty_rtree______const___">empty(rtree<...> const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.group__rtree__functions.bounds_rtree______const___">bounds(rtree<...> const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.rtree.group__rtree__functions.swap_rtree_________rtree________">swap(rtree<...> &, rtree<...> &)</link></member>
+ </simplelist>
+ </entry>
+ </row>
+ <row>
+ <entry valign="top">
+ <bridgehead renderas="sect3">Observers</bridgehead>
+ <simplelist type="vert" columns="1">
+ <member><link linkend="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable">boost::geometry::index::indexable</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to">boost::geometry::index::equal_to</link></member>
+ </simplelist>
+ <bridgehead renderas="sect3">Inserters (boost::geometry::index::)</bridgehead>
+ <simplelist type="vert" columns="1">
+ <member><link linkend="geometry.reference.spatial_indexes.group__inserters.inserter_container___">inserter(Container &)</link></member>
+ </simplelist>
+ <bridgehead renderas="sect3">Adaptors (boost::geometry::index::adaptors::)</bridgehead>
+ <simplelist type="vert" columns="1">
+ <member><link linkend="geometry.reference.spatial_indexes.group__adaptors.queried_predicates_const___">queried(Predicates const &)</link></member>
+ </simplelist>
+ </entry>
+ <entry valign="top">
+ <bridgehead renderas="sect3">Predicates (boost::geometry::index::)</bridgehead>
+ <simplelist type="vert" columns="1">
+ <member><link linkend="geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___">covered_by(Geometry const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.group__predicates.disjoint_geometry_const___">disjoint(Geometry const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.group__predicates.intersects_geometry_const___">intersects(Geometry const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.group__predicates.overlaps_geometry_const___">overlaps(Geometry const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.group__predicates.within_geometry_const___">within(Geometry const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___">satisfies(UnaryPredicate const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.group__predicates.nearest_pointorrelation_const____unsigned_">nearest(PointOrRelation const &, unsigned)</link></member>
+ </simplelist>
+ </entry>
+ <entry valign="top">
+ <bridgehead renderas="sect3">Nearest relations (boost::geometry::index::)</bridgehead>
+ <simplelist type="vert" columns="1">
+ <member><link linkend="geometry.reference.spatial_indexes.group__nearest__relations.to_nearest_t_const___">to_nearest(T const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.group__nearest__relations.to_centroid_t_const___">to_centroid(T const &)</link></member>
+ <member><link linkend="geometry.reference.spatial_indexes.group__nearest__relations.to_furthest_t_const___">to_furthest(T const &) </link></member>
+ </simplelist>
+ </entry>
+ </row>
+ </tbody>
+</tgroup>
</informaltable>
Modified: trunk/libs/geometry/doc/reference.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference.qbk (original)
+++ trunk/libs/geometry/doc/reference.qbk 2013-04-03 15:05:33 EDT (Wed, 03 Apr 2013)
@@ -244,11 +244,9 @@
[section:spatial_indexes Spatial indexes]
[section:rtree R-tree]
-
[include index/generated/rtree.qbk]
[include index/generated/rtree_functions.qbk]
-
-[section:parameters Parameters (boost::geometry::index::)]
+[section:parameters R-tree parameters (boost::geometry::index::)]
[include index/generated/rtree_linear.qbk]
[include index/generated/rtree_quadratic.qbk]
[include index/generated/rtree_rstar.qbk]
@@ -256,18 +254,17 @@
[include index/generated/rtree_dynamic_quadratic.qbk]
[include index/generated/rtree_dynamic_rstar.qbk]
[endsect]
-
[endsect]
-[/section:function_objects Function objects (boost::geometry::index::)/]
+[section:observers Observers (boost::geometry::index::)]
[include index/generated/indexable.qbk]
[include index/generated/equal_to.qbk]
-[/endsect/]
+[endsect]
+[include index/generated/inserters.qbk]
+[include index/generated/adaptors.qbk]
[include index/generated/predicates.qbk]
[include index/generated/nearest_relations.qbk]
-[include index/generated/adaptors.qbk]
-[include index/generated/inserters.qbk]
[endsect]