geos_390_docs/STRtree_8h_source.html

94 lines
38 KiB
HTML
Raw Permalink Normal View History

2020-12-23 18:34:09 -08:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>GEOS: STRtree.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">GEOS
&#160;<span id="projectnumber">3.9.1dev</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0bc14b2fb119a11b6a0f32f4d350db61.html">geos</a></li><li class="navelem"><a class="el" href="dir_c01eee2f0195f7c921c8a1b68ed5e74c.html">index</a></li><li class="navelem"><a class="el" href="dir_03a38dff07b10298d54d94416a9986ca.html">strtree</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">STRtree.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="STRtree_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/**********************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * GEOS - Geometry Engine Open Source</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * http://geos.osgeo.org</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Copyright (C) 2006 Refractions Research Inc.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * This is free software; you can redistribute and/or modify it under</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * the terms of the GNU Lesser General Public Licence as published</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * by the Free Software Foundation.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * See the COPYING file for more information.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> **********************************************************************</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * Last port: index/strtree/STRtree.java rev. 1.11</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> **********************************************************************/</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef GEOS_INDEX_STRTREE_STRTREE_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define GEOS_INDEX_STRTREE_STRTREE_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="export_8h.html">geos/export.h</a>&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="ItemDistance_8h.html">geos/index/strtree/ItemDistance.h</a>&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="BoundablePair_8h.html">geos/index/strtree/BoundablePair.h</a>&gt;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="AbstractSTRtree_8h.html">geos/index/strtree/AbstractSTRtree.h</a>&gt;</span> <span class="comment">// for inheritance</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &l
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1STRtree_html_aeeefc3bd447342e9b4be2d8123487644"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1STRtree.html#aeeefc3bd447342e9b4be2d8123487644">geos::index::strtree::STRtree::intersectsOp</a></div><div class="ttdeci">STRIntersectsOp intersectsOp</div><div class="ttdef"><b>Definition:</b> <a href="STRtree_8h_source.html#l00086">STRtree.h:86</a></div></div>
<div class="ttc" id="export_8h_html_ae36df939090171f6e9a28a8cb6254fea"><div class="ttname"><a href="export_8h.html#ae36df939090171f6e9a28a8cb6254fea">GEOS_DLL</a></div><div class="ttdeci">#define GEOS_DLL</div><div class="ttdef"><b>Definition:</b> <a href="export_8h_source.html#l00028">export.h:28</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1AbstractSTRtree_html"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1AbstractSTRtree.html">geos::index::strtree::AbstractSTRtree</a></div><div class="ttdoc">Base class for STRtree and SIRtree. </div><div class="ttdef"><b>Definition:</b> <a href="AbstractSTRtree_8h_source.html#l00139">AbstractSTRtree.h:139</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1AbstractSTRtree_html_a668b51c0354bee9934ebeca13f68d8b1"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1AbstractSTRtree.html#a668b51c0354bee9934ebeca13f68d8b1">geos::index::strtree::AbstractSTRtree::query</a></div><div class="ttdeci">void query(const void *searchBounds, std::vector&lt; void * &gt; &amp;foundItems)</div><div class="ttdoc">Also builds the tree, if necessary. </div></div>
<div class="ttc" id="export_8h_html"><div class="ttname"><a href="export_8h.html">export.h</a></div></div>
<div class="ttc" id="BoundablePair_8h_html"><div class="ttname"><a href="BoundablePair_8h.html">BoundablePair.h</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1STRtree_html_aa31a264493ad5a307769c1feb67d1371"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1STRtree.html#aa31a264493ad5a307769c1feb67d1371">geos::index::strtree::STRtree::query</a></div><div class="ttdeci">void query(const geom::Envelope *searchEnv, std::vector&lt; void * &gt; &amp;matches) override</div><div class="ttdoc">Queries the index for all items whose extents intersect the given search Envelope. </div><div class="ttdef"><b>Definition:</b> <a href="STRtree_8h_source.html#l00143">STRtree.h:143</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1STRtree_1_1STRIntersectsOp_html"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1STRtree_1_1STRIntersectsOp.html">geos::index::strtree::STRtree::STRIntersectsOp</a></div><div class="ttdef"><b>Definition:</b> <a href="STRtree_8h_source.html#l00069">STRtree.h:69</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1STRtree_html_a4e3e30e9905a1abe0cd2db1c2c98d32f"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1STRtree.html#a4e3e30e9905a1abe0cd2db1c2c98d32f">geos::index::strtree::STRtree::query</a></div><div class="ttdeci">void query(const geom::Envelope *searchEnv, ItemVisitor &amp;visitor) override</div><div class="ttdoc">Queries the index for all items whose extents intersect the given search Envelope and applies an Item...</div><div class="ttdef"><b>Definition:</b> <a href="STRtree_8h_source.html#l00149">STRtree.h:149</a></div></div>
<div class="ttc" id="classgeos_1_1geom_1_1Envelope_html_ae8f01c5ddb0eb2aaeff5510eaebee3ab"><div class="ttname"><a href="classgeos_1_1geom_1_1Envelope.html#ae8f01c5ddb0eb2aaeff5510eaebee3ab">geos::geom::Envelope::getMinY</a></div><div class="ttdeci">double getMinY() const </div><div class="ttdoc">Returns the Envelope minimum y-value. min y &gt; max y indicates that this is a null Envelope...</div></div>
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1STRtree_html"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1STRtree.html">geos::index::strtree::STRtree</a></div><div class="ttdoc">A query-only R-tree created using the Sort-Tile-Recursive (STR) algorithm. For two-dimensional spatia...</div><div class="ttdef"><b>Definition:</b> <a href="STRtree_8h_source.html#l00064">STRtree.h:64</a></div></div>
<div class="ttc" id="ItemDistance_8h_html"><div class="ttname"><a href="ItemDistance_8h.html">ItemDistance.h</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1SpatialIndex_html"><div class="ttname"><a href="classgeos_1_1index_1_1SpatialIndex.html">geos::index::SpatialIndex</a></div><div class="ttdoc">Abstract class defines basic insertion and query operations supported by classes implementing spatial...</div><div class="ttdef"><b>Definition:</b> <a href="SpatialIndex_8h_source.html#l00047">SpatialIndex.h:47</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1ItemDistance_html"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1ItemDistance.html">geos::index::strtree::ItemDistance</a></div><div class="ttdoc">A function method which computes the distance between two ItemBoundables in an STRtree. Used for Nearest Neighbour searches. </div><div class="ttdef"><b>Definition:</b> <a href="ItemDistance_8h_source.html#l00034">ItemDistance.h:34</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1AbstractSTRtree_html_a3991e1fbf32b906568759c07c48b14da"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1AbstractSTRtree.html#a3991e1fbf32b906568759c07c48b14da">geos::index::strtree::AbstractSTRtree::remove</a></div><div class="ttdeci">bool remove(const void *searchBounds, AbstractNode &amp;node, void *item)</div></div>
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1AbstractSTRtree_1_1IntersectsOp_html"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1AbstractSTRtree_1_1IntersectsOp.html">geos::index::strtree::AbstractSTRtree::IntersectsOp</a></div><div class="ttdoc">A test for intersection between two bounds, necessary because subclasses of AbstractSTRtree have diff...</div><div class="ttdef"><b>Definition:</b> <a href="AbstractSTRtree_8h_source.html#l00176">AbstractSTRtree.h:176</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1STRtree_html_ac935345cd5faba9509670304282b57d9"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1STRtree.html#ac935345cd5faba9509670304282b57d9">geos::index::strtree::STRtree::avg</a></div><div class="ttdeci">static double avg(double a, double b)</div><div class="ttdef"><b>Definition:</b> <a href="STRtree_8h_source.html#l00131">STRtree.h:131</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1ItemVisitor_html"><div class="ttname"><a href="classgeos_1_1index_1_1ItemVisitor.html">geos::index::ItemVisitor</a></div><div class="ttdoc">A visitor for items in an index. </div><div class="ttdef"><b>Definition:</b> <a href="ItemVisitor_8h_source.html#l00029">ItemVisitor.h:29</a></div></div>
<div class="ttc" id="SpatialIndex_8h_html"><div class="ttname"><a href="SpatialIndex_8h.html">SpatialIndex.h</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1AbstractSTRtree_html_a39b96138234bf16eaa9401cdc2bcc8c7"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1AbstractSTRtree.html#a39b96138234bf16eaa9401cdc2bcc8c7">geos::index::strtree::AbstractSTRtree::insert</a></div><div class="ttdeci">virtual void insert(const void *bounds, void *item)</div><div class="ttdoc">Also builds the tree, if necessary. </div></div>
<div class="ttc" id="classgeos_1_1geom_1_1Envelope_html_afe346be1da764bd27d2769a64ed99fa6"><div class="ttname"><a href="classgeos_1_1geom_1_1Envelope.html#afe346be1da764bd27d2769a64ed99fa6">geos::geom::Envelope::getMaxY</a></div><div class="ttdeci">double getMaxY() const </div><div class="ttdoc">Returns the Envelope maximum y-value. min y &gt; max y indicates that this is a null Envelope...</div></div>
<div class="ttc" id="namespacegeos_html"><div class="ttname"><a href="namespacegeos.html">geos</a></div><div class="ttdoc">Basic namespace for all GEOS functionalities. </div><div class="ttdef"><b>Definition:</b> <a href="IndexedNestedRingTester_8h_source.html#l00026">IndexedNestedRingTester.h:26</a></div></div>
<div class="ttc" id="Envelope_8h_html"><div class="ttname"><a href="Envelope_8h.html">Envelope.h</a></div></div>
<div class="ttc" id="AbstractSTRtree_8h_html"><div class="ttname"><a href="AbstractSTRtree_8h.html">AbstractSTRtree.h</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1AbstractNode_html"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1AbstractNode.html">geos::index::strtree::AbstractNode</a></div><div class="ttdoc">A node of the STR tree. </div><div class="ttdef"><b>Definition:</b> <a href="AbstractNode_8h_source.html#l00044">AbstractNode.h:44</a></div></div>
<div class="ttc" id="namespacegeos_1_1index_1_1strtree_html_add68ce1c4a60ff15e78bb77f47605dbe"><div class="ttname"><a href="namespacegeos_1_1index_1_1strtree.html#add68ce1c4a60ff15e78bb77f47605dbe">geos::index::strtree::BoundableList</a></div><div class="ttdeci">std::vector&lt; Boundable * &gt; BoundableList</div><div class="ttdoc">A list of boundables. TODO: use a list. </div><div class="ttdef"><b>Definition:</b> <a href="AbstractSTRtree_8h_source.html#l00044">AbstractSTRtree.h:44</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1STRtree_html_a85c88a85336843827b03b5aa1db2749d"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1STRtree.html#a85c88a85336843827b03b5aa1db2749d">geos::index::strtree::STRtree::getIntersectsOp</a></div><div class="ttdeci">IntersectsOp * getIntersectsOp() override</div><div class="ttdef"><b>Definition:</b> <a href="STRtree_8h_source.html#l00111">STRtree.h:111</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1STRtree_html_a7d5ba9565a68d11d80083cd1babffebe"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1STRtree.html#a7d5ba9565a68d11d80083cd1babffebe">geos::index::strtree::STRtree::centreY</a></div><div class="ttdeci">static double centreY(const geom::Envelope *e)</div><div class="ttdef"><b>Definition:</b> <a href="STRtree_8h_source.html#l00137">STRtree.h:137</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1strtree_1_1BoundablePair_html"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html">geos::index::strtree::BoundablePair</a></div><div class="ttdoc">A pair of Boundables, whose leaf items support a distance metric between them. </div><div class="ttdef"><b>Definition:</b> <a href="BoundablePair_8h_source.html#l00044">BoundablePair.h:44</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>