blob: 03015f00c86e031b57fa1670cfd2aa0e8a0aa8a4 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Quick start</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Geometry">
<link rel="up" href="../rtree_examples.html" title="Examples">
<link rel="prev" href="../rtree_examples.html" title="Examples">
<link rel="next" href="index_of_polygons_stored_in_vector.html" title="Index of polygons stored in vector">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../rtree_examples.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../rtree_examples.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="index_of_polygons_stored_in_vector.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="geometry.spatial_indexes.rtree_examples.quick_start"></a><a class="link" href="quick_start.html" title="Quick start">Quick
start</a>
</h4></div></div></div>
<p>
</p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">point</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">box</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</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">rtree</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="comment">// to store queries results</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">vector</span><span class="special">&gt;</span>
<span class="comment">// just for output</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">foreach</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="keyword">namespace</span> <span class="identifier">bg</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="keyword">namespace</span> <span class="identifier">bgi</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="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
<span class="special">{</span>
<span class="keyword">typedef</span> <span class="identifier">bg</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">point</span><span class="special">&lt;</span><span class="keyword">float</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="identifier">bg</span><span class="special">::</span><span class="identifier">cs</span><span class="special">::</span><span class="identifier">cartesian</span><span class="special">&gt;</span> <span class="identifier">point</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">bg</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">box</span><span class="special">&lt;</span><span class="identifier">point</span><span class="special">&gt;</span> <span class="identifier">box</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span><span class="identifier">box</span><span class="special">,</span> <span class="keyword">unsigned</span><span class="special">&gt;</span> <span class="identifier">value</span><span class="special">;</span>
<span class="comment">// create the rtree using default constructor</span>
<span class="identifier">bgi</span><span class="special">::</span><span class="identifier">rtree</span><span class="special">&lt;</span> <span class="identifier">value</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">quadratic</span><span class="special">&lt;</span><span class="number">16</span><span class="special">&gt;</span> <span class="special">&gt;</span> <span class="identifier">rtree</span><span class="special">;</span>
<span class="comment">// create some values</span>
<span class="keyword">for</span> <span class="special">(</span> <span class="keyword">unsigned</span> <span class="identifier">i</span> <span class="special">=</span> <span class="number">0</span> <span class="special">;</span> <span class="identifier">i</span> <span class="special">&lt;</span> <span class="number">10</span> <span class="special">;</span> <span class="special">++</span><span class="identifier">i</span> <span class="special">)</span>
<span class="special">{</span>
<span class="comment">// create a box</span>
<span class="identifier">box</span> <span class="identifier">b</span><span class="special">(</span><span class="identifier">point</span><span class="special">(</span><span class="identifier">i</span> <span class="special">+</span> <span class="number">0.0f</span><span class="special">,</span> <span class="identifier">i</span> <span class="special">+</span> <span class="number">0.0f</span><span class="special">),</span> <span class="identifier">point</span><span class="special">(</span><span class="identifier">i</span> <span class="special">+</span> <span class="number">0.5f</span><span class="special">,</span> <span class="identifier">i</span> <span class="special">+</span> <span class="number">0.5f</span><span class="special">));</span>
<span class="comment">// insert new value</span>
<span class="identifier">rtree</span><span class="special">.</span><span class="identifier">insert</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">make_pair</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">i</span><span class="special">));</span>
<span class="special">}</span>
<span class="comment">// find values intersecting some area defined by a box</span>
<span class="identifier">box</span> <span class="identifier">query_box</span><span class="special">(</span><span class="identifier">point</span><span class="special">(</span><span class="number">0</span><span class="special">,</span> <span class="number">0</span><span class="special">),</span> <span class="identifier">point</span><span class="special">(</span><span class="number">5</span><span class="special">,</span> <span class="number">5</span><span class="special">));</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="identifier">value</span><span class="special">&gt;</span> <span class="identifier">result_s</span><span class="special">;</span>
<span class="identifier">rtree</span><span class="special">.</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">query_box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result_s</span><span class="special">));</span>
<span class="comment">// find 5 nearest values to a point</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="identifier">value</span><span class="special">&gt;</span> <span class="identifier">result_n</span><span class="special">;</span>
<span class="identifier">rtree</span><span class="special">.</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">nearest</span><span class="special">(</span><span class="identifier">point</span><span class="special">(</span><span class="number">0</span><span class="special">,</span> <span class="number">0</span><span class="special">),</span> <span class="number">5</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result_n</span><span class="special">));</span>
<span class="comment">// note: in Boost.Geometry WKT representation of a box is polygon</span>
<span class="comment">// display results</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"spatial query box:"</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">bg</span><span class="special">::</span><span class="identifier">wkt</span><span class="special">&lt;</span><span class="identifier">box</span><span class="special">&gt;(</span><span class="identifier">query_box</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"spatial query result:"</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="identifier">BOOST_FOREACH</span><span class="special">(</span><span class="identifier">value</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">v</span><span class="special">,</span> <span class="identifier">result_s</span><span class="special">)</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">bg</span><span class="special">::</span><span class="identifier">wkt</span><span class="special">&lt;</span><span class="identifier">box</span><span class="special">&gt;(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">first</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="string">" - "</span> <span class="special">&lt;&lt;</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">second</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"knn query point:"</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">bg</span><span class="special">::</span><span class="identifier">wkt</span><span class="special">&lt;</span><span class="identifier">point</span><span class="special">&gt;(</span><span class="identifier">point</span><span class="special">(</span><span class="number">0</span><span class="special">,</span> <span class="number">0</span><span class="special">))</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"knn query result:"</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="identifier">BOOST_FOREACH</span><span class="special">(</span><span class="identifier">value</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">v</span><span class="special">,</span> <span class="identifier">result_n</span><span class="special">)</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">bg</span><span class="special">::</span><span class="identifier">wkt</span><span class="special">&lt;</span><span class="identifier">box</span><span class="special">&gt;(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">first</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="string">" - "</span> <span class="special">&lt;&lt;</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">second</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
<span class="special">}</span>
</pre>
<p>
</p>
<h5>
<a name="geometry.spatial_indexes.rtree_examples.quick_start.h0"></a>
<span class="phrase"><a name="geometry.spatial_indexes.rtree_examples.quick_start.expected_results"></a></span><a class="link" href="quick_start.html#geometry.spatial_indexes.rtree_examples.quick_start.expected_results">Expected
results</a>
</h5>
<pre class="programlisting"><span class="identifier">spatial</span> <span class="identifier">query</span> <span class="identifier">box</span><span class="special">:</span>
<span class="identifier">POLYGON</span><span class="special">((</span><span class="number">0</span> <span class="number">0</span><span class="special">,</span><span class="number">0</span> <span class="number">5</span><span class="special">,</span><span class="number">5</span> <span class="number">5</span><span class="special">,</span><span class="number">5</span> <span class="number">0</span><span class="special">,</span><span class="number">0</span> <span class="number">0</span><span class="special">))</span>
<span class="identifier">spatial</span> <span class="identifier">query</span> <span class="identifier">result</span><span class="special">:</span>
<span class="identifier">POLYGON</span><span class="special">((</span><span class="number">0</span> <span class="number">0</span><span class="special">,</span><span class="number">0</span> <span class="number">0.5</span><span class="special">,</span><span class="number">0.5</span> <span class="number">0.5</span><span class="special">,</span><span class="number">0.5</span> <span class="number">0</span><span class="special">,</span><span class="number">0</span> <span class="number">0</span><span class="special">))</span> <span class="special">-</span> <span class="number">0</span>
<span class="identifier">POLYGON</span><span class="special">((</span><span class="number">1</span> <span class="number">1</span><span class="special">,</span><span class="number">1</span> <span class="number">1.5</span><span class="special">,</span><span class="number">1.5</span> <span class="number">1.5</span><span class="special">,</span><span class="number">1.5</span> <span class="number">1</span><span class="special">,</span><span class="number">1</span> <span class="number">1</span><span class="special">))</span> <span class="special">-</span> <span class="number">1</span>
<span class="identifier">POLYGON</span><span class="special">((</span><span class="number">2</span> <span class="number">2</span><span class="special">,</span><span class="number">2</span> <span class="number">2.5</span><span class="special">,</span><span class="number">2.5</span> <span class="number">2.5</span><span class="special">,</span><span class="number">2.5</span> <span class="number">2</span><span class="special">,</span><span class="number">2</span> <span class="number">2</span><span class="special">))</span> <span class="special">-</span> <span class="number">2</span>
<span class="identifier">POLYGON</span><span class="special">((</span><span class="number">3</span> <span class="number">3</span><span class="special">,</span><span class="number">3</span> <span class="number">3.5</span><span class="special">,</span><span class="number">3.5</span> <span class="number">3.5</span><span class="special">,</span><span class="number">3.5</span> <span class="number">3</span><span class="special">,</span><span class="number">3</span> <span class="number">3</span><span class="special">))</span> <span class="special">-</span> <span class="number">3</span>
<span class="identifier">POLYGON</span><span class="special">((</span><span class="number">4</span> <span class="number">4</span><span class="special">,</span><span class="number">4</span> <span class="number">4.5</span><span class="special">,</span><span class="number">4.5</span> <span class="number">4.5</span><span class="special">,</span><span class="number">4.5</span> <span class="number">4</span><span class="special">,</span><span class="number">4</span> <span class="number">4</span><span class="special">))</span> <span class="special">-</span> <span class="number">4</span>
<span class="identifier">POLYGON</span><span class="special">((</span><span class="number">5</span> <span class="number">5</span><span class="special">,</span><span class="number">5</span> <span class="number">5.5</span><span class="special">,</span><span class="number">5.5</span> <span class="number">5.5</span><span class="special">,</span><span class="number">5.5</span> <span class="number">5</span><span class="special">,</span><span class="number">5</span> <span class="number">5</span><span class="special">))</span> <span class="special">-</span> <span class="number">5</span>
<span class="identifier">knn</span> <span class="identifier">query</span> <span class="identifier">point</span><span class="special">:</span>
<span class="identifier">POINT</span><span class="special">(</span><span class="number">0</span> <span class="number">0</span><span class="special">)</span>
<span class="identifier">knn</span> <span class="identifier">query</span> <span class="identifier">result</span><span class="special">:</span>
<span class="identifier">POLYGON</span><span class="special">((</span><span class="number">4</span> <span class="number">4</span><span class="special">,</span><span class="number">4</span> <span class="number">4.5</span><span class="special">,</span><span class="number">4.5</span> <span class="number">4.5</span><span class="special">,</span><span class="number">4.5</span> <span class="number">4</span><span class="special">,</span><span class="number">4</span> <span class="number">4</span><span class="special">))</span> <span class="special">-</span> <span class="number">4</span>
<span class="identifier">POLYGON</span><span class="special">((</span><span class="number">3</span> <span class="number">3</span><span class="special">,</span><span class="number">3</span> <span class="number">3.5</span><span class="special">,</span><span class="number">3.5</span> <span class="number">3.5</span><span class="special">,</span><span class="number">3.5</span> <span class="number">3</span><span class="special">,</span><span class="number">3</span> <span class="number">3</span><span class="special">))</span> <span class="special">-</span> <span class="number">3</span>
<span class="identifier">POLYGON</span><span class="special">((</span><span class="number">2</span> <span class="number">2</span><span class="special">,</span><span class="number">2</span> <span class="number">2.5</span><span class="special">,</span><span class="number">2.5</span> <span class="number">2.5</span><span class="special">,</span><span class="number">2.5</span> <span class="number">2</span><span class="special">,</span><span class="number">2</span> <span class="number">2</span><span class="special">))</span> <span class="special">-</span> <span class="number">2</span>
<span class="identifier">POLYGON</span><span class="special">((</span><span class="number">0</span> <span class="number">0</span><span class="special">,</span><span class="number">0</span> <span class="number">0.5</span><span class="special">,</span><span class="number">0.5</span> <span class="number">0.5</span><span class="special">,</span><span class="number">0.5</span> <span class="number">0</span><span class="special">,</span><span class="number">0</span> <span class="number">0</span><span class="special">))</span> <span class="special">-</span> <span class="number">0</span>
<span class="identifier">POLYGON</span><span class="special">((</span><span class="number">1</span> <span class="number">1</span><span class="special">,</span><span class="number">1</span> <span class="number">1.5</span><span class="special">,</span><span class="number">1.5</span> <span class="number">1.5</span><span class="special">,</span><span class="number">1.5</span> <span class="number">1</span><span class="special">,</span><span class="number">1</span> <span class="number">1</span><span class="special">))</span> <span class="special">-</span> <span class="number">1</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Barend Gehrels, Bruno Lalande,
Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its affiliates<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../rtree_examples.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../rtree_examples.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="index_of_polygons_stored_in_vector.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>