geos_390_docs/classgeos_1_1noding_1_1Segm...

224 lines
11 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::noding::SegmentPointComparator 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_1noding.html">noding</a></li><li class="navelem"><a class="el" href="classgeos_1_1noding_1_1SegmentPointComparator.html">SegmentPointComparator</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="classgeos_1_1noding_1_1SegmentPointComparator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::noding::SegmentPointComparator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Implements a robust method of comparing the relative position of two points along the same segment.
<a href="classgeos_1_1noding_1_1SegmentPointComparator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="SegmentPointComparator_8h_source.html">SegmentPointComparator.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:ad46e6c91ff33c9b14be08072a094ac4a"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1SegmentPointComparator.html#ad46e6c91ff33c9b14be08072a094ac4a">compare</a> (int octant, const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;p0, const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;p1)</td></tr>
<tr class="memdesc:ad46e6c91ff33c9b14be08072a094ac4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two Coordinates for their relative position along a segment lying in the specified <a class="el" href="classgeos_1_1noding_1_1Octant.html" title="Methods for computing and working with octants of the Cartesian plane. ">Octant</a>. <a href="#ad46e6c91ff33c9b14be08072a094ac4a">More...</a><br /></td></tr>
<tr class="separator:ad46e6c91ff33c9b14be08072a094ac4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dacaf6187868de20cab6b03da25a968"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1SegmentPointComparator.html#a0dacaf6187868de20cab6b03da25a968">relativeSign</a> (double x0, double x1)</td></tr>
<tr class="separator:a0dacaf6187868de20cab6b03da25a968"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afad72511ac465cacf690bd6398629f3c"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1SegmentPointComparator.html#afad72511ac465cacf690bd6398629f3c">compareValue</a> (int compareSign0, int compareSign1)</td></tr>
<tr class="separator:afad72511ac465cacf690bd6398629f3c"><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>Implements a robust method of comparing the relative position of two points along the same segment. </p>
<p>The coordinates are assumed to lie "near" the segment. This means that this algorithm will only return correct results if the input coordinates have the same precision and correspond to rounded values of exact coordinates lying on the segment. </p>
<p>Definition at line <a class="el" href="SegmentPointComparator_8h_source.html#l00040">40</a> of file <a class="el" href="SegmentPointComparator_8h_source.html">SegmentPointComparator.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ad46e6c91ff33c9b14be08072a094ac4a"></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::noding::SegmentPointComparator::compare </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>octant</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;&#160;</td>
<td class="paramname"><em>p0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> &amp;&#160;</td>
<td class="paramname"><em>p1</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">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares two Coordinates for their relative position along a segment lying in the specified <a class="el" href="classgeos_1_1noding_1_1Octant.html" title="Methods for computing and working with octants of the Cartesian plane. ">Octant</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>-1 node0 occurs first </dd>
<dd>
0 the two nodes are equal </dd>
<dd>
1 node1 occurs first </dd></dl>
<p>Definition at line <a class="el" href="SegmentPointComparator_8h_source.html#l00053">53</a> of file <a class="el" href="SegmentPointComparator_8h_source.html">SegmentPointComparator.h</a>.</p>
<p>References <a class="el" href="classgeos_1_1geom_1_1Coordinate.html#a2c21bb7a17fd64f70d6ee55990cb87b9">geos::geom::Coordinate::equals2D()</a>, <a class="el" href="Coordinate_8h_source.html#l00080">geos::geom::Coordinate::x</a>, and <a class="el" href="Coordinate_8h_source.html#l00083">geos::geom::Coordinate::y</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1noding_1_1SegmentPointComparator_ad46e6c91ff33c9b14be08072a094ac4a_cgraph.svg" width="438" height="55"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
</div>
</div>
<a class="anchor" id="afad72511ac465cacf690bd6398629f3c"></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::noding::SegmentPointComparator::compareValue </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>compareSign0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>compareSign1</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">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="SegmentPointComparator_8h_source.html#l00100">100</a> of file <a class="el" href="SegmentPointComparator_8h_source.html">SegmentPointComparator.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0dacaf6187868de20cab6b03da25a968"></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::noding::SegmentPointComparator::relativeSign </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>x0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>x1</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">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="SegmentPointComparator_8h_source.html#l00088">88</a> of file <a class="el" href="SegmentPointComparator_8h_source.html">SegmentPointComparator.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SegmentPointComparator_8h_source.html">SegmentPointComparator.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>