• 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__relation.xml]
16[section:relation_3_with_strategy relation (with strategy)]
17
18'''<indexterm><primary>relation</primary></indexterm>'''
19Calculates the relation between a pair of geometries as defined in DE-9IM.
20
21[heading Synopsis]
22``template<typename Geometry1, typename Geometry2, typename Strategy>
23de9im::matrix relation(Geometry1 const & geometry1, Geometry2 const & geometry2, Strategy const & strategy)``
24
25[heading Parameters]
26
27[table
28[[Type] [Concept] [Name] [Description] ]
29[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
30[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
31[[Strategy const &] [Any type fulfilling a Relation Strategy Concept ] [strategy] [The strategy which will be used for relation calculations ]]
32]
33
34
35[heading Returns]
36The DE-9IM matrix expressing the relation between geometries.
37
38[heading Header]
39Either
40
41`#include <boost/geometry.hpp>`
42
43
44Or
45
46`#include <boost/geometry/algorithms/relation.hpp>`
47
48[include reference/algorithms/relation.qbk]
49
50
51[endsect]
52
53[section:relation_2 relation]
54
55'''<indexterm><primary>relation</primary></indexterm>'''
56Calculates the relation between a pair of geometries as defined in DE-9IM.
57
58[heading Synopsis]
59``template<typename Geometry1, typename Geometry2>
60de9im::matrix relation(Geometry1 const & geometry1, Geometry2 const & geometry2)``
61
62[heading Parameters]
63
64[table
65[[Type] [Concept] [Name] [Description] ]
66[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
67[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
68]
69
70
71[heading Returns]
72The DE-9IM matrix expressing the relation between geometries.
73
74[heading Header]
75Either
76
77`#include <boost/geometry.hpp>`
78
79
80Or
81
82`#include <boost/geometry/algorithms/relation.hpp>`
83
84[include reference/algorithms/relation.qbk]
85
86
87[endsect]
88
89