• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 [/============================================================================
2   Boost.Geometry (aka GGL, Generic Geometry Library)
3 
4   Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
5   Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
6   Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
7 
8   Use, modification and distribution is subject to the Boost Software License,
9   Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
10   http://www.boost.org/LICENSE_1_0.txt)
11 =============================================================================/]
12 
13 
14 [/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
15 [/ Generated from doxy/doxygen_output/xml/group__sym__difference.xml]
16 [section:sym_difference_4_with_strategy sym_difference (with strategy)]
17 
18 '''<indexterm><primary>sym_difference</primary></indexterm>'''
19 Calculate the symmetric difference of two geometries.
20 
21 [heading Description]
22 The free function symmetric difference calculates the spatial set theoretic symmetric difference (XOR) of two geometries.
23 
24 [heading Synopsis]
25 ``template<typename Geometry1, typename Geometry2, typename Collection, typename Strategy>
26 void sym_difference(Geometry1 const & geometry1, Geometry2 const & geometry2, Collection & output_collection,
27                     Strategy const & strategy)``
28 
29 [heading Parameters]
30 
31 [table
32 [[Type] [Concept] [Name] [Description] ]
33 [[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
34 [[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
35 [[Collection &] [output collection, either a multi-geometry, or a std::vector<Geometry> / std::deque<Geometry> etc ] [output_collection] [the output collection ]]
36 [[Strategy const &] [Any type fulfilling a Sym_difference Strategy Concept ] [strategy] [The strategy which will be used for sym_difference calculations]]
37 ]
38 
39 
40 [heading Header]
41 Either
42 
43 `#include <boost/geometry.hpp>`
44 
45 
46 Or
47 
48 `#include <boost/geometry/algorithms/sym_difference.hpp>`
49 
50 [include reference/algorithms/sym_difference.qbk]
51 
52 
53 [endsect]
54 
55 [section:sym_difference_3 sym_difference]
56 
57 '''<indexterm><primary>sym_difference</primary></indexterm>'''
58 Calculate the symmetric difference of two geometries.
59 
60 [heading Description]
61 The free function symmetric difference calculates the spatial set theoretic symmetric difference (XOR) of two geometries.
62 
63 [heading Synopsis]
64 ``template<typename Geometry1, typename Geometry2, typename Collection>
65 void sym_difference(Geometry1 const & geometry1, Geometry2 const & geometry2, Collection & output_collection)``
66 
67 [heading Parameters]
68 
69 [table
70 [[Type] [Concept] [Name] [Description] ]
71 [[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
72 [[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
73 [[Collection &] [output collection, either a multi-geometry, or a std::vector<Geometry> / std::deque<Geometry> etc ] [output_collection] [the output collection]]
74 ]
75 
76 
77 [heading Header]
78 Either
79 
80 `#include <boost/geometry.hpp>`
81 
82 
83 Or
84 
85 `#include <boost/geometry/algorithms/sym_difference.hpp>`
86 
87 [include reference/algorithms/sym_difference.qbk]
88 
89 
90 [endsect]
91 
92