|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r82516 - in sandbox-branches/geometry/index/doc: generated html html/geometry_index/r_tree
From: adam.wulkiewicz_at_[hidden]
Date: 2013-01-16 22:56:25
Author: awulkiew
Date: 2013-01-16 22:56:24 EST (Wed, 16 Jan 2013)
New Revision: 82516
URL: http://svn.boost.org/trac/boost/changeset/82516
Log:
Docs changed to reflect latest code changes
Text files modified:
sandbox-branches/geometry/index/doc/generated/rtree.qbk | 12
sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk | 63 --------
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html | 285 ++-------------------------------------
sandbox-branches/geometry/index/doc/html/index.html | 2
4 files changed, 30 insertions(+), 332 deletions(-)
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-16 22:56:24 EST (Wed, 16 Jan 2013)
@@ -107,10 +107,10 @@
[[[link classboost_1_1geometry_1_1index_1_1rtree_1a89561a834563f2ed6fc782bad16143fd `size()`]][Returns the number of stored values. ]]
[[[link classboost_1_1geometry_1_1index_1_1rtree_1ae889567443b0ba0dbdb975564c55804c `empty()`]][Query if the container is empty. ]]
[[[link classboost_1_1geometry_1_1index_1_1rtree_1ae6027e42d28a4bf93e74b055c79e6b09 `clear()`]][Removes all values stored in the container. ]]
-[[[link classboost_1_1geometry_1_1index_1_1rtree_1adf62005332a5fa9119ff03185e0c5143 `box()`]][Returns the box containing all values stored in the container. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1ad534a6ed759677548f50b86dfeba07c6 `box()`]][Returns the box containing all values stored in the container. ]]
[[[link classboost_1_1geometry_1_1index_1_1rtree_1a17fce1fac81f6460d2c3a5744f4963ee `count(ValueOrIndexable const &)`]][Count Values or Indexables stored in the container. ]]
[[[link classboost_1_1geometry_1_1index_1_1rtree_1a18910715f67608ff010556ac41f51606 `parameters()`]][Returns parameters. ]]
-[[[link classboost_1_1geometry_1_1index_1_1rtree_1abcbe5bb1a70a7fec518fe4dd8baa750c `translator()`]][Returns the translator object. ]]
+[[[link classboost_1_1geometry_1_1index_1_1rtree_1afc7e9a4bd53a58552c17c1e7cb997258 `translator()`]][Returns the translator object. ]]
[[[link classboost_1_1geometry_1_1index_1_1rtree_1a1eeb303253f4cabe3a89a82ed41247ff `get_allocator()`]][Returns allocator used by the rtree. ]]
]
@@ -933,7 +933,7 @@
[endsect]
-[#classboost_1_1geometry_1_1index_1_1rtree_1adf62005332a5fa9119ff03185e0c5143]
+[#classboost_1_1geometry_1_1index_1_1rtree_1ad534a6ed759677548f50b86dfeba07c6]
[section box()]
Returns the box containing all values stored in the container.
@@ -941,7 +941,7 @@
Returns the box containing all values stored in the container. If the container is empty the result of [^`geometry::assign_inverse()`] is returned.[heading Synopsis]
[pre
-[^[link classboost_1_1geometry_1_1index_1_1rtree_1a42d0c9efffbc6f3935b5b9c3dd31e50d box_type]] `box``()`
+[^[link classboost_1_1geometry_1_1index_1_1rtree_1a42d0c9efffbc6f3935b5b9c3dd31e50d box_type]]` const &` `box``()`
]
[heading Returns]
@@ -991,14 +991,14 @@
[endsect]
-[#classboost_1_1geometry_1_1index_1_1rtree_1abcbe5bb1a70a7fec518fe4dd8baa750c]
+[#classboost_1_1geometry_1_1index_1_1rtree_1afc7e9a4bd53a58552c17c1e7cb997258]
[section translator()]
Returns the translator object.
[heading Synopsis]
[pre
-`const `[^[link classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91 translator_type]]` &` `translator``()`
+[^[link classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91 translator_type]]` const &` `translator``()`
]
[heading Returns]
Modified: sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk 2013-01-16 22:56:24 EST (Wed, 16 Jan 2013)
@@ -18,9 +18,7 @@
[[[link group__rtree__functions_1ga0c65d7b29b1edf72f1d236ccf211f63c `clear(rtree<...> &)`]][Remove all values from the index. ]]
[[[link group__rtree__functions_1gaec0b88a9d8b408753e3069134f1598c7 `size(rtree<...> const &)`]][Get the number of values stored in the index. ]]
[[[link group__rtree__functions_1ga459e3d404fec7cbd66794714cbdd129e `empty(rtree<...> const &)`]][Query if there are no values stored in the index. ]]
-[[[link group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d `box(rtree<...> const &)`]][Get the box containing all stored values or an invalid box if the index has no values. ]]
-[[[link group__rtree__functions_1gab3425094aa846b167789ac76114696f6 `envelope(index::rtree<...> const &, Box &)`]][Get the box containing all stored values or an invalid box if the index has no values. ]]
-[[[link group__rtree__functions_1gaab92d20f98edefccee1e76c1349a5127 `return_envelope(index::rtree<...> const &)`]][Get the box containing all stored values or an invalid box if the index has no values. ]]
+[[[link group__rtree__functions_1gad039bb35d79bded11a1454601f6eed3a `box(rtree<...> const &)`]][Get the box containing all stored values or an invalid box if the index has no values. ]]
]
[#group__rtree__functions_1gac0ac9ed0e01f7494a5a3059e75d3c5cc]
@@ -397,18 +395,18 @@
true if there are no values in the index.
[endsect]
-[#group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d]
+[#group__rtree__functions_1gad039bb35d79bded11a1454601f6eed3a]
[section box(rtree<...> const &)]
Get the box containing all stored values or an invalid box if the index has no values.
[heading Description]
-It calls [^[link classboost_1_1geometry_1_1index_1_1rtree_1adf62005332a5fa9119ff03185e0c5143 rtree::box()]].[heading Synopsis]
+It calls [^[link classboost_1_1geometry_1_1index_1_1rtree_1ad534a6ed759677548f50b86dfeba07c6 rtree::box()]].[heading Synopsis]
[pre
`template<``typename Value``,`
`typename Options``,`
`typename Translator``,`
`typename Allocator``>`
-`rtree<Value, Options, Translator, Allocator>::box_type boost::geometry::index::box``(``rtree< Value, Options, Translator, Allocator > const &` `tree``)`
+`rtree<Value, Options, Translator, Allocator>::box_type const& boost::geometry::index::box``(``rtree< Value, Options, Translator, Allocator > const &` `tree``)`
]
[heading Parameter(s)]
@@ -420,58 +418,5 @@
The box containing all stored values or an invalid box.
[endsect]
-[#group__rtree__functions_1gab3425094aa846b167789ac76114696f6]
-[section envelope(index::rtree<...> const &, Box &)]
-Get the box containing all stored values or an invalid box if the index has no values.
-
-[heading Description]
-It calls [^[link group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d rtree::box()]].[heading Synopsis]
-[pre
-`template<``typename Value``,`
- `typename Options``,`
- `typename Translator``,`
- `typename Allocator``,`
- `typename Box``>`
-`void boost::geometry::envelope``(``index::rtree< Value, Options, Translator, Allocator > const &` `tree``,` `Box &` `box``)`
-]
-
-[heading Parameter(s)]
-[table
-[[Type][Name][Description]]
-[[`index::rtree< Value, Options, Translator, Allocator > const &`][ `tree` ][The spatial index. ]]
-[[`Box &`][ `box` ][The object to which box containing all stored values or an invalid box will be assigned. ]]
-]
-[endsect]
-
-[#group__rtree__functions_1gaab92d20f98edefccee1e76c1349a5127]
-[section return_envelope(index::rtree<...> const &)]
-Get the box containing all stored values or an invalid box if the index has no values.
-
-[heading Description]
-It calls [^[link group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d rtree::box()]].[heading Synopsis]
-[pre
-`template<``typename Box``,`
- `typename Value``,`
- `typename Options``,`
- `typename Translator``,`
- `typename Allocator``>`
-`Box boost::geometry::return_envelope``(``index::rtree< Value, Options, Translator, Allocator > const &` `tree``)`
-]
-
-[heading Template parameter(s)]
-[table
-[[Parameter] [Description]]
-[[`Box`][The type of returned Box.]]
-]
-
-[heading Parameter(s)]
-[table
-[[Type][Name][Description]]
-[[`index::rtree< Value, Options, Translator, Allocator > const &`][ `tree` ][The spatial index.]]
-]
-[heading Returns]
-The box containing all stored values or an invalid box.
-[endsect]
-
[endsect]
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-16 22:56:24 EST (Wed, 16 Jan 2013)
@@ -47,7 +47,7 @@
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree"></a><a name="classboost_1_1geometry_1_1index_1_1rtree"></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="idp9880416"></a><a class="indexterm" name="idp9880728"></a><a class="indexterm" name="idp9881040"></a><a class="indexterm" name="idp9881352"></a>
+ <a class="indexterm" name="idp9877200"></a><a class="indexterm" name="idp9877512"></a><a class="indexterm" name="idp9877824"></a><a class="indexterm" name="idp9878136"></a>
The R-tree spatial index.
</p>
<h6>
@@ -707,7 +707,7 @@
<tr>
<td>
<p>
- <a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adf62005332a5fa9119ff03185e0c5143"><code class="computeroutput"><span class="identifier">box</span><span class="special">()</span></code></a>
+ <a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ad534a6ed759677548f50b86dfeba07c6"><code class="computeroutput"><span class="identifier">box</span><span class="special">()</span></code></a>
</p>
</td>
<td>
@@ -744,7 +744,7 @@
<tr>
<td>
<p>
- <a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1abcbe5bb1a70a7fec518fe4dd8baa750c"><code class="computeroutput"><span class="identifier">translator</span><span class="special">()</span></code></a>
+ <a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1afc7e9a4bd53a58552c17c1e7cb997258"><code class="computeroutput"><span class="identifier">translator</span><span class="special">()</span></code></a>
</p>
</td>
<td>
@@ -3533,7 +3533,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.box__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1adf62005332a5fa9119ff03185e0c5143"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.box__" title="box()">box()</a>
+<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.box__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1ad534a6ed759677548f50b86dfeba07c6"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.box__" title="box()">box()</a>
</h5></div></div></div>
<p>
Returns the box containing all values stored in the container.
@@ -3550,7 +3550,7 @@
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.h1"></a>
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.synopsis">Synopsis</a>
</h6>
-<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a42d0c9efffbc6f3935b5b9c3dd31e50d">box_type</a></code> <code class="computeroutput"><span class="identifier">box</span></code><code class="computeroutput"><span class="special">()</span></code>
+<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a42d0c9efffbc6f3935b5b9c3dd31e50d">box_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">box</span></code><code class="computeroutput"><span class="special">()</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.h2"></a>
@@ -3683,7 +3683,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1abcbe5bb1a70a7fec518fe4dd8baa750c"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__" title="translator()">translator()</a>
+<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1afc7e9a4bd53a58552c17c1e7cb997258"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__" title="translator()">translator()</a>
</h5></div></div></div>
<p>
Returns the translator object.
@@ -3692,7 +3692,7 @@
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__.h0"></a>
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__.synopsis">Synopsis</a>
</h6>
-<pre class="programlisting"><code class="computeroutput"><span class="keyword">const</span> </code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">translator</span></code><code class="computeroutput"><span class="special">()</span></code>
+<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">translator</span></code><code class="computeroutput"><span class="special">()</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__.h1"></a>
@@ -3968,36 +3968,7 @@
<tr>
<td>
<p>
- <a class="link" href="reference.html#group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d"><code class="computeroutput"><span class="identifier">box</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
- <span class="keyword">const</span> <span class="special">&)</span></code></a>
- </p>
- </td>
-<td>
- <p>
- Get the box containing all stored values or an invalid box if
- the index has no values.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <a class="link" href="reference.html#group__rtree__functions_1gab3425094aa846b167789ac76114696f6"><code class="computeroutput"><span class="identifier">envelope</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="keyword">const</span> <span class="special">&,</span>
- <span class="identifier">Box</span> <span class="special">&)</span></code></a>
- </p>
- </td>
-<td>
- <p>
- Get the box containing all stored values or an invalid box if
- the index has no values.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <a class="link" href="reference.html#group__rtree__functions_1gaab92d20f98edefccee1e76c1349a5127"><code class="computeroutput"><span class="identifier">return_envelope</span><span class="special">(</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><...></span>
+ <a class="link" href="reference.html#group__rtree__functions_1gad039bb35d79bded11a1454601f6eed3a"><code class="computeroutput"><span class="identifier">box</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
<span class="keyword">const</span> <span class="special">&)</span></code></a>
</p>
</td>
@@ -5626,7 +5597,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___"></a><a name="group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___" title="box(rtree<...> const &)">box(rtree<...>
+<a name="geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___"></a><a name="group__rtree__functions_1gad039bb35d79bded11a1454601f6eed3a"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___" title="box(rtree<...> const &)">box(rtree<...>
const &)</a>
</h5></div></div></div>
<p>
@@ -5638,7 +5609,7 @@
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___.description">Description</a>
</h6>
<p>
- It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adf62005332a5fa9119ff03185e0c5143">rtree::box()</a></code>.
+ It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ad534a6ed759677548f50b86dfeba07c6">rtree::box()</a></code>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___.h1"></a>
@@ -5648,7 +5619,7 @@
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">></span></code>
-<code class="computeroutput"><span class="identifier">rtree</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span><span class="special">>::</span><span class="identifier">box_type</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">box</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">rtree</span><span class="special"><</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Options</span><span class="special">,</span> <span class="identifier">Translator</span>
<span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">)</span></code>
+<code class="computeroutput"><span class="identifier">rtree</span><span class="special"><</span><span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span><span class="special">>::</span><span class="identifier">box_type</span> <span class="keyword">const</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">index</span><span class="special">::</span><span class="identifier">box</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">rtree</span><span class="special"><</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Options</span><spa
n class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___.h2"></a>
@@ -5708,224 +5679,6 @@
The box containing all stored values or an invalid box.
</p>
</div>
-<div class="section">
-<div class="titlepage"><div><div><h5 class="title">
-<a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___"></a><a name="group__rtree__functions_1gab3425094aa846b167789ac76114696f6"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___" title="envelope(index::rtree<...> const &, Box &)">envelope(index::rtree<...>
- const &, Box &)</a>
-</h5></div></div></div>
-<p>
- Get the box containing all stored values or an invalid box if the index
- has no values.
- </p>
-<h6>
-<a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.h0"></a>
- <span><a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.description">Description</a>
- </h6>
-<p>
- It calls <code class="literal"><a class="link" href="reference.html#group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d">rtree::box()</a></code>.
- </p>
-<h6>
-<a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.h1"></a>
- <span><a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.synopsis">Synopsis</a>
- </h6>
-<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special"><</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
- <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
- <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
- <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
- <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Box</span></code><code class="computeroutput"><span class="special">></span></code>
-<code class="computeroutput"><span class="keyword">void</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">envelope</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span c
lass="identifier">Box</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">box</span></code><code class="computeroutput"><span class="special">)</span></code>
-</pre>
-<h6>
-<a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.h2"></a>
- <span><a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.parameter_s_">Parameter(s)</a>
- </h6>
-<div class="informaltable"><table class="table">
-<colgroup>
-<col>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- <p>
- Type
- </p>
- </th>
-<th>
- <p>
- Name
- </p>
- </th>
-<th>
- <p>
- Description
- </p>
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- <p>
- <code class="computeroutput"><span class="identifier">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><</span>
- <span class="identifier">Value</span><span class="special">,</span>
- <span class="identifier">Options</span><span class="special">,</span>
- <span class="identifier">Translator</span><span class="special">,</span>
- <span class="identifier">Allocator</span> <span class="special">></span>
- <span class="keyword">const</span> <span class="special">&</span></code>
- </p>
- </td>
-<td>
- <p>
- <code class="computeroutput"><span class="identifier">tree</span></code>
- </p>
- </td>
-<td>
- <p>
- The spatial index.
- </p>
- </td>
-</tr>
-<tr>
-<td>
- <p>
- <code class="computeroutput"><span class="identifier">Box</span> <span class="special">&</span></code>
- </p>
- </td>
-<td>
- <p>
- <code class="computeroutput"><span class="identifier">box</span></code>
- </p>
- </td>
-<td>
- <p>
- The object to which box containing all stored values or an
- invalid box will be assigned.
- </p>
- </td>
-</tr>
-</tbody>
-</table></div>
-</div>
-<div class="section">
-<div class="titlepage"><div><div><h5 class="title">
-<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___"></a><a name="group__rtree__functions_1gaab92d20f98edefccee1e76c1349a5127"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___" title="return_envelope(index::rtree<...> const &)">return_envelope(index::rtree<...>
- const &)</a>
-</h5></div></div></div>
-<p>
- Get the box containing all stored values or an invalid box if the index
- has no values.
- </p>
-<h6>
-<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.h0"></a>
- <span><a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.description">Description</a>
- </h6>
-<p>
- It calls <code class="literal"><a class="link" href="reference.html#group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d">rtree::box()</a></code>.
- </p>
-<h6>
-<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.h1"></a>
- <span><a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.synopsis">Synopsis</a>
- </h6>
-<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special"><</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Box</span></code><code class="computeroutput"><span class="special">,</span></code>
- <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
- <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
- <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
- <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">></span></code>
-<code class="computeroutput"><span class="identifier">Box</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">return_envelope</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">)</span></code>
-</pre>
-<h6>
-<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.h2"></a>
- <span><a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.template_parameter_s_">Template
- parameter(s)</a>
- </h6>
-<div class="informaltable"><table class="table">
-<colgroup>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- <p>
- Parameter
- </p>
- </th>
-<th>
- <p>
- Description
- </p>
- </th>
-</tr></thead>
-<tbody><tr>
-<td>
- <p>
- <code class="computeroutput"><span class="identifier">Box</span></code>
- </p>
- </td>
-<td>
- <p>
- The type of returned Box.
- </p>
- </td>
-</tr></tbody>
-</table></div>
-<h6>
-<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.h3"></a>
- <span><a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.parameter_s_">Parameter(s)</a>
- </h6>
-<div class="informaltable"><table class="table">
-<colgroup>
-<col>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- <p>
- Type
- </p>
- </th>
-<th>
- <p>
- Name
- </p>
- </th>
-<th>
- <p>
- Description
- </p>
- </th>
-</tr></thead>
-<tbody><tr>
-<td>
- <p>
- <code class="computeroutput"><span class="identifier">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><</span>
- <span class="identifier">Value</span><span class="special">,</span>
- <span class="identifier">Options</span><span class="special">,</span>
- <span class="identifier">Translator</span><span class="special">,</span>
- <span class="identifier">Allocator</span> <span class="special">></span>
- <span class="keyword">const</span> <span class="special">&</span></code>
- </p>
- </td>
-<td>
- <p>
- <code class="computeroutput"><span class="identifier">tree</span></code>
- </p>
- </td>
-<td>
- <p>
- The spatial index.
- </p>
- </td>
-</tr></tbody>
-</table></div>
-<h6>
-<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.h4"></a>
- <span><a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.returns">Returns</a>
- </h6>
-<p>
- The box containing all stored values or an invalid box.
- </p>
-</div>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
@@ -5937,7 +5690,7 @@
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_linear"></a><a name="structboost_1_1geometry_1_1index_1_1linear"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_linear" title="boost::geometry::index::linear">boost::geometry::index::linear</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="idp11777264"></a><a class="indexterm" name="idp11777592"></a><a class="indexterm" name="idp11777936"></a><a class="indexterm" name="idp11778280"></a>
+ <a class="indexterm" name="idp11685832"></a><a class="indexterm" name="idp11686160"></a><a class="indexterm" name="idp11686504"></a><a class="indexterm" name="idp11686848"></a>
Linear r-tree creation algorithm parameters.
</p>
<h6>
@@ -6012,7 +5765,7 @@
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_quadratic"></a><a name="structboost_1_1geometry_1_1index_1_1quadratic"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_quadratic" title="boost::geometry::index::quadratic">boost::geometry::index::quadratic</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="idp11803328"></a><a class="indexterm" name="idp11803656"></a><a class="indexterm" name="idp11804000"></a><a class="indexterm" name="idp11804344"></a>
+ <a class="indexterm" name="idp11711888"></a><a class="indexterm" name="idp11712216"></a><a class="indexterm" name="idp11712560"></a><a class="indexterm" name="idp11712904"></a>
Quadratic r-tree creation algorithm parameters.
</p>
<h6>
@@ -6087,7 +5840,7 @@
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_rstar"></a><a name="structboost_1_1geometry_1_1index_1_1rstar"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_rstar" title="boost::geometry::index::rstar">boost::geometry::index::rstar</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="idp11829472"></a><a class="indexterm" name="idp11829800"></a><a class="indexterm" name="idp11830144"></a><a class="indexterm" name="idp11830488"></a>
+ <a class="indexterm" name="idp11737976"></a><a class="indexterm" name="idp11738304"></a><a class="indexterm" name="idp11738648"></a><a class="indexterm" name="idp11738992"></a>
R*-tree creation algorithm parameters.
</p>
<h6>
@@ -6191,7 +5944,7 @@
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear"></a><a name="classboost_1_1geometry_1_1index_1_1runtime_1_1linear"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear" title="boost::geometry::index::runtime::linear">boost::geometry::index::runtime::linear</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="idp11865344"></a><a class="indexterm" name="idp11865672"></a><a class="indexterm" name="idp11866016"></a><a class="indexterm" name="idp11866360"></a><a class="indexterm" name="idp11866704"></a>
+ <a class="indexterm" name="idp11773808"></a><a class="indexterm" name="idp11774136"></a><a class="indexterm" name="idp11774480"></a><a class="indexterm" name="idp11774824"></a><a class="indexterm" name="idp11775168"></a>
Linear r-tree creation algorithm parameters.
</p>
<h6>
@@ -6327,7 +6080,7 @@
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic"></a><a name="classboost_1_1geometry_1_1index_1_1runtime_1_1quadratic"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic" title="boost::geometry::index::runtime::quadratic">boost::geometry::index::runtime::quadratic</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="idp11906312"></a><a class="indexterm" name="idp11906640"></a><a class="indexterm" name="idp11906984"></a><a class="indexterm" name="idp11907328"></a><a class="indexterm" name="idp11907672"></a>
+ <a class="indexterm" name="idp11814688"></a><a class="indexterm" name="idp11815016"></a><a class="indexterm" name="idp11815360"></a><a class="indexterm" name="idp11815704"></a><a class="indexterm" name="idp11816048"></a>
Quadratic r-tree creation algorithm parameters.
</p>
<h6>
@@ -6463,7 +6216,7 @@
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar"></a><a name="classboost_1_1geometry_1_1index_1_1runtime_1_1rstar"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar" title="boost::geometry::index::runtime::rstar">boost::geometry::index::runtime::rstar</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="idp11947320"></a><a class="indexterm" name="idp11947648"></a><a class="indexterm" name="idp11947992"></a><a class="indexterm" name="idp11948336"></a><a class="indexterm" name="idp11948680"></a>
+ <a class="indexterm" name="idp11855832"></a><a class="indexterm" name="idp11856160"></a><a class="indexterm" name="idp11856504"></a><a class="indexterm" name="idp11856848"></a><a class="indexterm" name="idp11857192"></a>
R*-tree creation algorithm parameters.
</p>
<h6>
@@ -8795,7 +8548,7 @@
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def"></a><a name="structboost_1_1geometry_1_1index_1_1translator_1_1def"></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="idp12635920"></a><a class="indexterm" name="idp12636248"></a><a class="indexterm" name="idp12636592"></a><a class="indexterm" name="idp12636936"></a><a class="indexterm" name="idp12637280"></a>
+ <a class="indexterm" name="idp12535432"></a><a class="indexterm" name="idp12535760"></a><a class="indexterm" name="idp12536104"></a><a class="indexterm" name="idp12536448"></a><a class="indexterm" name="idp12536792"></a>
The default translator.
</p>
<h6>
@@ -8865,7 +8618,7 @@
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index"></a><a name="classboost_1_1geometry_1_1index_1_1translator_1_1index"></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="idp12661208"></a><a class="indexterm" name="idp12661536"></a><a class="indexterm" name="idp12661880"></a><a class="indexterm" name="idp12662224"></a><a class="indexterm" name="idp12662568"></a>
+ <a class="indexterm" name="idp12560680"></a><a class="indexterm" name="idp12561008"></a><a class="indexterm" name="idp12561352"></a><a class="indexterm" name="idp12561696"></a><a class="indexterm" name="idp12562040"></a>
The index translator.
</p>
<h6>
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-16 22:56:24 EST (Wed, 16 Jan 2013)
@@ -52,7 +52,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 16, 2013 at 14:44:32 GMT</small></p></td>
+<td align="left"><p><small>Last revised: January 17, 2013 at 03:55:35 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
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