3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>sym_difference</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 1. Geometry">
8 <link rel="up" href="../sym_difference.html" title="sym_difference">
9 <link rel="prev" href="sym_difference_4_with_strategy.html" title="sym_difference (with strategy)">
10 <link rel="next" href="../touches.html" title="touches">
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>
22 <div class="spirit-nav">
23 <a accesskey="p" href="sym_difference_4_with_strategy.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="../touches.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="titlepage"><div><div><h5 class="title">
27 <a name="geometry.reference.algorithms.sym_difference.sym_difference_3"></a><a class="link" href="sym_difference_3.html" title="sym_difference">sym_difference</a>
28 </h5></div></div></div>
30 <a class="indexterm" name="idp104752384"></a>
31 Calculate the symmetric difference of two geometries.
34 <a name="geometry.reference.algorithms.sym_difference.sym_difference_3.h0"></a>
35 <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_3.description"></a></span><a class="link" href="sym_difference_3.html#geometry.reference.algorithms.sym_difference.sym_difference_3.description">Description</a>
38 The free function symmetric difference calculates the spatial set theoretic
39 symmetric difference (XOR) of two geometries.
42 <a name="geometry.reference.algorithms.sym_difference.sym_difference_3.h1"></a>
43 <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_3.synopsis"></a></span><a class="link" href="sym_difference_3.html#geometry.reference.algorithms.sym_difference.sym_difference_3.synopsis">Synopsis</a>
47 <pre class="programlisting"><span class="keyword">template</span><span class="special"><</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>
48 <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">&</span> <span class="identifier">geometry1</span><span class="special">,</span> <span class="identifier">Geometry2</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">geometry2</span><span class="special">,</span> <span class="identifier">Collection</span> <span class="special">&</span> <span class="identifier">output_collection</span><span class="special">)</span></pre>
52 <a name="geometry.reference.algorithms.sym_difference.sym_difference_3.h2"></a>
53 <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_3.parameters"></a></span><a class="link" href="sym_difference_3.html#geometry.reference.algorithms.sym_difference.sym_difference_3.parameters">Parameters</a>
55 <div class="informaltable"><table class="table">
93 Any type fulfilling a Geometry Concept
103 A model of the specified concept
110 Geometry2 const &
115 Any type fulfilling a Geometry Concept
125 A model of the specified concept
137 output collection, either a multi-geometry, or a std::vector<Geometry>
138 / std::deque<Geometry> etc
148 the output collection
155 <a name="geometry.reference.algorithms.sym_difference.sym_difference_3.h3"></a>
156 <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_3.header"></a></span><a class="link" href="sym_difference_3.html#geometry.reference.algorithms.sym_difference.sym_difference_3.header">Header</a>
162 <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>
168 <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">sym_difference</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
171 <a name="geometry.reference.algorithms.sym_difference.sym_difference_3.h4"></a>
172 <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_3.conformance"></a></span><a class="link" href="sym_difference_3.html#geometry.reference.algorithms.sym_difference.sym_difference_3.conformance">Conformance</a>
175 The function sym_difference implements function SymDifference from the
176 <a href="http://www.opengeospatial.org/standards/sfa" target="_top">OGC Simple Feature
180 <a name="geometry.reference.algorithms.sym_difference.sym_difference_3.h5"></a>
181 <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_3.behavior"></a></span><a class="link" href="sym_difference_3.html#geometry.reference.algorithms.sym_difference.sym_difference_3.behavior">Behavior</a>
183 <div class="informaltable"><table class="table">
209 All combinations of: box, ring, polygon, multi_polygon
216 linear (e.g. linestring) / areal (e.g. polygon)
221 A combinations of a (multi) linestring with a (multi) polygon
222 results in a collection of linestrings
229 linear (e.g. linestring)
234 All combinations of: linestring, multi_linestring; results
235 in a collection of linestrings
242 pointlike (e.g. point)
247 All combinations of: point, multi_point; results in a collection
260 Not yet supported in this version
272 Not yet supported in this version
284 Not yet supported in this version
290 <div class="note"><table border="0" summary="Note">
292 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
293 <th align="left">Note</th>
295 <tr><td align="left" valign="top"><p>
296 Check the <a class="link" href="../../concepts/concept_polygon.html" title="Polygon Concept">Polygon
297 Concept</a> for the rules that polygon input for this algorithm
302 <a name="geometry.reference.algorithms.sym_difference.sym_difference_3.h6"></a>
303 <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_3.example"></a></span><a class="link" href="sym_difference_3.html#geometry.reference.algorithms.sym_difference.sym_difference_3.example">Example</a>
306 Shows how to calculate the symmetric difference (XOR) of two polygons
310 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span>
312 <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>
313 <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>
314 <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>
315 <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">multi_polygon</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
317 <span class="preprocessor">#include</span> <span class="special"><</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">></span>
320 <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
321 <span class="special">{</span>
322 <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">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="special">></span> <span class="identifier">polygon</span><span class="special">;</span>
324 <span class="identifier">polygon</span> <span class="identifier">green</span><span class="special">,</span> <span class="identifier">blue</span><span class="special">;</span>
326 <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>
327 <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>
328 <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>
330 <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>
331 <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>
333 <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"><</span><span class="identifier">polygon</span><span class="special">></span> <span class="identifier">multi</span><span class="special">;</span>
335 <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>
337 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span>
338 <span class="special"><<</span> <span class="string">"green XOR blue:"</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span>
339 <span class="special"><<</span> <span class="string">"total: "</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">area</span><span class="special">(</span><span class="identifier">multi</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>
340 <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span>
341 <span class="identifier">BOOST_FOREACH</span><span class="special">(</span><span class="identifier">polygon</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">p</span><span class="special">,</span> <span class="identifier">multi</span><span class="special">)</span>
342 <span class="special">{</span>
343 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">i</span><span class="special">++</span> <span class="special"><<</span> <span class="string">": "</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">area</span><span class="special">(</span><span class="identifier">p</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>
344 <span class="special">}</span>
347 <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
348 <span class="special">}</span>
355 <pre class="programlisting">green XOR blue:
369 <img src="../../../../img/algorithms/sym_difference.png" alt="sym_difference">
373 <a name="geometry.reference.algorithms.sym_difference.sym_difference_3.h7"></a>
374 <span class="phrase"><a name="geometry.reference.algorithms.sym_difference.sym_difference_3.see_also"></a></span><a class="link" href="sym_difference_3.html#geometry.reference.algorithms.sym_difference.sym_difference_3.see_also">See
377 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
378 <li class="listitem">
379 <a class="link" href="../difference.html" title="difference">difference</a>
381 <li class="listitem">
382 <a class="link" href="../intersection.html" title="intersection">intersection</a>
384 <li class="listitem">
385 <a class="link" href="../union_.html" title="union_">union</a>
389 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
390 <td align="left"></td>
391 <td align="right"><div class="copyright-footer">Copyright © 2009-2017 Barend
392 Gehrels, Bruno Lalande, Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its
394 Distributed under the Boost Software License, Version 1.0. (See accompanying
395 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>)
400 <div class="spirit-nav">
401 <a accesskey="p" href="sym_difference_4_with_strategy.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="../touches.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>