libs/geometry/doc/html/geometry/reference/algorithms/is_simple/is_simple_1.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>is_simple</title>
   5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Geometry">
   8 <link rel="up" href="../is_simple.html" title="is_simple">
   9 <link rel="prev" href="is_simple_2_with_strategy.html" title="is_simple (with strategy)">
  10 <link rel="next" href="../is_valid.html" title="is_valid">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="is_simple_2_with_strategy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../is_simple.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.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="geometry.reference.algorithms.is_simple.is_simple_1"></a><a class="link" href="is_simple_1.html" title="is_simple">is_simple</a>
  28 </h5></div></div></div>
  29 <p>
  30             <a class="indexterm" name="idm46186996887648"></a>
  31 Checks if a geometry is simple.
  32           </p>
  33 <h6>
  34 <a name="geometry.reference.algorithms.is_simple.is_simple_1.h0"></a>
  35             <span class="phrase"><a name="geometry.reference.algorithms.is_simple.is_simple_1.synopsis"></a></span><a class="link" href="is_simple_1.html#geometry.reference.algorithms.is_simple.is_simple_1.synopsis">Synopsis</a>
  36           </h6>
  37 <p>
  38 </p>
  39 <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>
  40 <span class="keyword">bool</span> <span class="identifier">is_simple</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>
  41 <p>
  42           </p>
  43 <h6>
  44 <a name="geometry.reference.algorithms.is_simple.is_simple_1.h1"></a>
  45             <span class="phrase"><a name="geometry.reference.algorithms.is_simple.is_simple_1.parameters"></a></span><a class="link" href="is_simple_1.html#geometry.reference.algorithms.is_simple.is_simple_1.parameters">Parameters</a>
  46           </h6>
  47 <div class="informaltable"><table class="table">
  48 <colgroup>
  49 <col>
  50 <col>
  51 <col>
  52 <col>
  53 </colgroup>
  54 <thead><tr>
  55 <th>
  56                     <p>
  57                       Type
  58                     </p>
  59                   </th>
  60 <th>
  61                     <p>
  62                       Concept
  63                     </p>
  64                   </th>
  65 <th>
  66                     <p>
  67                       Name
  68                     </p>
  69                   </th>
  70 <th>
  71                     <p>
  72                       Description
  73                     </p>
  74                   </th>
  75 </tr></thead>
  76 <tbody><tr>
  77 <td>
  78                     <p>
  79                       Geometry const &amp;
  80                     </p>
  81                   </td>
  82 <td>
  83                     <p>
  84                       Any type fulfilling a Geometry Concept
  85                     </p>
  86                   </td>
  87 <td>
  88                     <p>
  89                       geometry
  90                     </p>
  91                   </td>
  92 <td>
  93                     <p>
  94                       A model of the specified concept
  95                     </p>
  96                   </td>
  97 </tr></tbody>
  98 </table></div>
  99 <h6>
 100 <a name="geometry.reference.algorithms.is_simple.is_simple_1.h2"></a>
 101             <span class="phrase"><a name="geometry.reference.algorithms.is_simple.is_simple_1.returns"></a></span><a class="link" href="is_simple_1.html#geometry.reference.algorithms.is_simple.is_simple_1.returns">Returns</a>
 102           </h6>
 103 <p>
 104             Returns true if the geometry is simple
 105           </p>
 106 <h6>
 107 <a name="geometry.reference.algorithms.is_simple.is_simple_1.h3"></a>
 108             <span class="phrase"><a name="geometry.reference.algorithms.is_simple.is_simple_1.header"></a></span><a class="link" href="is_simple_1.html#geometry.reference.algorithms.is_simple.is_simple_1.header">Header</a>
 109           </h6>
 110 <p>
 111             Either
 112           </p>
 113 <p>
 114             <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>
 115           </p>
 116 <p>
 117             Or
 118           </p>
 119 <p>
 120             <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_simple</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 121           </p>
 122 <h6>
 123 <a name="geometry.reference.algorithms.is_simple.is_simple_1.h4"></a>
 124             <span class="phrase"><a name="geometry.reference.algorithms.is_simple.is_simple_1.conformance"></a></span><a class="link" href="is_simple_1.html#geometry.reference.algorithms.is_simple.is_simple_1.conformance">Conformance</a>
 125           </h6>
 126 <p>
 127             The function is_simple implements function IsSimple from the <a href="http://www.opengeospatial.org/standards/sfa" target="_top">OGC
 128             Simple Feature Specification</a>.
 129           </p>
 130 <h6>
 131 <a name="geometry.reference.algorithms.is_simple.is_simple_1.h5"></a>
 132             <span class="phrase"><a name="geometry.reference.algorithms.is_simple.is_simple_1.supported_geometries"></a></span><a class="link" href="is_simple_1.html#geometry.reference.algorithms.is_simple.is_simple_1.supported_geometries">Supported
 133             geometries</a>
 134           </h6>
 135 <div class="informaltable"><table class="table">
 136 <colgroup>
 137 <col>
 138 <col>
 139 </colgroup>
 140 <thead><tr>
 141 <th>
 142                     <p>
 143                       Geometry
 144                     </p>
 145                   </th>
 146 <th>
 147                     <p>
 148                       Status
 149                     </p>
 150                   </th>
 151 </tr></thead>
 152 <tbody>
 153 <tr>
 154 <td>
 155                     <p>
 156                       Point
 157                     </p>
 158                   </td>
 159 <td>
 160                     <p>
 161                       <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
 162                     </p>
 163                   </td>
 164 </tr>
 165 <tr>
 166 <td>
 167                     <p>
 168                       Segment
 169                     </p>
 170                   </td>
 171 <td>
 172                     <p>
 173                       <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
 174                     </p>
 175                   </td>
 176 </tr>
 177 <tr>
 178 <td>
 179                     <p>
 180                       Box
 181                     </p>
 182                   </td>
 183 <td>
 184                     <p>
 185                       <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
 186                     </p>
 187                   </td>
 188 </tr>
 189 <tr>
 190 <td>
 191                     <p>
 192                       Linestring
 193                     </p>
 194                   </td>
 195 <td>
 196                     <p>
 197                       <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
 198                     </p>
 199                   </td>
 200 </tr>
 201 <tr>
 202 <td>
 203                     <p>
 204                       Ring
 205                     </p>
 206                   </td>
 207 <td>
 208                     <p>
 209                       <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
 210                     </p>
 211                   </td>
 212 </tr>
 213 <tr>
 214 <td>
 215                     <p>
 216                       Polygon
 217                     </p>
 218                   </td>
 219 <td>
 220                     <p>
 221                       <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
 222                     </p>
 223                   </td>
 224 </tr>
 225 <tr>
 226 <td>
 227                     <p>
 228                       MultiPoint
 229                     </p>
 230                   </td>
 231 <td>
 232                     <p>
 233                       <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
 234                     </p>
 235                   </td>
 236 </tr>
 237 <tr>
 238 <td>
 239                     <p>
 240                       MultiLinestring
 241                     </p>
 242                   </td>
 243 <td>
 244                     <p>
 245                       <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
 246                     </p>
 247                   </td>
 248 </tr>
 249 <tr>
 250 <td>
 251                     <p>
 252                       MultiPolygon
 253                     </p>
 254                   </td>
 255 <td>
 256                     <p>
 257                       <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
 258                     </p>
 259                   </td>
 260 </tr>
 261 <tr>
 262 <td>
 263                     <p>
 264                       Variant
 265                     </p>
 266                   </td>
 267 <td>
 268                     <p>
 269                       <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
 270                     </p>
 271                   </td>
 272 </tr>
 273 </tbody>
 274 </table></div>
 275 <h6>
 276 <a name="geometry.reference.algorithms.is_simple.is_simple_1.h6"></a>
 277             <span class="phrase"><a name="geometry.reference.algorithms.is_simple.is_simple_1.complexity"></a></span><a class="link" href="is_simple_1.html#geometry.reference.algorithms.is_simple.is_simple_1.complexity">Complexity</a>
 278           </h6>
 279 <p>
 280             Constant-time for points, segments and boxes
 281           </p>
 282 <p>
 283             Linear for rings, polygons and multi-polygons
 284           </p>
 285 <p>
 286             Linearithmic for multi-points, linestrings and multi-linestrings
 287           </p>
 288 <h6>
 289 <a name="geometry.reference.algorithms.is_simple.is_simple_1.h7"></a>
 290             <span class="phrase"><a name="geometry.reference.algorithms.is_simple.is_simple_1.example"></a></span><a class="link" href="is_simple_1.html#geometry.reference.algorithms.is_simple.is_simple_1.example">Example</a>
 291           </h6>
 292 <p>
 293             Checks whether a geometry is simple
 294           </p>
 295 <p>
 296 </p>
 297 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
 298
 299 <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>
 300 <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>
 301 <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">linestring</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 302 <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">multi_linestring</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 303
 304
 305 <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
 306 <span class="special">{</span>
 307     <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>
 308     <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">linestring</span><span class="special">&lt;</span><span class="identifier">point_type</span><span class="special">&gt;</span> <span class="identifier">linestring_type</span><span class="special">;</span>
 309     <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">multi_linestring</span><span class="special">&lt;</span><span class="identifier">linestring_type</span><span class="special">&gt;</span> <span class="identifier">multi_linestring_type</span><span class="special">;</span>
 310
 311     <span class="identifier">multi_linestring_type</span> <span class="identifier">multi_linestring</span><span class="special">;</span>
 312     <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">"MULTILINESTRING((0 0,0 10,10 10,10 0,0 0),(10 10,20 20))"</span><span class="special">,</span> <span class="identifier">multi_linestring</span><span class="special">);</span>
 313
 314     <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"is simple? "</span>
 315               <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_simple</span><span class="special">(</span><span class="identifier">multi_linestring</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>
 316               <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
 317
 318     <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
 319 <span class="special">}</span>
 320 </pre>
 321 <p>
 322           </p>
 323 <p>
 324             Output:
 325           </p>
 326 <pre class="programlisting">is simple? no
 327
 328 <img src="../../../../img/algorithms/is_simple_example.png" alt="is_simple_example">
 329
 330 </pre>
 331 <h6>
 332 <a name="geometry.reference.algorithms.is_simple.is_simple_1.h8"></a>
 333             <span class="phrase"><a name="geometry.reference.algorithms.is_simple.is_simple_1.see_also"></a></span><a class="link" href="is_simple_1.html#geometry.reference.algorithms.is_simple.is_simple_1.see_also">See
 334             also</a>
 335           </h6>
 336 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
 337                 <a class="link" href="../is_valid.html" title="is_valid">is_valid</a>
 338               </li></ul></div>
 339 </div>
 340 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 341 <td align="left"></td>
 342 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 343       Wulkiewicz, Oracle and/or its affiliates<p>
 344         Distributed under the Boost Software License, Version 1.0. (See accompanying
 345         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>)
 346       </p>
 347 </div></td>
 348 </tr></table>
 349 <hr>
 350 <div class="spirit-nav">
 351 <a accesskey="p" href="is_simple_2_with_strategy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../is_simple.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.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 352 </div>
 353 </body>
 354 </html>