libs/geometry/doc/html/geometry/reference/algorithms/sym_difference/sym_difference_4_with_strategy.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>sym_difference (with strategy)</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="../sym_difference.html" title="sym_difference">
   9 <link rel="prev" href="../sym_difference.html" title="sym_difference">
  10 <link rel="next" href="sym_difference_3.html" title="sym_difference">
  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="../sym_difference.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sym_difference.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="sym_difference_3.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.sym_difference.sym_difference_4_with_strategy"></a><a class="link" href="sym_difference_4_with_strategy.html" title="sym_difference (with strategy)">sym_difference
  28           (with strategy)</a>
  29 </h5></div></div></div>
  30 <p>
  31             <a class="indexterm" name="idp104515808"></a>
  32 Calculate the symmetric difference of two geometries.
  33           </p>
  34 <h6>
  35 <a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.h0"></a>
  36             <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.description"></a></span><a class="link" href="sym_difference_4_with_strategy.html#geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.description">Description</a>
  37           </h6>
  38 <p>
  39             The free function symmetric difference calculates the spatial set theoretic
  40             symmetric difference (XOR) of two geometries.
  41           </p>
  42 <h6>
  43 <a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.h1"></a>
  44             <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.synopsis"></a></span><a class="link" href="sym_difference_4_with_strategy.html#geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.synopsis">Synopsis</a>
  45           </h6>
  46 <p>
  47 </p>
  48 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Geometry1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Geometry2</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Collection</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Strategy</span><span class="special">&gt;</span>
  49 <span class="keyword">void</span> <span class="identifier">sym_difference</span><span class="special">(</span><span class="identifier">Geometry1</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">geometry1</span><span class="special">,</span> <span class="identifier">Geometry2</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">geometry2</span><span class="special">,</span> <span class="identifier">Collection</span> <span class="special">&amp;</span> <span class="identifier">output_collection</span><span class="special">,</span>
  50                     <span class="identifier">Strategy</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">strategy</span><span class="special">)</span></pre>
  51 <p>
  52           </p>
  53 <h6>
  54 <a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.h2"></a>
  55             <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.parameters"></a></span><a class="link" href="sym_difference_4_with_strategy.html#geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.parameters">Parameters</a>
  56           </h6>
  57 <div class="informaltable"><table class="table">
  58 <colgroup>
  59 <col>
  60 <col>
  61 <col>
  62 <col>
  63 </colgroup>
  64 <thead><tr>
  65 <th>
  66                     <p>
  67                       Type
  68                     </p>
  69                   </th>
  70 <th>
  71                     <p>
  72                       Concept
  73                     </p>
  74                   </th>
  75 <th>
  76                     <p>
  77                       Name
  78                     </p>
  79                   </th>
  80 <th>
  81                     <p>
  82                       Description
  83                     </p>
  84                   </th>
  85 </tr></thead>
  86 <tbody>
  87 <tr>
  88 <td>
  89                     <p>
  90                       Geometry1 const &amp;
  91                     </p>
  92                   </td>
  93 <td>
  94                     <p>
  95                       Any type fulfilling a Geometry Concept
  96                     </p>
  97                   </td>
  98 <td>
  99                     <p>
 100                       geometry1
 101                     </p>
 102                   </td>
 103 <td>
 104                     <p>
 105                       A model of the specified concept
 106                     </p>
 107                   </td>
 108 </tr>
 109 <tr>
 110 <td>
 111                     <p>
 112                       Geometry2 const &amp;
 113                     </p>
 114                   </td>
 115 <td>
 116                     <p>
 117                       Any type fulfilling a Geometry Concept
 118                     </p>
 119                   </td>
 120 <td>
 121                     <p>
 122                       geometry2
 123                     </p>
 124                   </td>
 125 <td>
 126                     <p>
 127                       A model of the specified concept
 128                     </p>
 129                   </td>
 130 </tr>
 131 <tr>
 132 <td>
 133                     <p>
 134                       Collection &amp;
 135                     </p>
 136                   </td>
 137 <td>
 138                     <p>
 139                       output collection, either a multi-geometry, or a std::vector&lt;Geometry&gt;
 140                       / std::deque&lt;Geometry&gt; etc
 141                     </p>
 142                   </td>
 143 <td>
 144                     <p>
 145                       output_collection
 146                     </p>
 147                   </td>
 148 <td>
 149                     <p>
 150                       the output collection
 151                     </p>
 152                   </td>
 153 </tr>
 154 <tr>
 155 <td>
 156                     <p>
 157                       Strategy const &amp;
 158                     </p>
 159                   </td>
 160 <td>
 161                     <p>
 162                       Any type fulfilling a Sym_difference Strategy Concept
 163                     </p>
 164                   </td>
 165 <td>
 166                     <p>
 167                       strategy
 168                     </p>
 169                   </td>
 170 <td>
 171                     <p>
 172                       The strategy which will be used for sym_difference calculations
 173                     </p>
 174                   </td>
 175 </tr>
 176 </tbody>
 177 </table></div>
 178 <h6>
 179 <a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.h3"></a>
 180             <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.header"></a></span><a class="link" href="sym_difference_4_with_strategy.html#geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.header">Header</a>
 181           </h6>
 182 <p>
 183             Either
 184           </p>
 185 <p>
 186             <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>
 187           </p>
 188 <p>
 189             Or
 190           </p>
 191 <p>
 192             <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">sym_difference</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 193           </p>
 194 <h6>
 195 <a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.h4"></a>
 196             <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.conformance"></a></span><a class="link" href="sym_difference_4_with_strategy.html#geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.conformance">Conformance</a>
 197           </h6>
 198 <p>
 199             The function sym_difference implements function SymDifference from the
 200             <a href="http://www.opengeospatial.org/standards/sfa" target="_top">OGC Simple Feature
 201             Specification</a>.
 202           </p>
 203 <h6>
 204 <a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.h5"></a>
 205             <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.behavior"></a></span><a class="link" href="sym_difference_4_with_strategy.html#geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.behavior">Behavior</a>
 206           </h6>
 207 <div class="informaltable"><table class="table">
 208 <colgroup>
 209 <col>
 210 <col>
 211 </colgroup>
 212 <thead><tr>
 213 <th>
 214                     <p>
 215                       Case
 216                     </p>
 217                   </th>
 218 <th>
 219                     <p>
 220                       Behavior
 221                     </p>
 222                   </th>
 223 </tr></thead>
 224 <tbody>
 225 <tr>
 226 <td>
 227                     <p>
 228                       areal (e.g. polygon)
 229                     </p>
 230                   </td>
 231 <td>
 232                     <p>
 233                       All combinations of: box, ring, polygon, multi_polygon
 234                     </p>
 235                   </td>
 236 </tr>
 237 <tr>
 238 <td>
 239                     <p>
 240                       linear (e.g. linestring) / areal (e.g. polygon)
 241                     </p>
 242                   </td>
 243 <td>
 244                     <p>
 245                       A combinations of a (multi) linestring with a (multi) polygon
 246                       results in a collection of linestrings
 247                     </p>
 248                   </td>
 249 </tr>
 250 <tr>
 251 <td>
 252                     <p>
 253                       linear (e.g. linestring)
 254                     </p>
 255                   </td>
 256 <td>
 257                     <p>
 258                       All combinations of: linestring, multi_linestring; results
 259                       in a collection of linestrings
 260                     </p>
 261                   </td>
 262 </tr>
 263 <tr>
 264 <td>
 265                     <p>
 266                       pointlike (e.g. point)
 267                     </p>
 268                   </td>
 269 <td>
 270                     <p>
 271                       All combinations of: point, multi_point; results in a collection
 272                       of points
 273                     </p>
 274                   </td>
 275 </tr>
 276 <tr>
 277 <td>
 278                     <p>
 279                       Other geometries
 280                     </p>
 281                   </td>
 282 <td>
 283                     <p>
 284                       Not yet supported in this version
 285                     </p>
 286                   </td>
 287 </tr>
 288 <tr>
 289 <td>
 290                     <p>
 291                       Spherical
 292                     </p>
 293                   </td>
 294 <td>
 295                     <p>
 296                       Not yet supported in this version
 297                     </p>
 298                   </td>
 299 </tr>
 300 <tr>
 301 <td>
 302                     <p>
 303                       Three dimensional
 304                     </p>
 305                   </td>
 306 <td>
 307                     <p>
 308                       Not yet supported in this version
 309                     </p>
 310                   </td>
 311 </tr>
 312 </tbody>
 313 </table></div>
 314 <div class="note"><table border="0" summary="Note">
 315 <tr>
 316 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
 317 <th align="left">Note</th>
 318 </tr>
 319 <tr><td align="left" valign="top"><p>
 320               Check the <a class="link" href="../../concepts/concept_polygon.html" title="Polygon Concept">Polygon
 321               Concept</a> for the rules that polygon input for this algorithm
 322               should fulfill
 323             </p></td></tr>
 324 </table></div>
 325 <h6>
 326 <a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.h6"></a>
 327             <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.example"></a></span><a class="link" href="sym_difference_4_with_strategy.html#geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.example">Example</a>
 328           </h6>
 329 <p>
 330             Shows how to calculate the symmetric difference (XOR) of two polygons
 331           </p>
 332 <p>
 333 </p>
 334 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
 335
 336 <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>
 337 <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>
 338 <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>
 339 <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_polygon</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 340
 341 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">foreach</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 342
 343
 344 <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
 345 <span class="special">{</span>
 346     <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">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="special">&gt;</span> <span class="identifier">polygon</span><span class="special">;</span>
 347
 348     <span class="identifier">polygon</span> <span class="identifier">green</span><span class="special">,</span> <span class="identifier">blue</span><span class="special">;</span>
 349
 350     <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>
 351         <span class="string">"POLYGON((2 1.3,2.4 1.7,2.8 1.8,3.4 1.2,3.7 1.6,3.4 2,4.1 3,5.3 2.6,5.4 1.2,4.9 0.8,2.9 0.7,2 1.3)"</span>
 352             <span class="string">"(4.0 2.0, 4.2 1.4, 4.8 1.9, 4.4 2.2, 4.0 2.0))"</span><span class="special">,</span> <span class="identifier">green</span><span class="special">);</span>
 353
 354     <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>
 355         <span class="string">"POLYGON((4.0 -0.5 , 3.5 1.0 , 2.0 1.5 , 3.5 2.0 , 4.0 3.5 , 4.5 2.0 , 6.0 1.5 , 4.5 1.0 , 4.0 -0.5))"</span><span class="special">,</span> <span class="identifier">blue</span><span class="special">);</span>
 356
 357     <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_polygon</span><span class="special">&lt;</span><span class="identifier">polygon</span><span class="special">&gt;</span> <span class="identifier">multi</span><span class="special">;</span>
 358
 359     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">sym_difference</span><span class="special">(</span><span class="identifier">green</span><span class="special">,</span> <span class="identifier">blue</span><span class="special">,</span> <span class="identifier">multi</span><span class="special">);</span>
 360
 361     <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span>
 362         <span class="special">&lt;&lt;</span> <span class="string">"green XOR blue:"</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span>
 363         <span class="special">&lt;&lt;</span> <span class="string">"total: "</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">area</span><span class="special">(</span><span class="identifier">multi</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>
 364     <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span>
 365     <span class="identifier">BOOST_FOREACH</span><span class="special">(</span><span class="identifier">polygon</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">p</span><span class="special">,</span> <span class="identifier">multi</span><span class="special">)</span>
 366     <span class="special">{</span>
 367         <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">i</span><span class="special">++</span> <span class="special">&lt;&lt;</span> <span class="string">": "</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">area</span><span class="special">(</span><span class="identifier">p</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>
 368     <span class="special">}</span>
 369
 370
 371     <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
 372 <span class="special">}</span>
 373 </pre>
 374 <p>
 375           </p>
 376 <p>
 377             Output:
 378           </p>
 379 <pre class="programlisting">green XOR blue:
 380 total: 3.1459
 381 0: 0.02375
 382 1: 0.542951
 383 2: 0.0149697
 384 3: 0.226855
 385 4: 0.839424
 386 5: 0.525154
 387 6: 0.015
 388 7: 0.181136
 389 8: 0.128798
 390 9: 0.340083
 391 10: 0.307778
 392
 393 <img src="../../../../img/algorithms/sym_difference.png" alt="sym_difference">
 394
 395 </pre>
 396 <h6>
 397 <a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.h7"></a>
 398             <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.see_also"></a></span><a class="link" href="sym_difference_4_with_strategy.html#geometry.reference.algorithms.sym_difference.sym_difference_4_with_strategy.see_also">See
 399             also</a>
 400           </h6>
 401 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 402 <li class="listitem">
 403                 <a class="link" href="../difference.html" title="difference">difference</a>
 404               </li>
 405 <li class="listitem">
 406                 <a class="link" href="../intersection.html" title="intersection">intersection</a>
 407               </li>
 408 <li class="listitem">
 409                 <a class="link" href="../union_.html" title="union_">union</a>
 410               </li>
 411 </ul></div>
 412 </div>
 413 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 414 <td align="left"></td>
 415 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2017 Barend
 416       Gehrels, Bruno Lalande, Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its
 417       affiliates<p>
 418         Distributed under the Boost Software License, Version 1.0. (See accompanying
 419         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>)
 420       </p>
 421 </div></td>
 422 </tr></table>
 423 <hr>
 424 <div class="spirit-nav">
 425 <a accesskey="p" href="../sym_difference.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sym_difference.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="sym_difference_3.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 426 </div>
 427 </body>
 428 </html>