geos_390_docs/classgeos_1_1index_1_1bintr...

344 lines
16 KiB
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.11"/>
<title>GEOS: geos::index::bintree::Key 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_1bintree.html">bintree</a></li><li class="navelem"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Key.html">Key</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classgeos_1_1index_1_1bintree_1_1Key-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::index::bintree::Key Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A <a class="el" href="classgeos_1_1index_1_1bintree_1_1Key.html" title="A Key is a unique identifier for a node in a tree. ">Key</a> is a unique identifier for a node in a tree.
<a href="classgeos_1_1index_1_1bintree_1_1Key.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="bintree_2Key_8h_source.html">Key.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for geos::index::bintree::Key:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1index_1_1bintree_1_1Key__coll__graph.svg" width="191" height="147"><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:a77e334a6f8e050b89233b2465cccce76"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Key.html#a77e334a6f8e050b89233b2465cccce76">Key</a> (<a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> *newInterval)</td></tr>
<tr class="separator:a77e334a6f8e050b89233b2465cccce76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af30618a0e2b4d3703fd19f0d0dff7b9b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Key.html#af30618a0e2b4d3703fd19f0d0dff7b9b">~Key</a> ()</td></tr>
<tr class="separator:af30618a0e2b4d3703fd19f0d0dff7b9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a993755a2013c834e15fcf7e827225b38"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Key.html#a993755a2013c834e15fcf7e827225b38">getPoint</a> ()</td></tr>
<tr class="separator:a993755a2013c834e15fcf7e827225b38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbe852a660bfa90d473c6d28dc1487c5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Key.html#acbe852a660bfa90d473c6d28dc1487c5">getLevel</a> ()</td></tr>
<tr class="separator:acbe852a660bfa90d473c6d28dc1487c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a911c237fc7dc62a9ee7fb2fb261cfe64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Key.html#a911c237fc7dc62a9ee7fb2fb261cfe64">getInterval</a> ()</td></tr>
<tr class="separator:a911c237fc7dc62a9ee7fb2fb261cfe64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac836cbe35e29f79a7613c849e2373c64"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Key.html#ac836cbe35e29f79a7613c849e2373c64">computeKey</a> (<a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> *itemInterval)</td></tr>
<tr class="separator:ac836cbe35e29f79a7613c849e2373c64"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a1b7b67b9b91ec26f5a2f4625a81a8513"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Key.html#a1b7b67b9b91ec26f5a2f4625a81a8513">computeLevel</a> (<a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> *newInterval)</td></tr>
<tr class="separator:a1b7b67b9b91ec26f5a2f4625a81a8513"><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:a3c394b383b3107a35f0a9d0e59dc3470"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Key.html#a3c394b383b3107a35f0a9d0e59dc3470">computeInterval</a> (int <a class="el" href="classgeos_1_1index_1_1bintree_1_1Key.html#a957ccf16e5fc39b6e1d8bd14f25bbe7f">level</a>, <a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> *itemInterval)</td></tr>
<tr class="separator:a3c394b383b3107a35f0a9d0e59dc3470"><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:a06b1f999f60780ef1b2c71fe672ea03c"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Key.html#a06b1f999f60780ef1b2c71fe672ea03c">pt</a></td></tr>
<tr class="separator:a06b1f999f60780ef1b2c71fe672ea03c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a957ccf16e5fc39b6e1d8bd14f25bbe7f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Key.html#a957ccf16e5fc39b6e1d8bd14f25bbe7f">level</a></td></tr>
<tr class="separator:a957ccf16e5fc39b6e1d8bd14f25bbe7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4681757f2fb0dd5e8dc852fe99257522"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Key.html#a4681757f2fb0dd5e8dc852fe99257522">interval</a></td></tr>
<tr class="separator:a4681757f2fb0dd5e8dc852fe99257522"><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>A <a class="el" href="classgeos_1_1index_1_1bintree_1_1Key.html" title="A Key is a unique identifier for a node in a tree. ">Key</a> is a unique identifier for a node in a tree. </p>
<p>It contains a lower-left point and a level number. The level number is the power of two for the size of the node envelope </p>
<p>Definition at line <a class="el" href="bintree_2Key_8h_source.html#l00039">39</a> of file <a class="el" href="bintree_2Key_8h_source.html">bintree/Key.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a77e334a6f8e050b89233b2465cccce76"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::index::bintree::Key::Key </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> *&#160;</td>
<td class="paramname"><em>newInterval</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af30618a0e2b4d3703fd19f0d0dff7b9b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::index::bintree::Key::~Key </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3c394b383b3107a35f0a9d0e59dc3470"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void geos::index::bintree::Key::computeInterval </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> *&#160;</td>
<td class="paramname"><em>itemInterval</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">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ac836cbe35e29f79a7613c849e2373c64"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geos::index::bintree::Key::computeKey </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> *&#160;</td>
<td class="paramname"><em>itemInterval</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a1b7b67b9b91ec26f5a2f4625a81a8513"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int geos::index::bintree::Key::computeLevel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> *&#160;</td>
<td class="paramname"><em>newInterval</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a911c237fc7dc62a9ee7fb2fb261cfe64"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a>* geos::index::bintree::Key::getInterval </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="acbe852a660bfa90d473c6d28dc1487c5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int geos::index::bintree::Key::getLevel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a993755a2013c834e15fcf7e827225b38"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double geos::index::bintree::Key::getPoint </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a4681757f2fb0dd5e8dc852fe99257522"></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_1bintree_1_1Interval.html">Interval</a>* geos::index::bintree::Key::interval</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="bintree_2Key_8h_source.html#l00064">64</a> of file <a class="el" href="bintree_2Key_8h_source.html">bintree/Key.h</a>.</p>
</div>
</div>
<a class="anchor" id="a957ccf16e5fc39b6e1d8bd14f25bbe7f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int geos::index::bintree::Key::level</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="bintree_2Key_8h_source.html#l00061">61</a> of file <a class="el" href="bintree_2Key_8h_source.html">bintree/Key.h</a>.</p>
</div>
</div>
<a class="anchor" id="a06b1f999f60780ef1b2c71fe672ea03c"></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::bintree::Key::pt</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="bintree_2Key_8h_source.html#l00060">60</a> of file <a class="el" href="bintree_2Key_8h_source.html">bintree/Key.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="bintree_2Key_8h_source.html">bintree/Key.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>