darkblueb
/
geos_390_docs
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
geos_390_docs/classgeos_1_1index_1_1strtr...

408 lines
21 KiB
HTML
Raw Permalink Blame History

<!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: geos::index::strtree::SimpleSTRpair Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacegeos.html">geos</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1index.html">index</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1index_1_1strtree.html">strtree</a></li><li class="navelem"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair.html">SimpleSTRpair</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::index::strtree::SimpleSTRpair Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="SimpleSTRdistance_8h_source.html">SimpleSTRdistance.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for geos::index::strtree::SimpleSTRpair:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair__coll__graph.svg" width="390" height="380"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a50268cd84e828181151137ff936c9a1a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair.html#a50268cd84e828181151137ff936c9a1a">SimpleSTRpair</a> (<a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html">SimpleSTRnode</a> *p_node1, <a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html">SimpleSTRnode</a> *p_node2, <a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemDistance.html">ItemDistance</a> *p_itemDistance)</td></tr>
<tr class="separator:a50268cd84e828181151137ff936c9a1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a728e6ab10c2f1f128b7ad66c1a41a492"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html">SimpleSTRnode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair.html#a728e6ab10c2f1f128b7ad66c1a41a492">getNode</a> (int i) const </td></tr>
<tr class="separator:a728e6ab10c2f1f128b7ad66c1a41a492"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac401b484c09bd86a93079aa2492fe0a4"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair.html#ac401b484c09bd86a93079aa2492fe0a4">getDistance</a> () const </td></tr>
<tr class="memdesc:ac401b484c09bd86a93079aa2492fe0a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the minimum possible distance between the <a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html" title="A node of the STR tree. ">SimpleSTRnode</a> in this pair. <a href="#ac401b484c09bd86a93079aa2492fe0a4">More...</a><br /></td></tr>
<tr class="separator:ac401b484c09bd86a93079aa2492fe0a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c3ce3106e69b0d8b22c7dfb114763a7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair.html#a9c3ce3106e69b0d8b22c7dfb114763a7">isLeaves</a> () const </td></tr>
<tr class="separator:a9c3ce3106e69b0d8b22c7dfb114763a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22530eb315fb7ce68ee270206f97815d"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair.html#a22530eb315fb7ce68ee270206f97815d">maximumDistance</a> ()</td></tr>
<tr class="memdesc:a22530eb315fb7ce68ee270206f97815d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the maximum distance between any two items in the pair of nodes. <a href="#a22530eb315fb7ce68ee270206f97815d">More...</a><br /></td></tr>
<tr class="separator:a22530eb315fb7ce68ee270206f97815d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a218fb523533da43cf5ee372ba6a6a540"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair.html#a218fb523533da43cf5ee372ba6a6a540">distance</a> ()</td></tr>
<tr class="memdesc:a218fb523533da43cf5ee372ba6a6a540"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the distance between the <a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html">SimpleSTRnode</a>s in this pair. The nodes are either composites or leaves. <a href="#a218fb523533da43cf5ee372ba6a6a540">More...</a><br /></td></tr>
<tr class="separator:a218fb523533da43cf5ee372ba6a6a540"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a30a3686a4894163bd35f5e15c5b5c03d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html">SimpleSTRnode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair.html#a30a3686a4894163bd35f5e15c5b5c03d">node1</a></td></tr>
<tr class="separator:a30a3686a4894163bd35f5e15c5b5c03d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa26bd94e5f373000f34af051eee6344"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html">SimpleSTRnode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair.html#afa26bd94e5f373000f34af051eee6344">node2</a></td></tr>
<tr class="separator:afa26bd94e5f373000f34af051eee6344"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c3a54c98f2c016c79b0d71eaee6c1c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemDistance.html">ItemDistance</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair.html#a3c3a54c98f2c016c79b0d71eaee6c1c5">itemDistance</a></td></tr>
<tr class="separator:a3c3a54c98f2c016c79b0d71eaee6c1c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af88e2ea72cb36535ac51094fe60c4616"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair.html#af88e2ea72cb36535ac51094fe60c4616">m_distance</a></td></tr>
<tr class="separator:af88e2ea72cb36535ac51094fe60c4616"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:aaa88ae47c1c4c3c8a8fdea7e7fa95769"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair.html#aaa88ae47c1c4c3c8a8fdea7e7fa95769">operator&lt;&lt;</a> (std::ostream &amp;os, <a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair.html">SimpleSTRpair</a> &amp;pair)</td></tr>
<tr class="separator:aaa88ae47c1c4c3c8a8fdea7e7fa95769"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="SimpleSTRdistance_8h_source.html#l00040">40</a> of file <a class="el" href="SimpleSTRdistance_8h_source.html">SimpleSTRdistance.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a50268cd84e828181151137ff936c9a1a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">geos::index::strtree::SimpleSTRpair::SimpleSTRpair </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html">SimpleSTRnode</a> *&#160;</td>
<td class="paramname"><em>p_node1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html">SimpleSTRnode</a> *&#160;</td>
<td class="paramname"><em>p_node2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemDistance.html">ItemDistance</a> *&#160;</td>
<td class="paramname"><em>p_itemDistance</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="SimpleSTRdistance_8h_source.html#l00064">64</a> of file <a class="el" href="SimpleSTRdistance_8h_source.html">SimpleSTRdistance.h</a>.</p>
<p>References <a class="el" href="namespacegeos_1_1algorithm.html#a2758abe28b444c9fd134f02720d9af8b">geos::algorithm::operator&lt;&lt;()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair_a50268cd84e828181151137ff936c9a1a_cgraph.svg" width="494" height="55"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a218fb523533da43cf5ee372ba6a6a540"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double geos::index::strtree::SimpleSTRpair::distance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Computes the distance between the <a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html">SimpleSTRnode</a>s in this pair. The nodes are either composites or leaves. </p>
<p>If either is composite, the distance is computed as the minimum distance between the bounds. If both are leaves, the distance is computed by ItemDistance::distance(const void* item1, const void* item2).</p>
<dl class="section return"><dt>Returns</dt><dd>the distance between the items </dd></dl>
</div>
</div>
<a class="anchor" id="ac401b484c09bd86a93079aa2492fe0a4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double geos::index::strtree::SimpleSTRpair::getDistance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the minimum possible distance between the <a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html" title="A node of the STR tree. ">SimpleSTRnode</a> in this pair. </p>
<p>If the members are both items, this will be the exact distance between them. Otherwise, this distance will be a lower bound on the distances between the items in the members.</p>
<dl class="section return"><dt>Returns</dt><dd>the exact or lower bound distance for this pair </dd></dl>
<p>Referenced by <a class="el" href="SimpleSTRdistance_8h_source.html#l00115">geos::index::strtree::SimpleSTRdistance::STRpairQueueCompare::operator()()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair_ac401b484c09bd86a93079aa2492fe0a4_icgraph.svg" width="522" height="71"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
</div>
</div>
<a class="anchor" id="a728e6ab10c2f1f128b7ad66c1a41a492"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html">SimpleSTRnode</a>* geos::index::strtree::SimpleSTRpair::getNode </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>i</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a9c3ce3106e69b0d8b22c7dfb114763a7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool geos::index::strtree::SimpleSTRpair::isLeaves </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Tests if both elements of the pair are leaf nodes</p>
<dl class="section return"><dt>Returns</dt><dd>true if both pair elements are leaf nodes </dd></dl>
</div>
</div>
<a class="anchor" id="a22530eb315fb7ce68ee270206f97815d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double geos::index::strtree::SimpleSTRpair::maximumDistance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Computes the maximum distance between any two items in the pair of nodes. </p>
<dl class="section return"><dt>Returns</dt><dd>the maximum distance between items in the pair </dd></dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="aaa88ae47c1c4c3c8a8fdea7e7fa95769"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::ostream&amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRpair.html">SimpleSTRpair</a> &amp;&#160;</td>
<td class="paramname"><em>pair</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a3c3a54c98f2c016c79b0d71eaee6c1c5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemDistance.html">ItemDistance</a>* geos::index::strtree::SimpleSTRpair::itemDistance</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="SimpleSTRdistance_8h_source.html#l00046">46</a> of file <a class="el" href="SimpleSTRdistance_8h_source.html">SimpleSTRdistance.h</a>.</p>
</div>
</div>
<a class="anchor" id="af88e2ea72cb36535ac51094fe60c4616"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double geos::index::strtree::SimpleSTRpair::m_distance</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="SimpleSTRdistance_8h_source.html#l00047">47</a> of file <a class="el" href="SimpleSTRdistance_8h_source.html">SimpleSTRdistance.h</a>.</p>
</div>
</div>
<a class="anchor" id="a30a3686a4894163bd35f5e15c5b5c03d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html">SimpleSTRnode</a>* geos::index::strtree::SimpleSTRpair::node1</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="SimpleSTRdistance_8h_source.html#l00044">44</a> of file <a class="el" href="SimpleSTRdistance_8h_source.html">SimpleSTRdistance.h</a>.</p>
</div>
</div>
<a class="anchor" id="afa26bd94e5f373000f34af051eee6344"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1index_1_1strtree_1_1SimpleSTRnode.html">SimpleSTRnode</a>* geos::index::strtree::SimpleSTRpair::node2</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="SimpleSTRdistance_8h_source.html#l00045">45</a> of file <a class="el" href="SimpleSTRdistance_8h_source.html">SimpleSTRdistance.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SimpleSTRdistance_8h_source.html">SimpleSTRdistance.h</a></li>
</ul>
</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>
Reference in New Issue View Git Blame Copy Permalink