geos_390_docs/classgeos_1_1index_1_1chain...

344 lines
19 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::chain::MonotoneChainBuilder 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_1chain.html">chain</a></li><li class="navelem"><a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChainBuilder.html">MonotoneChainBuilder</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-static-methods">Static Private Member Functions</a> &#124;
<a href="classgeos_1_1index_1_1chain_1_1MonotoneChainBuilder-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::index::chain::MonotoneChainBuilder Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Constructs <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChain.html">MonotoneChains</a> for sequences of <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinates</a>.
<a href="classgeos_1_1index_1_1chain_1_1MonotoneChainBuilder.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="MonotoneChainBuilder_8h_source.html">MonotoneChainBuilder.h</a>&gt;</code></p>
<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:a7d4bf25b8e35681f56a4d692cc5cf57d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChainBuilder.html#a7d4bf25b8e35681f56a4d692cc5cf57d">MonotoneChainBuilder</a> ()</td></tr>
<tr class="separator:a7d4bf25b8e35681f56a4d692cc5cf57d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafa8de6849bc92f19e3a7b48fe052f62"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChainBuilder.html#aafa8de6849bc92f19e3a7b48fe052f62">MonotoneChainBuilder</a> (const <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChainBuilder.html">MonotoneChainBuilder</a> &amp;)=delete</td></tr>
<tr class="separator:aafa8de6849bc92f19e3a7b48fe052f62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27f42bf63ce53ec6584562bf22704ab7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChainBuilder.html">MonotoneChainBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChainBuilder.html#a27f42bf63ce53ec6584562bf22704ab7">operator=</a> (const <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChainBuilder.html">MonotoneChainBuilder</a> &amp;)=delete</td></tr>
<tr class="separator:a27f42bf63ce53ec6584562bf22704ab7"><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:acfa49d05155a8951db0a74d15ea723a9"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr&lt; std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChain.html">MonotoneChain</a> &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChainBuilder.html#acfa49d05155a8951db0a74d15ea723a9">getChains</a> (const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> *pts, void *context)</td></tr>
<tr class="memdesc:acfa49d05155a8951db0a74d15ea723a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a newly-allocated vector of newly-allocated <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChain.html" title="Monotone Chains are a way of partitioning the segments of a linestring to allow for fast searching of...">MonotoneChain</a> objects for the given CoordinateSequence. <a href="#acfa49d05155a8951db0a74d15ea723a9">More...</a><br /></td></tr>
<tr class="separator:acfa49d05155a8951db0a74d15ea723a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a278501f67ec4a9a41a4b6926e1f5a5a9"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChainBuilder.html#a278501f67ec4a9a41a4b6926e1f5a5a9">getChains</a> (const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> *pts, void *context, std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChain.html">MonotoneChain</a> &gt;&gt; &amp;mcList)</td></tr>
<tr class="memdesc:a278501f67ec4a9a41a4b6926e1f5a5a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes a list of the <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChain.html">MonotoneChain</a>s for a list of coordinates, attaching a context data object to each. <a href="#a278501f67ec4a9a41a4b6926e1f5a5a9">More...</a><br /></td></tr>
<tr class="separator:a278501f67ec4a9a41a4b6926e1f5a5a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2c0fe875bd5db8ecc971bd38c802957"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr&lt; std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChain.html">MonotoneChain</a> &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChainBuilder.html#ab2c0fe875bd5db8ecc971bd38c802957">getChains</a> (const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> *pts)</td></tr>
<tr class="separator:ab2c0fe875bd5db8ecc971bd38c802957"><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:a573c2ab0275734b28b9f8bf524583f37"><td class="memItemLeft" align="right" valign="top">static std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChainBuilder.html#a573c2ab0275734b28b9f8bf524583f37">findChainEnd</a> (const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> &amp;pts, std::size_t start)</td></tr>
<tr class="memdesc:a573c2ab0275734b28b9f8bf524583f37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds the index of the last point in a monotone chain starting at a given point. <a href="#a573c2ab0275734b28b9f8bf524583f37">More...</a><br /></td></tr>
<tr class="separator:a573c2ab0275734b28b9f8bf524583f37"><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>Constructs <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChain.html">MonotoneChains</a> for sequences of <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinates</a>. </p>
<p>TODO: use vector&lt;const Coordinate*&gt; instead ? </p>
<p>Definition at line <a class="el" href="MonotoneChainBuilder_8h_source.html#l00049">49</a> of file <a class="el" href="MonotoneChainBuilder_8h_source.html">MonotoneChainBuilder.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a7d4bf25b8e35681f56a4d692cc5cf57d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">geos::index::chain::MonotoneChainBuilder::MonotoneChainBuilder </td>
<td>(</td>
<td class="paramname"></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="MonotoneChainBuilder_8h_source.html#l00053">53</a> of file <a class="el" href="MonotoneChainBuilder_8h_source.html">MonotoneChainBuilder.h</a>.</p>
</div>
</div>
<a class="anchor" id="aafa8de6849bc92f19e3a7b48fe052f62"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">geos::index::chain::MonotoneChainBuilder::MonotoneChainBuilder </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChainBuilder.html">MonotoneChainBuilder</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Disable copy construction and assignment. Apparently needed to make this class compile under MSVC. (See <a href="https://stackoverflow.com/q/29565299">https://stackoverflow.com/q/29565299</a>) </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a573c2ab0275734b28b9f8bf524583f37"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::size_t geos::index::chain::MonotoneChainBuilder::findChainEnd </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> &amp;&#160;</td>
<td class="paramname"><em>pts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>start</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 class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds the index of the last point in a monotone chain starting at a given point. </p>
<p>Repeated points (0-length segments) are included in the monotone chain returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pts</td><td>the points to scan </td></tr>
<tr><td class="paramname">start</td><td>the index of the start of this chain </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the index of the last point in the monotone chain starting at <code>start</code>.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>aborts if 'start' is &gt;= pts.getSize() </dd></dl>
</div>
</div>
<a class="anchor" id="acfa49d05155a8951db0a74d15ea723a9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::unique_ptr&lt;std::vector&lt;std::unique_ptr&lt;<a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChain.html">MonotoneChain</a>&gt; &gt; &gt; geos::index::chain::MonotoneChainBuilder::getChains </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> *&#160;</td>
<td class="paramname"><em>pts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>context</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">
<p>Return a newly-allocated vector of newly-allocated <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChain.html" title="Monotone Chains are a way of partitioning the segments of a linestring to allow for fast searching of...">MonotoneChain</a> objects for the given CoordinateSequence. </p>
</div>
</div>
<a class="anchor" id="a278501f67ec4a9a41a4b6926e1f5a5a9"></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::index::chain::MonotoneChainBuilder::getChains </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> *&#160;</td>
<td class="paramname"><em>pts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChain.html">MonotoneChain</a> &gt;&gt; &amp;&#160;</td>
<td class="paramname"><em>mcList</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">
<p>Computes a list of the <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChain.html">MonotoneChain</a>s for a list of coordinates, attaching a context data object to each. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">pts</td><td>the list of points to compute chains for </td></tr>
<tr><td class="paramdir"></td><td class="paramname">context</td><td>a data object to attach to each chain </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">mcList</td><td>a list of the monotone chains for the points </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab2c0fe875bd5db8ecc971bd38c802957"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::unique_ptr&lt;std::vector&lt;std::unique_ptr&lt;<a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChain.html">MonotoneChain</a>&gt; &gt; &gt; geos::index::chain::MonotoneChainBuilder::getChains </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> *&#160;</td>
<td class="paramname"><em>pts</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="MonotoneChainBuilder_8h_source.html#l00076">76</a> of file <a class="el" href="MonotoneChainBuilder_8h_source.html">MonotoneChainBuilder.h</a>.</p>
</div>
</div>
<a class="anchor" id="a27f42bf63ce53ec6584562bf22704ab7"></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_1chain_1_1MonotoneChainBuilder.html">MonotoneChainBuilder</a>&amp; geos::index::chain::MonotoneChainBuilder::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChainBuilder.html">MonotoneChainBuilder</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="MonotoneChainBuilder_8h_source.html">MonotoneChainBuilder.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>