• 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__intersection.xml]
16[section:intersection_4_with_strategy intersection (with strategy)]
17
18'''<indexterm><primary>intersection</primary></indexterm>'''
19Calculate the intersection of two geometries.
20
21[heading Description]
22The free function intersection calculates the spatial set theoretic intersection of two geometries.
23
24[heading Synopsis]
25``template<typename Geometry1, typename Geometry2, typename GeometryOut, typename Strategy>
26bool intersection(Geometry1 const & geometry1, Geometry2 const & geometry2, GeometryOut & geometry_out,
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[[GeometryOut &] [Collection of geometries (e.g. std::vector, std::deque, boost::geometry::multi*) of which the value_type fulfills a Point, LineString or Polygon concept, or it is the output geometry (e.g. for a box) ] [geometry_out] [The output geometry, either a multi_point, multi_polygon, multi_linestring, or a box (for intersection of two boxes) ]]
36[[Strategy const &] [Any type fulfilling a Intersection Strategy Concept ] [strategy] [The strategy which will be used for intersection calculations]]
37]
38
39
40[heading Header]
41Either
42
43`#include <boost/geometry.hpp>`
44
45
46Or
47
48`#include <boost/geometry/algorithms/intersection.hpp>`
49
50[include reference/algorithms/intersection.qbk]
51
52
53[endsect]
54
55[section:intersection_3 intersection]
56
57'''<indexterm><primary>intersection</primary></indexterm>'''
58Calculate the intersection of two geometries.
59
60[heading Description]
61The free function intersection calculates the spatial set theoretic intersection of two geometries.
62
63[heading Synopsis]
64``template<typename Geometry1, typename Geometry2, typename GeometryOut>
65bool intersection(Geometry1 const & geometry1, Geometry2 const & geometry2, GeometryOut & geometry_out)``
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[[GeometryOut &] [Collection of geometries (e.g. std::vector, std::deque, boost::geometry::multi*) of which the value_type fulfills a Point, LineString or Polygon concept, or it is the output geometry (e.g. for a box) ] [geometry_out] [The output geometry, either a multi_point, multi_polygon, multi_linestring, or a box (for intersection of two boxes)]]
74]
75
76
77[heading Header]
78Either
79
80`#include <boost/geometry.hpp>`
81
82
83Or
84
85`#include <boost/geometry/algorithms/intersection.hpp>`
86
87[include reference/algorithms/intersection.qbk]
88
89
90[endsect]
91
92