geos_390_docs/classgeos_1_1noding_1_1Orie...

342 lines
18 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::OrientedCoordinateArray 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_1OrientedCoordinateArray.html">OrientedCoordinateArray</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-static-methods">Static Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classgeos_1_1noding_1_1OrientedCoordinateArray-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::noding::OrientedCoordinateArray Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Allows comparing <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a>s in an orientation-independent way.
<a href="classgeos_1_1noding_1_1OrientedCoordinateArray.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="OrientedCoordinateArray_8h_source.html">OrientedCoordinateArray.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for geos::noding::OrientedCoordinateArray:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1noding_1_1OrientedCoordinateArray__coll__graph.svg" width="252" height="147"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgeos_1_1noding_1_1OrientedCoordinateArray_1_1HashCode.html">HashCode</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:ad529dd32b2213228d7617a20e7134255"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1OrientedCoordinateArray.html#ad529dd32b2213228d7617a20e7134255">OrientedCoordinateArray</a> (const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> &amp;p_pts)</td></tr>
<tr class="separator:ad529dd32b2213228d7617a20e7134255"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a682a6401c2e7e6b5c8b62b841891925b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1OrientedCoordinateArray.html#a682a6401c2e7e6b5c8b62b841891925b">compareTo</a> (const <a class="el" href="classgeos_1_1noding_1_1OrientedCoordinateArray.html">OrientedCoordinateArray</a> &amp;o1) const </td></tr>
<tr class="memdesc:a682a6401c2e7e6b5c8b62b841891925b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two <a class="el" href="classgeos_1_1noding_1_1OrientedCoordinateArray.html">OrientedCoordinateArray</a>s for their relative order. <a href="#a682a6401c2e7e6b5c8b62b841891925b">More...</a><br /></td></tr>
<tr class="separator:a682a6401c2e7e6b5c8b62b841891925b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47d59c388aabb8edcc6af5f81be0ae52"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1OrientedCoordinateArray.html#a47d59c388aabb8edcc6af5f81be0ae52">operator==</a> (const <a class="el" href="classgeos_1_1noding_1_1OrientedCoordinateArray.html">OrientedCoordinateArray</a> &amp;other) const </td></tr>
<tr class="separator:a47d59c388aabb8edcc6af5f81be0ae52"><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:afeba30b131ef8e0755ea31c8d23f8836"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1OrientedCoordinateArray.html#afeba30b131ef8e0755ea31c8d23f8836">compareOriented</a> (const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> &amp;pts1, bool orientation1, const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> &amp;pts2, bool orientation2)</td></tr>
<tr class="separator:afeba30b131ef8e0755ea31c8d23f8836"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa89b0207a4411f313f687540432d6542"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1OrientedCoordinateArray.html#aa89b0207a4411f313f687540432d6542">orientation</a> (const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> &amp;<a class="el" href="classgeos_1_1noding_1_1OrientedCoordinateArray.html#a9dd844f7dff5154870685113cb1b504d">pts</a>)</td></tr>
<tr class="separator:aa89b0207a4411f313f687540432d6542"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a9dd844f7dff5154870685113cb1b504d"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1OrientedCoordinateArray.html#a9dd844f7dff5154870685113cb1b504d">pts</a></td></tr>
<tr class="memdesc:a9dd844f7dff5154870685113cb1b504d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Externally owned. <a href="#a9dd844f7dff5154870685113cb1b504d">More...</a><br /></td></tr>
<tr class="separator:a9dd844f7dff5154870685113cb1b504d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13b6528593a79207fcb6a3b0e9872059"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1OrientedCoordinateArray.html#a13b6528593a79207fcb6a3b0e9872059">orientationVar</a></td></tr>
<tr class="separator:a13b6528593a79207fcb6a3b0e9872059"><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>Allows comparing <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a>s in an orientation-independent way. </p>
<p>Definition at line <a class="el" href="OrientedCoordinateArray_8h_source.html#l00043">43</a> of file <a class="el" href="OrientedCoordinateArray_8h_source.html">OrientedCoordinateArray.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ad529dd32b2213228d7617a20e7134255"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">geos::noding::OrientedCoordinateArray::OrientedCoordinateArray </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>p_pts</em></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>Creates a new <a class="el" href="classgeos_1_1noding_1_1OrientedCoordinateArray.html">OrientedCoordinateArray</a> for the given <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_pts</td><td>the coordinates to orient </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="OrientedCoordinateArray_8h_source.html#l00052">52</a> of file <a class="el" href="OrientedCoordinateArray_8h_source.html">OrientedCoordinateArray.h</a>.</p>
<p>References <a class="el" href="namespacegeos_1_1geom.html#aa3ab17cfa95af46ea53ac92482041d76">geos::geom::operator==()</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_1OrientedCoordinateArray_ad529dd32b2213228d7617a20e7134255_cgraph.svg" width="475" 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>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="afeba30b131ef8e0755ea31c8d23f8836"></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::OrientedCoordinateArray::compareOriented </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>pts1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>orientation1</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>pts2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>orientation2</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">
</div>
</div>
<a class="anchor" id="a682a6401c2e7e6b5c8b62b841891925b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int geos::noding::OrientedCoordinateArray::compareTo </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1noding_1_1OrientedCoordinateArray.html">OrientedCoordinateArray</a> &amp;&#160;</td>
<td class="paramname"><em>o1</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares two <a class="el" href="classgeos_1_1noding_1_1OrientedCoordinateArray.html">OrientedCoordinateArray</a>s for their relative order. </p>
<dl class="section return"><dt>Returns</dt><dd>-1 this one is smaller </dd>
<dd>
0 the two objects are equal </dd>
<dd>
1 this one is greater</dd></dl>
<p>In JTS, this is used automatically by ordered lists. In C++, operator&lt; would be used instead.... </p>
<p>Referenced by <a class="el" href="OrientedCoordinateArray_8h_source.html#l00106">geos::noding::operator&lt;()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1noding_1_1OrientedCoordinateArray_a682a6401c2e7e6b5c8b62b841891925b_icgraph.svg" width="472" 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="a47d59c388aabb8edcc6af5f81be0ae52"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool geos::noding::OrientedCoordinateArray::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1noding_1_1OrientedCoordinateArray.html">OrientedCoordinateArray</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa89b0207a4411f313f687540432d6542"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool geos::noding::OrientedCoordinateArray::orientation </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><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>Computes the canonical orientation for a coordinate array.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pts</td><td>the array to test </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the points are oriented forwards </dd>
<dd>
<code>false</code> if the points are oriented in reverse </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a13b6528593a79207fcb6a3b0e9872059"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool geos::noding::OrientedCoordinateArray::orientationVar</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="OrientedCoordinateArray_8h_source.html#l00098">98</a> of file <a class="el" href="OrientedCoordinateArray_8h_source.html">OrientedCoordinateArray.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9dd844f7dff5154870685113cb1b504d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a>* geos::noding::OrientedCoordinateArray::pts</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Externally owned. </p>
<p>Definition at line <a class="el" href="OrientedCoordinateArray_8h_source.html#l00096">96</a> of file <a class="el" href="OrientedCoordinateArray_8h_source.html">OrientedCoordinateArray.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OrientedCoordinateArray_8h_source.html">OrientedCoordinateArray.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>