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

431 lines
20 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::shape::fractal::HilbertCode 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_1shape.html">shape</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1shape_1_1fractal.html">fractal</a></li><li class="navelem"><a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html">HilbertCode</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pri-static-methods">Static Private Member Functions</a> &#124;
<a href="classgeos_1_1shape_1_1fractal_1_1HilbertCode-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::shape::fractal::HilbertCode Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="HilbertCode_8h_source.html">HilbertCode.h</a>&gt;</code></p>
<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:ae63f0c697c64a3a61a1e17c07009f6df"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#ae63f0c697c64a3a61a1e17c07009f6df">decode</a> (uint32_t <a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#a98c152123ea5d5192824ed2f04e88cec">level</a>, uint32_t i)</td></tr>
<tr class="separator:ae63f0c697c64a3a61a1e17c07009f6df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49e3a6a07c782890cd35331f6100709a"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#a49e3a6a07c782890cd35331f6100709a">encode</a> (uint32_t <a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#a98c152123ea5d5192824ed2f04e88cec">level</a>, uint32_t x, uint32_t y)</td></tr>
<tr class="separator:a49e3a6a07c782890cd35331f6100709a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3136e6d81a9ffe94c399c7d6c65ce99"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#ad3136e6d81a9ffe94c399c7d6c65ce99">levelSize</a> (uint32_t <a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#a98c152123ea5d5192824ed2f04e88cec">level</a>)</td></tr>
<tr class="separator:ad3136e6d81a9ffe94c399c7d6c65ce99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a879e764997c9ff58ed452ed14c58d5fd"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#a879e764997c9ff58ed452ed14c58d5fd">maxOrdinate</a> (uint32_t <a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#a98c152123ea5d5192824ed2f04e88cec">level</a>)</td></tr>
<tr class="separator:a879e764997c9ff58ed452ed14c58d5fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98c152123ea5d5192824ed2f04e88cec"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#a98c152123ea5d5192824ed2f04e88cec">level</a> (uint32_t numPoints)</td></tr>
<tr class="separator:a98c152123ea5d5192824ed2f04e88cec"><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-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a1fc2b2b231874c146550a4cf2d0cd061"><td class="memItemLeft" align="right" valign="top">static constexpr int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#a1fc2b2b231874c146550a4cf2d0cd061">MAX_LEVEL</a> = 16</td></tr>
<tr class="separator:a1fc2b2b231874c146550a4cf2d0cd061"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-methods"></a>
Static Private Member Functions</h2></td></tr>
<tr class="memitem:a8f37b4641ffc70b64429a3d2eaf6645b"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#a8f37b4641ffc70b64429a3d2eaf6645b">deinterleave</a> (uint32_t x)</td></tr>
<tr class="separator:a8f37b4641ffc70b64429a3d2eaf6645b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73ada84f14bdaa232461853aea3eeb21"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#a73ada84f14bdaa232461853aea3eeb21">interleave</a> (uint32_t x)</td></tr>
<tr class="separator:a73ada84f14bdaa232461853aea3eeb21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a689f02aae24576153877640d226dee72"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#a689f02aae24576153877640d226dee72">prefixScan</a> (uint32_t x)</td></tr>
<tr class="separator:a689f02aae24576153877640d226dee72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a812dca8b53791491e1ed76044ea3f6ab"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#a812dca8b53791491e1ed76044ea3f6ab">descan</a> (uint32_t x)</td></tr>
<tr class="separator:a812dca8b53791491e1ed76044ea3f6ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3950a98b3d889c2619c2e7a3e19d7ac5"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#a3950a98b3d889c2619c2e7a3e19d7ac5">checkLevel</a> (int <a class="el" href="classgeos_1_1shape_1_1fractal_1_1HilbertCode.html#a98c152123ea5d5192824ed2f04e88cec">level</a>)</td></tr>
<tr class="separator:a3950a98b3d889c2619c2e7a3e19d7ac5"><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>Encodes points as the index along finite planar Hilbert curves.</p>
<p>The planar Hilbert Curve is a continuous space-filling curve. In the limit the Hilbert curve has infinitely many vertices and fills the space of the unit square. A sequence of finite approximations to the infinite Hilbert curve is defined by the level number. The finite Hilbert curve at level n H(n) contains 2^n+1 points. Each finite Hilbert curve defines an ordering of the points in the 2-dimensional range square containing the curve. Curves fills the range square of side 2^level. Curve points have ordinates in the range [0, 2^level - 1]. The index of a point along a Hilbert curve is called the Hilbert code. The code for a given point is specific to the level chosen.</p>
<p>This implementation represents codes using 32-bit integers. This allows levels 0 to 16 to be handled. The class supports encoding points in the range of a given level curve and decoding the point for a given code value.</p>
<p>The Hilbert order has the property that it tends to preserve locality. This means that codes which are near in value will have spatially proximate points. The converse is not always true - the delta between codes for nearby points is not always small. But the average delta is small enough that the Hilbert order is an effective way of linearizing space to support range queries.</p>
<dl class="section author"><dt>Author</dt><dd>Martin Davis</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classgeos_1_1shape_1_1fractal_1_1MortonCode.html">MortonCode</a> </dd></dl>
<p>Definition at line <a class="el" href="HilbertCode_8h_source.html#l00064">64</a> of file <a class="el" href="HilbertCode_8h_source.html">HilbertCode.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3950a98b3d889c2619c2e7a3e19d7ac5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void geos::shape::fractal::HilbertCode::checkLevel </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>level</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae63f0c697c64a3a61a1e17c07009f6df"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> geos::shape::fractal::HilbertCode::decode </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>i</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a8f37b4641ffc70b64429a3d2eaf6645b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static uint32_t geos::shape::fractal::HilbertCode::deinterleave </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a812dca8b53791491e1ed76044ea3f6ab"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static uint32_t geos::shape::fractal::HilbertCode::descan </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a49e3a6a07c782890cd35331f6100709a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static uint32_t geos::shape::fractal::HilbertCode::encode </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>y</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a73ada84f14bdaa232461853aea3eeb21"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static uint32_t geos::shape::fractal::HilbertCode::interleave </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a98c152123ea5d5192824ed2f04e88cec"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static uint32_t geos::shape::fractal::HilbertCode::level </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>numPoints</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">
<p>The level of the finite Hilbert curve which contains at least the given number of points.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">numPoints</td><td>the number of points required </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the level of the curve </dd></dl>
</div>
</div>
<a class="anchor" id="ad3136e6d81a9ffe94c399c7d6c65ce99"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static uint32_t geos::shape::fractal::HilbertCode::levelSize </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>level</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">
<p>The number of points in the curve for the given level. The number of points is 2^(2 * level).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">level</td><td>the level of the curve </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of points </dd></dl>
</div>
</div>
<a class="anchor" id="a879e764997c9ff58ed452ed14c58d5fd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static uint32_t geos::shape::fractal::HilbertCode::maxOrdinate </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>level</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">
<p>The maximum ordinate value for points in the curve for the given level. The maximum ordinate is 2^level - 1.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">level</td><td>the level of the curve </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the maximum ordinate value </dd></dl>
</div>
</div>
<a class="anchor" id="a689f02aae24576153877640d226dee72"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static uint32_t geos::shape::fractal::HilbertCode::prefixScan </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a1fc2b2b231874c146550a4cf2d0cd061"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr int geos::shape::fractal::HilbertCode::MAX_LEVEL = 16</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum curve level that can be represented. </p>
<p>Definition at line <a class="el" href="HilbertCode_8h_source.html#l00071">71</a> of file <a class="el" href="HilbertCode_8h_source.html">HilbertCode.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="HilbertCode_8h_source.html">HilbertCode.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