libs/geometry/doc/html/geometry/reference/spatial_indexes/boost__geometry__index__rtree/bounds__.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>bounds()</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&#160;1.&#160;Geometry">
   8 <link rel="up" href="../boost__geometry__index__rtree.html" title="boost::geometry::index::rtree">
   9 <link rel="prev" href="clear__.html" title="clear()">
  10 <link rel="next" href="count_valueorindexable_const___.html" title="count(ValueOrIndexable const &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="clear__.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__geometry__index__rtree.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="count_valueorindexable_const___.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.boost__geometry__index__rtree.bounds__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a2f244b24b24711dc39019198151dc2db"></a><a class="link" href="bounds__.html" title="bounds()">bounds()</a>
  28 </h5></div></div></div>
  29 <p>
  30             <a class="indexterm" name="idm46186979088080"></a>
  31 Returns the box able to contain all values stored in the container.
  32           </p>
  33 <h6>
  34 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.bounds__.h0"></a>
  35             <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.bounds__.description"></a></span><a class="link" href="bounds__.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.bounds__.description">Description</a>
  36           </h6>
  37 <p>
  38             Returns the box able to contain all values stored in the container. If
  39             the container is empty the result of <code class="literal"><code class="computeroutput"><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">assign_inverse</span><span class="special">()</span></code></code> is returned.
  40           </p>
  41 <h6>
  42 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.bounds__.h1"></a>
  43             <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.bounds__.synopsis"></a></span><a class="link" href="bounds__.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.bounds__.synopsis">Synopsis</a>
  44           </h6>
  45 <pre class="programlisting"><code class="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1a12e80f9da4c68e0e687f1c2012321147">bounds_type</a></code> <code class="computeroutput"><span class="identifier">bounds</span></code><code class="computeroutput"><span class="special">()</span></code>
  46 </pre>
  47 <h6>
  48 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.bounds__.h2"></a>
  49             <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.bounds__.modifier_s_"></a></span><a class="link" href="bounds__.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.bounds__.modifier_s_">Modifier(s)</a>
  50           </h6>
  51 <p>
  52 </p>
  53 <pre class="programlisting"><span class="keyword">const</span></pre>
  54 <p>
  55           </p>
  56 <h6>
  57 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.bounds__.h3"></a>
  58             <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.bounds__.returns"></a></span><a class="link" href="bounds__.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.bounds__.returns">Returns</a>
  59           </h6>
  60 <p>
  61             The box able to contain all values stored in the container or an invalid
  62             box if there are no values in the container.
  63           </p>
  64 <h6>
  65 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.bounds__.h4"></a>
  66             <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.bounds__.throws"></a></span><a class="link" href="bounds__.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.bounds__.throws">Throws</a>
  67           </h6>
  68 <p>
  69             Nothing.
  70           </p>
  71 </div>
  72 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  73 <td align="left"></td>
  74 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
  75       Wulkiewicz, Oracle and/or its affiliates<p>
  76         Distributed under the Boost Software License, Version 1.0. (See accompanying
  77         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>)
  78       </p>
  79 </div></td>
  80 </tr></table>
  81 <hr>
  82 <div class="spirit-nav">
  83 <a accesskey="p" href="clear__.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__geometry__index__rtree.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="count_valueorindexable_const___.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  84 </div>
  85 </body>
  86 </html>