• 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__difference.xml]
16[section:difference_4_with_strategy difference (with strategy)]
17
18'''<indexterm><primary>difference</primary></indexterm>'''
19
20
21[heading Description]
22Calculate the difference of two geometries
23
24The free function difference calculates the spatial set theoretic difference of two geometries.
25
26[heading Synopsis]
27``template<typename Geometry1, typename Geometry2, typename Collection, typename Strategy>
28void difference(Geometry1 const & geometry1, Geometry2 const & geometry2, Collection & output_collection,
29                Strategy const & strategy)``
30
31[heading Parameters]
32
33[table
34[[Type] [Concept] [Name] [Description] ]
35[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
36[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
37[[Collection &] [output collection, either a multi-geometry, or a std::vector<Geometry> / std::deque<Geometry> etc ] [output_collection] [the output collection ]]
38[[Strategy const &] [Any type fulfilling a Difference Strategy Concept ] [strategy] [The strategy which will be used for difference calculations]]
39]
40
41
42[heading Header]
43Either
44
45`#include <boost/geometry.hpp>`
46
47
48Or
49
50`#include <boost/geometry/algorithms/difference.hpp>`
51
52[include reference/algorithms/difference.qbk]
53
54
55[endsect]
56
57[section:difference_3 difference]
58
59'''<indexterm><primary>difference</primary></indexterm>'''
60
61
62[heading Description]
63Calculate the difference of two geometries
64
65The free function difference calculates the spatial set theoretic difference of two geometries.
66
67[heading Synopsis]
68``template<typename Geometry1, typename Geometry2, typename Collection>
69void difference(Geometry1 const & geometry1, Geometry2 const & geometry2, Collection & output_collection)``
70
71[heading Parameters]
72
73[table
74[[Type] [Concept] [Name] [Description] ]
75[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
76[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
77[[Collection &] [output collection, either a multi-geometry, or a std::vector<Geometry> / std::deque<Geometry> etc ] [output_collection] [the output collection]]
78]
79
80
81[heading Header]
82Either
83
84`#include <boost/geometry.hpp>`
85
86
87Or
88
89`#include <boost/geometry/algorithms/difference.hpp>`
90
91[include reference/algorithms/difference.qbk]
92
93
94[endsect]
95
96