<!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"/>
<title>GEOS: geos::index::bintree::Bintree Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespacegeos.html">geos</a> </li>
<li><a class="el" href="namespacegeos_1_1index.html">index</a> </li>
<li><a class="el" href="namespacegeos_1_1index_1_1bintree.html">bintree</a> </li>
<li><a class="el" href="classgeos_1_1index_1_1bintree_1_1Bintree.html">geos::index::bintree::Bintree</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>geos::index::bintree::Bintree Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="geos::index::bintree::Bintree" -->
<p>An BinTree (or "Binary Interval Tree") is a 1-dimensional version of a quadtree.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Bintree_8h_source.html">Bintree.h</a>></code></p>
<p><a href="classgeos_1_1index_1_1bintree_1_1Bintree-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac5f19e48d52cf6053ccc28d7a7f4961"></a><!-- doxytag: member="geos::index::bintree::Bintree::depth" ref="aac5f19e48d52cf6053ccc28d7a7f4961" args="()" -->
int </td><td class="memItemRight" valign="bottom"><b>depth</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a331d9ed17c279a0549343d8fad4f98a5"></a><!-- doxytag: member="geos::index::bintree::Bintree::size" ref="a331d9ed17c279a0549343d8fad4f98a5" args="()" -->
int </td><td class="memItemRight" valign="bottom"><b>size</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afeb49dfe77a15b256f93bb84ce9170ac"></a><!-- doxytag: member="geos::index::bintree::Bintree::nodeSize" ref="afeb49dfe77a15b256f93bb84ce9170ac" args="()" -->
int </td><td class="memItemRight" valign="bottom"><b>nodeSize</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Bintree.html#af2278143ec49aeea81435111bc54e49d">insert</a> (<a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> *itemInterval, void *item)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae521160eeab90b533c15cb7814c4b413"></a><!-- doxytag: member="geos::index::bintree::Bintree::iterator" ref="ae521160eeab90b533c15cb7814c4b413" args="()" -->
std::vector< void * > * </td><td class="memItemRight" valign="bottom"><b>iterator</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb23761be5f594c64fff2f6cfd277f12"></a><!-- doxytag: member="geos::index::bintree::Bintree::query" ref="afb23761be5f594c64fff2f6cfd277f12" args="(double x)" -->
std::vector< void * > * </td><td class="memItemRight" valign="bottom"><b>query</b> (double x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c51d386cb9d72ea416a885fcdc251f4"></a><!-- doxytag: member="geos::index::bintree::Bintree::query" ref="a6c51d386cb9d72ea416a885fcdc251f4" args="(Interval *interval)" -->
std::vector< void * > * </td><td class="memItemRight" valign="bottom"><b>query</b> (<a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> *interval)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb0dfb7caf6a5a02768ff7b1583ff83a"></a><!-- doxytag: member="geos::index::bintree::Bintree::query" ref="acb0dfb7caf6a5a02768ff7b1583ff83a" args="(Interval *interval, std::vector< void * > *foundItems)" -->
void </td><td class="memItemRight" valign="bottom"><b>query</b> (<a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> *interval, std::vector< void * > *foundItems)</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Bintree.html#a6073d91ff5aeb121ed032fce15fb96a0">ensureExtent</a> (const <a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> *itemInterval, double minExtent)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An BinTree (or "Binary Interval Tree") is a 1-dimensional version of a quadtree. </p>
<p>It indexes 1-dimensional intervals (which of course may be the projection of 2-D objects on an axis). It supports range searching (where the range may be a single point).</p>
<p>This implementation does not require specifying the extent of the inserted items beforehand. It will automatically expand to accomodate any extent of dataset.</p>
<p>This index is different to the <a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html" title="Represents an (1-dimensional) closed interval on the Real number line.">Interval</a> Tree of Edelsbrunner or the Segment Tree of Bentley. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6073d91ff5aeb121ed032fce15fb96a0"></a><!-- doxytag: member="geos::index::bintree::Bintree::ensureExtent" ref="a6073d91ff5aeb121ed032fce15fb96a0" args="(const Interval *itemInterval, double minExtent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a>* geos::index::bintree::Bintree::ensureExtent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> * </td>
<td class="paramname"> <em>itemInterval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>minExtent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Ensure that the <a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html" title="Represents an (1-dimensional) closed interval on the Real number line.">Interval</a> for the inserted item has non-zero extents. Use the current minExtent to pad it, if necessary</p>
<p>NOTE: in GEOS this function always return a newly allocated object with ownership transferred to caller. TODO: change this ?</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>itemInterval</em> </td><td>Source interval, ownership left to caller, no references hold. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af2278143ec49aeea81435111bc54e49d"></a><!-- doxytag: member="geos::index::bintree::Bintree::insert" ref="af2278143ec49aeea81435111bc54e49d" args="(Interval *itemInterval, void *item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geos::index::bintree::Bintree::insert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgeos_1_1index_1_1bintree_1_1Interval.html">Interval</a> * </td>
<td class="paramname"> <em>itemInterval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>item</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>itemInterval</em> </td><td>Ownership left to caller, NO reference hold by this class.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>item</em> </td><td>Ownership left to caller, reference kept by this class. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Bintree_8h_source.html">Bintree.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jul 22 2010 for GEOS by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
