diff options
Diffstat (limited to 'libs/geometry/doc/html/geometry/reference/algorithms/is_valid.html')
| -rw-r--r-- | libs/geometry/doc/html/geometry/reference/algorithms/is_valid.html | 327 |
1 files changed, 12 insertions, 315 deletions
diff --git a/libs/geometry/doc/html/geometry/reference/algorithms/is_valid.html b/libs/geometry/doc/html/geometry/reference/algorithms/is_valid.html index bf43d30dd..071a8d6de 100644 --- a/libs/geometry/doc/html/geometry/reference/algorithms/is_valid.html +++ b/libs/geometry/doc/html/geometry/reference/algorithms/is_valid.html @@ -7,7 +7,7 @@ <link rel="home" href="../../../index.html" title="Chapter 1. Geometry"> <link rel="up" href="../algorithms.html" title="Algorithms"> <link rel="prev" href="is_simple.html" title="is_simple"> -<link rel="next" href="length.html" title="length"> +<link rel="next" href="is_valid/is_valid_1.html" title="is_valid"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -20,327 +20,24 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="is_simple.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.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="length.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="is_simple.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.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/is_valid_1.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> <a name="geometry.reference.algorithms.is_valid"></a><a class="link" href="is_valid.html" title="is_valid">is_valid</a> </h4></div></div></div> -<p> - <a class="indexterm" name="idp117918384"></a> -Checks if a geometry is valid (in the OGC sense) - </p> -<h6> -<a name="geometry.reference.algorithms.is_valid.h0"></a> - <span class="phrase"><a name="geometry.reference.algorithms.is_valid.synopsis"></a></span><a class="link" href="is_valid.html#geometry.reference.algorithms.is_valid.synopsis">Synopsis</a> - </h6> -<p> -</p> -<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">></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">&</span> <span class="identifier">geometry</span><span class="special">)</span></pre> -<p> - </p> -<h6> -<a name="geometry.reference.algorithms.is_valid.h1"></a> - <span class="phrase"><a name="geometry.reference.algorithms.is_valid.parameters"></a></span><a class="link" href="is_valid.html#geometry.reference.algorithms.is_valid.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 & - </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.h2"></a> - <span class="phrase"><a name="geometry.reference.algorithms.is_valid.returns"></a></span><a class="link" href="is_valid.html#geometry.reference.algorithms.is_valid.returns">Returns</a> - </h6> -<p> - Returns true if the geometry is valid (in the OGC sense) - </p> -<h6> -<a name="geometry.reference.algorithms.is_valid.h3"></a> - <span class="phrase"><a name="geometry.reference.algorithms.is_valid.header"></a></span><a class="link" href="is_valid.html#geometry.reference.algorithms.is_valid.header">Header</a> - </h6> -<p> - Either - </p> -<p> - <code class="computeroutput"><span class="preprocessor">#include</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">hpp</span><span class="special">></span></code> - </p> -<p> - Or - </p> -<p> - <code class="computeroutput"><span class="preprocessor">#include</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">algorithms</span><span class="special">/</span><span class="identifier">is_valid</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> - </p> -<h6> -<a name="geometry.reference.algorithms.is_valid.h4"></a> - <span class="phrase"><a name="geometry.reference.algorithms.is_valid.conformance"></a></span><a class="link" href="is_valid.html#geometry.reference.algorithms.is_valid.conformance">Conformance</a> - </h6> -<p> - The function is_valid is not defined by OGC. - </p> -<h6> -<a name="geometry.reference.algorithms.is_valid.h5"></a> - <span class="phrase"><a name="geometry.reference.algorithms.is_valid.supported_geometries"></a></span><a class="link" href="is_valid.html#geometry.reference.algorithms.is_valid.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.h6"></a> - <span class="phrase"><a name="geometry.reference.algorithms.is_valid.complexity"></a></span><a class="link" href="is_valid.html#geometry.reference.algorithms.is_valid.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.h7"></a> - <span class="phrase"><a name="geometry.reference.algorithms.is_valid.example"></a></span><a class="link" href="is_valid.html#geometry.reference.algorithms.is_valid.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"><</span><span class="identifier">iostream</span><span class="special">></span> - -<span class="preprocessor">#include</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">hpp</span><span class="special">></span> -<span class="preprocessor">#include</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">geometries</span><span class="special">/</span><span class="identifier">point_xy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> -<span class="preprocessor">#include</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">geometries</span><span class="special">/</span><span class="identifier">polygon</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></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"><</span><span class="keyword">double</span><span class="special">></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"><</span><span class="identifier">point_type</span><span class="special">></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"><<</span> <span class="string">"is valid? "</span> <span class="special"><<</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"><<</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.h8"></a> - <span class="phrase"><a name="geometry.reference.algorithms.is_valid.see_also"></a></span><a class="link" href="is_valid.html#geometry.reference.algorithms.is_valid.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 class="toc"><dl class="toc"> +<dt><span class="section"><a href="is_valid/is_valid_1.html">is_valid</a></span></dt> +<dt><span class="section"><a href="is_valid/is_valid_2_with_failure_value.html">is_valid + (with failure value)</a></span></dt> +<dt><span class="section"><a href="is_valid/is_valid_2_with_message.html">is_valid + (with message)</a></span></dt> +</dl></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 © 2009-2014 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam - Wulkiewicz, Oracle and/or its affiliates<p> +<td align="right"><div class="copyright-footer">Copyright © 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> @@ -348,7 +45,7 @@ Checks if a geometry is valid (in the OGC sense) </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="is_simple.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.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="length.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="is_simple.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.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/is_valid_1.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |