EVOLUTION-MANAGER
Edit File: BoundablePair_8h_source.html
<!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.5"/> <title>GEOS: BoundablePair.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 style="padding-left: 0.5em;"> <div id="projectname">GEOS  <span id="projectnumber">3.8.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related 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 List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_c7abe0914a0ee2b00cd766c552eb2d19.html">include</a></li><li class="navelem"><a class="el" href="dir_165a26498f94b7fe2ccb32b9bb9b3ac5.html">geos</a></li><li class="navelem"><a class="el" href="dir_6aa9cc509533b63a9ccb9facff3cdf27.html">index</a></li><li class="navelem"><a class="el" href="dir_8366a4e5affccf0e5a2826b44083115e.html">strtree</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">BoundablePair.h</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**********************************************************************</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * GEOS - Geometry Engine Open Source</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * http://geos.osgeo.org</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Copyright (C) 2016 Daniel Baston</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <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> <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> <span class="comment"> * by the Free Software Foundation.</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * See the COPYING file for more information.</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> **********************************************************************</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * Last port: index/strtree/BoundablePair.java (JTS-1.14)</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> **********************************************************************/</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef GEOS_INDEX_STRTREE_BOUNDABLEPAIR_H</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor"></span><span class="preprocessor">#define GEOS_INDEX_STRTREE_BOUNDABLEPAIR_H</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <geos/index/strtree/Boundable.h></span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <geos/index/strtree/ItemDistance.h></span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <queue></span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span>geos {</div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span>index {</div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>strtree {</div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html"> 44</a></span> <span class="keyword">class </span><a class="code" href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html">BoundablePair</a> {</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">private</span>:</div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">const</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1Boundable.html">Boundable</a>* boundable1;</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">const</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1Boundable.html">Boundable</a>* boundable2;</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classgeos_1_1index_1_1strtree_1_1ItemDistance.html">ItemDistance</a>* itemDistance;</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">double</span> mDistance;</div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">struct </span>BoundablePairQueueCompare {</div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">bool</span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  operator()(<span class="keyword">const</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html">BoundablePair</a>* a, <span class="keyword">const</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html">BoundablePair</a>* b)</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  {</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">return</span> a-><a class="code" href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html#ab5fdfd61162358bc12c0ec26aaa0c7a1">getDistance</a>() > b-><a class="code" href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html#ab5fdfd61162358bc12c0ec26aaa0c7a1">getDistance</a>();</div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  }</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  };</div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">typedef</span> std::priority_queue<BoundablePair*, std::vector<BoundablePair*>, BoundablePairQueueCompare> BoundablePairQueue;</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html">BoundablePair</a>(<span class="keyword">const</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1Boundable.html">Boundable</a>* boundable1, <span class="keyword">const</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1Boundable.html">Boundable</a>* boundable2, <a class="code" href="classgeos_1_1index_1_1strtree_1_1ItemDistance.html">ItemDistance</a>* itemDistance);</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">const</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1Boundable.html">Boundable</a>* <a class="code" href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html#a432aa0d5c48581c5b207ba053b0e4a8c">getBoundable</a>(<span class="keywordtype">int</span> i) <span class="keyword">const</span>;</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">double</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html#a1d3a2059c8942d0dd8966e0eef29d762">distance</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">double</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html#ab5fdfd61162358bc12c0ec26aaa0c7a1">getDistance</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">bool</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html#a3c5283d805575ae73b2d80550d2ad391">isLeaves</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">double</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html#ac75c765ea727fc0020ad780a488c9560">maximumDistance</a>();</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> isComposite(<span class="keyword">const</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1Boundable.html">Boundable</a>* item);</div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keyword">static</span> <span class="keywordtype">double</span> area(<span class="keyword">const</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1Boundable.html">Boundable</a>* b);</div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">void</span> expandToQueue(BoundablePairQueue&, <span class="keywordtype">double</span> minDistance);</div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">void</span> expand(<span class="keyword">const</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1Boundable.html">Boundable</a>* bndComposite, <span class="keyword">const</span> <a class="code" href="classgeos_1_1index_1_1strtree_1_1Boundable.html">Boundable</a>* bndOther, <span class="keywordtype">bool</span> isFlipped, BoundablePairQueue& priQ,</div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">double</span> minDistance);</div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> };</div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> }</div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> }</div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> }</div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="preprocessor"></span></div> <div class="ttc" id="classgeos_1_1index_1_1strtree_1_1BoundablePair_html_a432aa0d5c48581c5b207ba053b0e4a8c"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html#a432aa0d5c48581c5b207ba053b0e4a8c">geos::index::strtree::BoundablePair::getBoundable</a></div><div class="ttdeci">const Boundable * getBoundable(int i) const </div></div> <div class="ttc" id="classgeos_1_1index_1_1strtree_1_1BoundablePair_html_ab5fdfd61162358bc12c0ec26aaa0c7a1"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html#ab5fdfd61162358bc12c0ec26aaa0c7a1">geos::index::strtree::BoundablePair::getDistance</a></div><div class="ttdeci">double getDistance() const </div><div class="ttdoc">Gets the minimum possible distance between the Boundables in this pair. </div></div> <div class="ttc" id="classgeos_1_1index_1_1strtree_1_1BoundablePair_html_a3c5283d805575ae73b2d80550d2ad391"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html#a3c5283d805575ae73b2d80550d2ad391">geos::index::strtree::BoundablePair::isLeaves</a></div><div class="ttdeci">bool isLeaves() const </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> ItemDistance.h:34</div></div> <div class="ttc" id="classgeos_1_1index_1_1strtree_1_1BoundablePair_html_ac75c765ea727fc0020ad780a488c9560"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html#ac75c765ea727fc0020ad780a488c9560">geos::index::strtree::BoundablePair::maximumDistance</a></div><div class="ttdeci">double maximumDistance()</div><div class="ttdoc">Computes the maximum distance between any two items in the pair of nodes. </div></div> <div class="ttc" id="classgeos_1_1index_1_1strtree_1_1Boundable_html"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1Boundable.html">geos::index::strtree::Boundable</a></div><div class="ttdoc">A spatial object in an AbstractSTRtree. </div><div class="ttdef"><b>Definition:</b> Boundable.h:25</div></div> <div class="ttc" id="classgeos_1_1index_1_1strtree_1_1BoundablePair_html_a1d3a2059c8942d0dd8966e0eef29d762"><div class="ttname"><a href="classgeos_1_1index_1_1strtree_1_1BoundablePair.html#a1d3a2059c8942d0dd8966e0eef29d762">geos::index::strtree::BoundablePair::distance</a></div><div class="ttdeci">double distance() const </div><div class="ttdoc">Computes the distance between the Boundables in this pair. The boundables are either composites or le...</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> BoundablePair.h:44</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>