libs/geometry/doc/html/geometry/reference/algorithms/unique.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>unique</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="../algorithms.html" title="Algorithms">
   9 <link rel="prev" href="union_/union__3.html" title="union_">
  10 <link rel="next" href="within.html" title="within">
  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="union_/union__3.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="within.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="geometry.reference.algorithms.unique"></a><a class="link" href="unique.html" title="unique">unique</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm46186989896224"></a>
  31 Calculates the minimal set of a geometry.
  32         </p>
  33 <h6>
  34 <a name="geometry.reference.algorithms.unique.h0"></a>
  35           <span class="phrase"><a name="geometry.reference.algorithms.unique.description"></a></span><a class="link" href="unique.html#geometry.reference.algorithms.unique.description">Description</a>
  36         </h6>
  37 <p>
  38           The free function unique calculates the minimal set (where duplicate consecutive
  39           points are removed) of a geometry.
  40         </p>
  41 <h6>
  42 <a name="geometry.reference.algorithms.unique.h1"></a>
  43           <span class="phrase"><a name="geometry.reference.algorithms.unique.synopsis"></a></span><a class="link" href="unique.html#geometry.reference.algorithms.unique.synopsis">Synopsis</a>
  44         </h6>
  45 <p>
  46 </p>
  47 <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>
  48 <span class="keyword">void</span> <span class="identifier">unique</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="special">&amp;</span> <span class="identifier">geometry</span><span class="special">)</span></pre>
  49 <p>
  50         </p>
  51 <h6>
  52 <a name="geometry.reference.algorithms.unique.h2"></a>
  53           <span class="phrase"><a name="geometry.reference.algorithms.unique.parameters"></a></span><a class="link" href="unique.html#geometry.reference.algorithms.unique.parameters">Parameters</a>
  54         </h6>
  55 <div class="informaltable"><table class="table">
  56 <colgroup>
  57 <col>
  58 <col>
  59 <col>
  60 <col>
  61 </colgroup>
  62 <thead><tr>
  63 <th>
  64                   <p>
  65                     Type
  66                   </p>
  67                 </th>
  68 <th>
  69                   <p>
  70                     Concept
  71                   </p>
  72                 </th>
  73 <th>
  74                   <p>
  75                     Name
  76                   </p>
  77                 </th>
  78 <th>
  79                   <p>
  80                     Description
  81                   </p>
  82                 </th>
  83 </tr></thead>
  84 <tbody><tr>
  85 <td>
  86                   <p>
  87                     Geometry &amp;
  88                   </p>
  89                 </td>
  90 <td>
  91                   <p>
  92                     Any type fulfilling a Geometry Concept
  93                   </p>
  94                 </td>
  95 <td>
  96                   <p>
  97                     geometry
  98                   </p>
  99                 </td>
 100 <td>
 101                   <p>
 102                     A model of the specified concept which will be made unique
 103                   </p>
 104                 </td>
 105 </tr></tbody>
 106 </table></div>
 107 <h6>
 108 <a name="geometry.reference.algorithms.unique.h3"></a>
 109           <span class="phrase"><a name="geometry.reference.algorithms.unique.header"></a></span><a class="link" href="unique.html#geometry.reference.algorithms.unique.header">Header</a>
 110         </h6>
 111 <p>
 112           Either
 113         </p>
 114 <p>
 115           <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>
 116         </p>
 117 <p>
 118           Or
 119         </p>
 120 <p>
 121           <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">unique</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 122         </p>
 123 <h6>
 124 <a name="geometry.reference.algorithms.unique.h4"></a>
 125           <span class="phrase"><a name="geometry.reference.algorithms.unique.conformance"></a></span><a class="link" href="unique.html#geometry.reference.algorithms.unique.conformance">Conformance</a>
 126         </h6>
 127 <p>
 128           The function unique is not defined by OGC.
 129         </p>
 130 <p>
 131           The function unique conforms to the std::unique function of the C++ std-library.
 132         </p>
 133 <h6>
 134 <a name="geometry.reference.algorithms.unique.h5"></a>
 135           <span class="phrase"><a name="geometry.reference.algorithms.unique.behavior"></a></span><a class="link" href="unique.html#geometry.reference.algorithms.unique.behavior">Behavior</a>
 136         </h6>
 137 <div class="informaltable"><table class="table">
 138 <colgroup>
 139 <col>
 140 <col>
 141 </colgroup>
 142 <thead><tr>
 143 <th>
 144                   <p>
 145                     Case
 146                   </p>
 147                 </th>
 148 <th>
 149                   <p>
 150                     Behavior
 151                   </p>
 152                 </th>
 153 </tr></thead>
 154 <tbody>
 155 <tr>
 156 <td>
 157                   <p>
 158                     Point
 159                   </p>
 160                 </td>
 161 <td>
 162                   <p>
 163                     Nothing happens, geometry is unchanged
 164                   </p>
 165                 </td>
 166 </tr>
 167 <tr>
 168 <td>
 169                   <p>
 170                     Segment
 171                   </p>
 172                 </td>
 173 <td>
 174                   <p>
 175                     Nothing happens, geometry is unchanged
 176                   </p>
 177                 </td>
 178 </tr>
 179 <tr>
 180 <td>
 181                   <p>
 182                     Box
 183                   </p>
 184                 </td>
 185 <td>
 186                   <p>
 187                     Nothing happens, geometry is unchanged
 188                   </p>
 189                 </td>
 190 </tr>
 191 <tr>
 192 <td>
 193                   <p>
 194                     Linestring
 195                   </p>
 196                 </td>
 197 <td>
 198                   <p>
 199                     Removes all consecutive duplicate points
 200                   </p>
 201                 </td>
 202 </tr>
 203 <tr>
 204 <td>
 205                   <p>
 206                     Ring
 207                   </p>
 208                 </td>
 209 <td>
 210                   <p>
 211                     Removes all consecutive duplicate points
 212                   </p>
 213                 </td>
 214 </tr>
 215 <tr>
 216 <td>
 217                   <p>
 218                     Polygon
 219                   </p>
 220                 </td>
 221 <td>
 222                   <p>
 223                     Removes all consecutive duplicate points in all rings
 224                   </p>
 225                 </td>
 226 </tr>
 227 <tr>
 228 <td>
 229                   <p>
 230                     Multi Point
 231                   </p>
 232                 </td>
 233 <td>
 234                   <p>
 235                     Nothing happens, geometry is unchanged. Even if two equal points
 236                     happen to be stored consecutively, they are kept
 237                   </p>
 238                 </td>
 239 </tr>
 240 <tr>
 241 <td>
 242                   <p>
 243                     Multi Linestring
 244                   </p>
 245                 </td>
 246 <td>
 247                   <p>
 248                     Removes all consecutive duplicate points in all contained linestrings
 249                   </p>
 250                 </td>
 251 </tr>
 252 <tr>
 253 <td>
 254                   <p>
 255                     Multi Polygon
 256                   </p>
 257                 </td>
 258 <td>
 259                   <p>
 260                     Removes all consecutive duplicate points in all contained polygons
 261                     (all rings)
 262                   </p>
 263                 </td>
 264 </tr>
 265 </tbody>
 266 </table></div>
 267 <h6>
 268 <a name="geometry.reference.algorithms.unique.h6"></a>
 269           <span class="phrase"><a name="geometry.reference.algorithms.unique.complexity"></a></span><a class="link" href="unique.html#geometry.reference.algorithms.unique.complexity">Complexity</a>
 270         </h6>
 271 <p>
 272           Linear
 273         </p>
 274 <h6>
 275 <a name="geometry.reference.algorithms.unique.h7"></a>
 276           <span class="phrase"><a name="geometry.reference.algorithms.unique.example"></a></span><a class="link" href="unique.html#geometry.reference.algorithms.unique.example">Example</a>
 277         </h6>
 278 <p>
 279           Shows how to make a so-called minimal set of a polygon by removing duplicate
 280           points
 281         </p>
 282 <p>
 283 </p>
 284 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
 285
 286 <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>
 287 <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>
 288 <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">adapted</span><span class="special">/</span><span class="identifier">boost_tuple</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 289
 290 <span class="identifier">BOOST_GEOMETRY_REGISTER_BOOST_TUPLE_CS</span><span class="special">(</span><span class="identifier">cs</span><span class="special">::</span><span class="identifier">cartesian</span><span class="special">)</span>
 291
 292 <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
 293 <span class="special">{</span>
 294     <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">boost</span><span class="special">::</span><span class="identifier">tuple</span><span class="special">&lt;</span><span class="keyword">double</span><span class="special">,</span> <span class="keyword">double</span><span class="special">&gt;</span> <span class="special">&gt;</span> <span class="identifier">poly</span><span class="special">;</span>
 295     <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 0,0 5,5 5,5 5,5 5,5 0,5 0,0 0,0 0,0 0,0 0))"</span><span class="special">,</span> <span class="identifier">poly</span><span class="special">);</span>
 296     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">unique</span><span class="special">(</span><span class="identifier">poly</span><span class="special">);</span>
 297     <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">wkt</span><span class="special">(</span><span class="identifier">poly</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>
 298
 299     <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
 300 <span class="special">}</span>
 301 </pre>
 302 <p>
 303         </p>
 304 <p>
 305           Output:
 306         </p>
 307 <pre class="programlisting">POLYGON((0 0,0 5,5 5,5 0,0 0))
 308 </pre>
 309 </div>
 310 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 311 <td align="left"></td>
 312 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 313       Wulkiewicz, Oracle and/or its affiliates<p>
 314         Distributed under the Boost Software License, Version 1.0. (See accompanying
 315         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>)
 316       </p>
 317 </div></td>
 318 </tr></table>
 319 <hr>
 320 <div class="spirit-nav">
 321 <a accesskey="p" href="union_/union__3.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="within.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 322 </div>
 323 </body>
 324 </html>