geos_390_docs/bintree_2Key_8h_source.html

72 lines
15 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: Key.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_dd4ecab777d0bbb8e2023293f805db8a.html">bintree</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">bintree/Key.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="bintree_2Key_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;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef GEOS_IDX_BINTREE_KEY_H</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define GEOS_IDX_BINTREE_KEY_H</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</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="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment">// Forward declarations</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegeos.html">geos</a> {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">namespace </span>index {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">namespace </span>bintree {</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">class </span>Interval;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;}</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;}</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;}</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegeos.html">geos</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">namespace </span>index { <span class="comment">// geos::index</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">namespace </span>bintree { <span class="comment">// geos::index::bintree</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classgeos_1_1index_1_1bintree_1_1Key.html"> 39</a></span>&#160;<span class="keyword">class </span><a class="code" href="export_8h.html#ae36df939090171f6e9a28a8cb6254fea">GEOS_DLL</a> <a class="code" href="classgeos_1_1index_1_1bintree_1_1Key.html">Key</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> computeLevel(<a class="code" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a>* newInterval);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="classgeos_1_1index_1_1bintree_1_1Key.html">Key</a>(<a class="code" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a>* newInterval);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; ~<a class="code" href="classgeos_1_1index_1_1bintree_1_1Key.html">Key</a>();</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">double</span> getPoint();</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">int</span> getLevel();</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a>* getInterval();</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">void</span> computeKey(<a class="code" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a>* itemInterval);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="comment">// the fields which make up the key</span></div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classgeos_1_1index_1_1bintree_1_1Key.html#a06b1f999f60780ef1b2c71fe672ea03c"> 60</a></span>&#160; <span class="keywordtype">double</span> <a class="code" href="classgeos_1_1index_1_1bintree_1_1Key.html#a06b1f999f60780ef1b2c71fe672ea03c">pt</a>;</div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classgeos_1_1index_1_1bintree_1_1Key.html#a957ccf16e5fc39b6e1d8bd14f25bbe7f"> 61</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classgeos_1_1index_1_1bintree_1_1Key.html#a957ccf16e5fc39b6e1d8bd14f25bbe7f">level</a>;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">// auxiliary data which is derived from the key for use in computation</span></div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classgeos_1_1index_1_1bintree_1_1Key.html#a4681757f2fb0dd5e8dc852fe99257522"> 64</a></span>&#160; <a class="code" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a>* <a class="code" href="classgeos_1_1index_1_1bintree_1_1Key.html#a4681757f2fb0dd5e8dc852fe99257522">interval</a>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordtype">void</span> computeInterval(<span class="keywordtype">int</span> level, <a class="code" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a>* itemInterval);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;};</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;} <span class="comment">// namespace geos::index::bintree</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;} <span class="comment">// namespace geos::index</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;} <span class="comment">// namespace geos</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="preprocessor">#endif // GEOS_IDX_BINTREE_KEY_H</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="ttc" id="classgeos_1_1index_1_1bintree_1_1Interval_html"><div class="ttname"><a href="classgeos_1_1index_1_1bintree_1_1Interval.html">geos::index::bintree::Interval</a></div><div class="ttdoc">Represents an (1-dimensional) closed interval on the Real number line. </div><div class="ttdef"><b>Definition:</b> <a href="bintree_2Interval_8h_source.html#l00025">bintree/Interval.h:25</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="export_8h_html"><div class="ttname"><a href="export_8h.html">export.h</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1bintree_1_1Key_html"><div class="ttname"><a href="classgeos_1_1index_1_1bintree_1_1Key.html">geos::index::bintree::Key</a></div><div class="ttdoc">A Key is a unique identifier for a node in a tree. </div><div class="ttdef"><b>Definition:</b> <a href="bintree_2Key_8h_source.html#l00039">bintree/Key.h:39</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1bintree_1_1Key_html_a4681757f2fb0dd5e8dc852fe99257522"><div class="ttname"><a href="classgeos_1_1index_1_1bintree_1_1Key.html#a4681757f2fb0dd5e8dc852fe99257522">geos::index::bintree::Key::interval</a></div><div class="ttdeci">Interval * interval</div><div class="ttdef"><b>Definition:</b> <a href="bintree_2Key_8h_source.html#l00064">bintree/Key.h:64</a></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="classgeos_1_1index_1_1bintree_1_1Key_html_a06b1f999f60780ef1b2c71fe672ea03c"><div class="ttname"><a href="classgeos_1_1index_1_1bintree_1_1Key.html#a06b1f999f60780ef1b2c71fe672ea03c">geos::index::bintree::Key::pt</a></div><div class="ttdeci">double pt</div><div class="ttdef"><b>Definition:</b> <a href="bintree_2Key_8h_source.html#l00060">bintree/Key.h:60</a></div></div>
<div class="ttc" id="classgeos_1_1index_1_1bintree_1_1Key_html_a957ccf16e5fc39b6e1d8bd14f25bbe7f"><div class="ttname"><a href="classgeos_1_1index_1_1bintree_1_1Key.html#a957ccf16e5fc39b6e1d8bd14f25bbe7f">geos::index::bintree::Key::level</a></div><div class="ttdeci">int level</div><div class="ttdef"><b>Definition:</b> <a href="bintree_2Key_8h_source.html#l00061">bintree/Key.h:61</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>