libs/geometry/doc/html/geometry/reference/spatial_indexes/group__rtree__functions/begin_rtree______const___.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>begin(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&#160;1.&#160;Geometry">
   8 <link rel="up" href="../group__rtree__functions.html" title="R-tree free functions (boost::geometry::index::)">
   9 <link rel="prev" href="qend_rtree______const___.html" title="qend(rtree&lt;...&gt; const &amp;)">
  10 <link rel="next" href="end_rtree______const___.html" title="end(rtree&lt;...&gt; 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="qend_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="end_rtree______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.group__rtree__functions.begin_rtree______const___"></a><a name="group__rtree__functions_1ga2467dc6ac90303496abd6ebd136eba18"></a><a class="link" href="begin_rtree______const___.html" title="begin(rtree&lt;...&gt; const &amp;)">begin(rtree&lt;...&gt;
  28           const &amp;)</a>
  29 </h5></div></div></div>
  30 <p>
  31             <a class="indexterm" name="idp117925200"></a>
  32 Returns the iterator pointing at the begin of the rtree values range.
  33           </p>
  34 <h6>
  35 <a name="geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.h0"></a>
  36             <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.description"></a></span><a class="link" href="begin_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.description">Description</a>
  37           </h6>
  38 <p>
  39             This method returns the iterator which may be used to iterate over all
  40             values stored in the rtree.
  41           </p>
  42 <h6>
  43 <a name="geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.h1"></a>
  44             <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.synopsis"></a></span><a class="link" href="begin_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.begin_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">const_iterator</span></code> <code class="computeroutput"><span class="identifier">begin</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.begin_rtree______const___.h2"></a>
  55             <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.returns"></a></span><a class="link" href="begin_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.returns">Returns</a>
  56           </h6>
  57 <p>
  58             The iterator pointing at the begin of the range.
  59           </p>
  60 <h6>
  61 <a name="geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.h3"></a>
  62             <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.example"></a></span><a class="link" href="begin_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.example">Example</a>
  63           </h6>
  64 <p>
  65 </p>
  66 <pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">for_each</span><span class="special">(</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">tree</span><span class="special">),</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">tree</span><span class="special">),</span> <span class="identifier">do_something</span><span class="special">());</span>
  67 <span class="comment">// the same as</span>
  68 <span class="identifier">std</span><span class="special">::</span><span class="identifier">for_each</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">tree</span><span class="special">),</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">tree</span><span class="special">),</span> <span class="identifier">do_something</span><span class="special">());</span>
  69 </pre>
  70 <p>
  71           </p>
  72 <h6>
  73 <a name="geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.h4"></a>
  74             <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.iterator_category"></a></span><a class="link" href="begin_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.iterator_category">Iterator
  75             category</a>
  76           </h6>
  77 <p>
  78             ForwardIterator
  79           </p>
  80 <h6>
  81 <a name="geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.h5"></a>
  82             <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.throws"></a></span><a class="link" href="begin_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.begin_rtree______const___.throws">Throws</a>
  83           </h6>
  84 <p>
  85             If allocation throws.
  86           </p>
  87 <div class="warning"><table border="0" summary="Warning">
  88 <tr>
  89 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../../../doc/src/images/warning.png"></td>
  90 <th align="left">Warning</th>
  91 </tr>
  92 <tr><td align="left" valign="top"><p>
  93               The modification of the rtree may invalidate the iterators.
  94             </p></td></tr>
  95 </table></div>
  96 </div>
  97 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  98 <td align="left"></td>
  99 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2017 Barend
 100       Gehrels, Bruno Lalande, Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its
 101       affiliates<p>
 102         Distributed under the Boost Software License, Version 1.0. (See accompanying
 103         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>)
 104       </p>
 105 </div></td>
 106 </tr></table>
 107 <hr>
 108 <div class="spirit-nav">
 109 <a accesskey="p" href="qend_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="end_rtree______const___.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 110 </div>
 111 </body>
 112 </html>