• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>bounds(rtree&lt;...&gt; const &amp;)</title>
5<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../../../index.html" title="Chapter 1. Geometry">
8<link rel="up" href="../group__rtree__functions.html" title="R-tree free functions (boost::geometry::index::)">
9<link rel="prev" href="empty_rtree______const___.html" title="empty(rtree&lt;...&gt; const &amp;)">
10<link rel="next" href="swap_rtree_________rtree________.html" title="swap(rtree&lt;...&gt; &amp;, rtree&lt;...&gt; &amp;)">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%"><tr>
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
15<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
16<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
20</tr></table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="empty_rtree______const___.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../group__rtree__functions.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="swap_rtree_________rtree________.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h5 class="title">
27<a name="geometry.reference.spatial_indexes.group__rtree__functions.bounds_rtree______const___"></a><a name="group__rtree__functions_1ga4e43e7720c66e88959ff511a7462a3ff"></a><a class="link" href="bounds_rtree______const___.html" title="bounds(rtree&lt;...&gt; const &amp;)">bounds(rtree&lt;...&gt;
28          const &amp;)</a>
29</h5></div></div></div>
30<p>
31            <a class="indexterm" name="idm45635673691392"></a>
32Get the box containing all stored values or an invalid box if the index
33            has no values.
34          </p>
35<h6>
36<a name="geometry.reference.spatial_indexes.group__rtree__functions.bounds_rtree______const___.h0"></a>
37            <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.bounds_rtree______const___.description"></a></span><a class="link" href="bounds_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.bounds_rtree______const___.description">Description</a>
38          </h6>
39<p>
40            It calls <code class="literal"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">::</span><span class="identifier">envelope</span><span class="special">()</span></code></code>.
41          </p>
42<h6>
43<a name="geometry.reference.spatial_indexes.group__rtree__functions.bounds_rtree______const___.h1"></a>
44            <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.bounds_rtree______const___.synopsis"></a></span><a class="link" href="bounds_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.bounds_rtree______const___.synopsis">Synopsis</a>
45          </h6>
46<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
47         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Parameters</span></code><code class="computeroutput"><span class="special">,</span></code>
48         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">IndexableGetter</span></code><code class="computeroutput"><span class="special">,</span></code>
49         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">EqualTo</span></code><code class="computeroutput"><span class="special">,</span></code>
50         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
51<code class="computeroutput"><span class="identifier">rtree</span><span class="special">&lt;</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Parameters</span><span class="special">,</span> <span class="identifier">IndexableGetter</span><span class="special">,</span> <span class="identifier">EqualTo</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">&gt;::</span><span class="identifier">bounds_type</span></code> <code class="computeroutput"><span class="identifier">bounds</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">rtree</span><span class="special">&lt;</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Parameters</span><span class="special">,</span> <span class="identifier">IndexableGetter</span><span class="special">,</span> <span class="identifier">EqualTo</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">)</span></code>
52</pre>
53<h6>
54<a name="geometry.reference.spatial_indexes.group__rtree__functions.bounds_rtree______const___.h2"></a>
55            <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.bounds_rtree______const___.parameter_s_"></a></span><a class="link" href="bounds_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.bounds_rtree______const___.parameter_s_">Parameter(s)</a>
56          </h6>
57<div class="informaltable"><table class="table">
58<colgroup>
59<col>
60<col>
61<col>
62</colgroup>
63<thead><tr>
64<th>
65                    <p>
66                      Type
67                    </p>
68                  </th>
69<th>
70                    <p>
71                      Name
72                    </p>
73                  </th>
74<th>
75                    <p>
76                      Description
77                    </p>
78                  </th>
79</tr></thead>
80<tbody><tr>
81<td>
82                    <p>
83                      <code class="computeroutput"><span class="identifier">rtree</span><span class="special">&lt;</span>
84                      <span class="identifier">Value</span><span class="special">,</span>
85                      <span class="identifier">Parameters</span><span class="special">,</span>
86                      <span class="identifier">IndexableGetter</span><span class="special">,</span>
87                      <span class="identifier">EqualTo</span><span class="special">,</span>
88                      <span class="identifier">Allocator</span> <span class="special">&gt;</span>
89                      <span class="keyword">const</span> <span class="special">&amp;</span></code>
90                    </p>
91                  </td>
92<td>
93                    <p>
94                      <code class="computeroutput"><span class="identifier">tree</span></code>
95                    </p>
96                  </td>
97<td>
98                    <p>
99                      The spatial index.
100                    </p>
101                  </td>
102</tr></tbody>
103</table></div>
104<h6>
105<a name="geometry.reference.spatial_indexes.group__rtree__functions.bounds_rtree______const___.h3"></a>
106            <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.bounds_rtree______const___.returns"></a></span><a class="link" href="bounds_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.bounds_rtree______const___.returns">Returns</a>
107          </h6>
108<p>
109            The box containing all stored values or an invalid box.
110          </p>
111</div>
112<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
113<td align="left"></td>
114<td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
115      Wulkiewicz, Oracle and/or its affiliates<p>
116        Distributed under the Boost Software License, Version 1.0. (See accompanying
117        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
118      </p>
119</div></td>
120</tr></table>
121<hr>
122<div class="spirit-nav">
123<a accesskey="p" href="empty_rtree______const___.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../group__rtree__functions.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="swap_rtree_________rtree________.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
124</div>
125</body>
126</html>
127