Google Git
Sign in
nest-open-source / nest-cam / 4320010 / boost / 62d1066a6d52d5ac4e10c106f0eab14c820be0ce / . / boost / libs / geometry / doc / html / geometry / reference / algorithms / is_valid / is_valid_1.html
blob: 3fea9062862ca686bfa089bc4dd169814175b5d1 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>is_valid</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Geometry">
<link rel="up" href="../is_valid.html" title="is_valid">
<link rel="prev" href="../is_valid.html" title="is_valid">
<link rel="next" href="is_valid_2_with_failure_value.html" title="is_valid (with failure value)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../is_valid.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../is_valid.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="is_valid_2_with_failure_value.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry.reference.algorithms.is_valid.is_valid_1"></a><a class="link" href="is_valid_1.html" title="is_valid">is_valid</a>
</h5></div></div></div>
<p>
<a class="indexterm" name="idp114978496"></a>
Checks if a geometry is valid (in the OGC sense)
</p>
<h6>
<a name="geometry.reference.algorithms.is_valid.is_valid_1.h0"></a>
<span class="phrase"><a name="geometry.reference.algorithms.is_valid.is_valid_1.synopsis"></a></span><a class="link" href="is_valid_1.html#geometry.reference.algorithms.is_valid.is_valid_1.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">&gt;</span>
<span class="keyword">bool</span> <span class="identifier">is_valid</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">geometry</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry.reference.algorithms.is_valid.is_valid_1.h1"></a>
<span class="phrase"><a name="geometry.reference.algorithms.is_valid.is_valid_1.parameters"></a></span><a class="link" href="is_valid_1.html#geometry.reference.algorithms.is_valid.is_valid_1.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Concept
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
Geometry const &amp;
</p>
</td>
<td>
<p>
Any type fulfilling a Geometry Concept
</p>
</td>
<td>
<p>
geometry
</p>
</td>
<td>
<p>
A model of the specified concept
</p>
</td>
</tr></tbody>
</table></div>
<h6>
<a name="geometry.reference.algorithms.is_valid.is_valid_1.h2"></a>
<span class="phrase"><a name="geometry.reference.algorithms.is_valid.is_valid_1.returns"></a></span><a class="link" href="is_valid_1.html#geometry.reference.algorithms.is_valid.is_valid_1.returns">Returns</a>
</h6>
<p>
Returns true if the geometry is valid (in the OGC sense); furthermore,
the following geometries are considered valid: multi-geometries with
no elements, linear geometries containing spikes, areal geometries with
duplicate (consecutive) points
</p>
<h6>
<a name="geometry.reference.algorithms.is_valid.is_valid_1.h3"></a>
<span class="phrase"><a name="geometry.reference.algorithms.is_valid.is_valid_1.header"></a></span><a class="link" href="is_valid_1.html#geometry.reference.algorithms.is_valid.is_valid_1.header">Header</a>
</h6>
<p>
Either
</p>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<p>
Or
</p>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">algorithms</span><span class="special">/</span><span class="identifier">is_valid</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<h6>
<a name="geometry.reference.algorithms.is_valid.is_valid_1.h4"></a>
<span class="phrase"><a name="geometry.reference.algorithms.is_valid.is_valid_1.conformance"></a></span><a class="link" href="is_valid_1.html#geometry.reference.algorithms.is_valid.is_valid_1.conformance">Conformance</a>
</h6>
<p>
The function is_valid is not defined by OGC.
</p>
<h6>
<a name="geometry.reference.algorithms.is_valid.is_valid_1.h5"></a>
<span class="phrase"><a name="geometry.reference.algorithms.is_valid.is_valid_1.supported_geometries"></a></span><a class="link" href="is_valid_1.html#geometry.reference.algorithms.is_valid.is_valid_1.supported_geometries">Supported
geometries</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Geometry
</p>
</th>
<th>
<p>
Status
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
Point
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
Segment
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
Box
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
Linestring
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
Ring
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
Polygon
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
MultiPoint
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
MultiLinestring
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
MultiPolygon
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
Variant
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry.reference.algorithms.is_valid.is_valid_1.h6"></a>
<span class="phrase"><a name="geometry.reference.algorithms.is_valid.is_valid_1.complexity"></a></span><a class="link" href="is_valid_1.html#geometry.reference.algorithms.is_valid.is_valid_1.complexity">Complexity</a>
</h6>
<p>
Constant-time for points, segments, boxes and multi-points
</p>
<p>
Linear for linestrings and multi-linestrings
</p>
<p>
Linearithmic for rings
</p>
<p>
Currently, worst-case quadratic for polygons and multi-polygons
</p>
<h6>
<a name="geometry.reference.algorithms.is_valid.is_valid_1.h7"></a>
<span class="phrase"><a name="geometry.reference.algorithms.is_valid.is_valid_1.example"></a></span><a class="link" href="is_valid_1.html#geometry.reference.algorithms.is_valid.is_valid_1.example">Example</a>
</h6>
<p>
Checks whether a geometry is valid
</p>
<p>
</p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">point_xy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">polygon</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
<span class="special">{</span>
<span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">d2</span><span class="special">::</span><span class="identifier">point_xy</span><span class="special">&lt;</span><span class="keyword">double</span><span class="special">&gt;</span> <span class="identifier">point_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">polygon</span><span class="special">&lt;</span><span class="identifier">point_type</span><span class="special">&gt;</span> <span class="identifier">polygon_type</span><span class="special">;</span>
<span class="identifier">polygon_type</span> <span class="identifier">poly</span><span class="special">;</span>
<span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">read_wkt</span><span class="special">(</span><span class="string">"POLYGON((0 0,0 10,10 10,10 0,0 0),(0 0,9 1,9 2,0 0),(0 0,2 9,1 9,0 0),(2 9,9 2,9 9,2 9))"</span><span class="special">,</span> <span class="identifier">poly</span><span class="special">);</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"is valid? "</span> <span class="special">&lt;&lt;</span> <span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">is_valid</span><span class="special">(</span><span class="identifier">poly</span><span class="special">)</span> <span class="special">?</span> <span class="string">"yes"</span> <span class="special">:</span> <span class="string">"no"</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
<span class="special">}</span>
</pre>
<p>
</p>
<p>
Output:
</p>
<pre class="programlisting">is valid? no
<img src="../../../../img/algorithms/is_valid_example.png" alt="is_valid_example">
</pre>
<h6>
<a name="geometry.reference.algorithms.is_valid.is_valid_1.h8"></a>
<span class="phrase"><a name="geometry.reference.algorithms.is_valid.is_valid_1.see_also"></a></span><a class="link" href="is_valid_1.html#geometry.reference.algorithms.is_valid.is_valid_1.see_also">See
also</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
<a class="link" href="../is_simple.html" title="is_simple">is_simple</a>
</li></ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Barend Gehrels, Bruno Lalande,
Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its affiliates<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../is_valid.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../is_valid.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="is_valid_2_with_failure_value.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>