1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>relation</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="../relation.html" title="relation"> 9<link rel="prev" href="relation_3_with_strategy.html" title="relation (with strategy)"> 10<link rel="next" href="../reverse.html" title="reverse"> 11</head> 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> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="relation_3_with_strategy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../relation.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="../reverse.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h5 class="title"> 27<a name="geometry.reference.algorithms.relation.relation_2"></a><a class="link" href="relation_2.html" title="relation">relation</a> 28</h5></div></div></div> 29<p> 30 <a class="indexterm" name="idm45635689622592"></a> 31Calculates the relation between a pair of geometries as defined in DE-9IM. 32 </p> 33<h6> 34<a name="geometry.reference.algorithms.relation.relation_2.h0"></a> 35 <span class="phrase"><a name="geometry.reference.algorithms.relation.relation_2.synopsis"></a></span><a class="link" href="relation_2.html#geometry.reference.algorithms.relation.relation_2.synopsis">Synopsis</a> 36 </h6> 37<p> 38</p> 39<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> 40<span class="identifier">de9im</span><span class="special">::</span><span class="identifier">matrix</span> <span class="identifier">relation</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></pre> 41<p> 42 </p> 43<h6> 44<a name="geometry.reference.algorithms.relation.relation_2.h1"></a> 45 <span class="phrase"><a name="geometry.reference.algorithms.relation.relation_2.parameters"></a></span><a class="link" href="relation_2.html#geometry.reference.algorithms.relation.relation_2.parameters">Parameters</a> 46 </h6> 47<div class="informaltable"><table class="table"> 48<colgroup> 49<col> 50<col> 51<col> 52<col> 53</colgroup> 54<thead><tr> 55<th> 56 <p> 57 Type 58 </p> 59 </th> 60<th> 61 <p> 62 Concept 63 </p> 64 </th> 65<th> 66 <p> 67 Name 68 </p> 69 </th> 70<th> 71 <p> 72 Description 73 </p> 74 </th> 75</tr></thead> 76<tbody> 77<tr> 78<td> 79 <p> 80 Geometry1 const & 81 </p> 82 </td> 83<td> 84 <p> 85 Any type fulfilling a Geometry Concept 86 </p> 87 </td> 88<td> 89 <p> 90 geometry1 91 </p> 92 </td> 93<td> 94 <p> 95 A model of the specified concept 96 </p> 97 </td> 98</tr> 99<tr> 100<td> 101 <p> 102 Geometry2 const & 103 </p> 104 </td> 105<td> 106 <p> 107 Any type fulfilling a Geometry Concept 108 </p> 109 </td> 110<td> 111 <p> 112 geometry2 113 </p> 114 </td> 115<td> 116 <p> 117 A model of the specified concept 118 </p> 119 </td> 120</tr> 121</tbody> 122</table></div> 123<h6> 124<a name="geometry.reference.algorithms.relation.relation_2.h2"></a> 125 <span class="phrase"><a name="geometry.reference.algorithms.relation.relation_2.returns"></a></span><a class="link" href="relation_2.html#geometry.reference.algorithms.relation.relation_2.returns">Returns</a> 126 </h6> 127<p> 128 The DE-9IM matrix expressing the relation between geometries. 129 </p> 130<h6> 131<a name="geometry.reference.algorithms.relation.relation_2.h3"></a> 132 <span class="phrase"><a name="geometry.reference.algorithms.relation.relation_2.header"></a></span><a class="link" href="relation_2.html#geometry.reference.algorithms.relation.relation_2.header">Header</a> 133 </h6> 134<p> 135 Either 136 </p> 137<p> 138 <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> 139 </p> 140<p> 141 Or 142 </p> 143<p> 144 <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">relation</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> 145 </p> 146<h6> 147<a name="geometry.reference.algorithms.relation.relation_2.h4"></a> 148 <span class="phrase"><a name="geometry.reference.algorithms.relation.relation_2.conformance"></a></span><a class="link" href="relation_2.html#geometry.reference.algorithms.relation.relation_2.conformance">Conformance</a> 149 </h6> 150<p> 151 This function is additional and not described in the OGC standard. The 152 spatial relation is represented by DE-9IM matrix. 153 </p> 154<h6> 155<a name="geometry.reference.algorithms.relation.relation_2.h5"></a> 156 <span class="phrase"><a name="geometry.reference.algorithms.relation.relation_2.example"></a></span><a class="link" href="relation_2.html#geometry.reference.algorithms.relation.relation_2.example">Example</a> 157 </h6> 158<p> 159 Shows how to calculate the spatial relation between a point and a polygon 160 </p> 161<p> 162</p> 163<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> 164<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">string</span><span class="special">></span> 165 166<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> 167<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> 168<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> 169 170 171<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> 172<span class="special">{</span> 173 <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">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="identifier">point_type</span><span class="special">;</span> 174 <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">point_type</span><span class="special">></span> <span class="identifier">polygon_type</span><span class="special">;</span> 175 176 <span class="identifier">polygon_type</span> <span class="identifier">poly</span><span class="special">;</span> 177 <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> 178 <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> 179 <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">poly</span><span class="special">);</span> 180 181 <span class="identifier">point_type</span> <span class="identifier">p</span><span class="special">(</span><span class="number">4</span><span class="special">,</span> <span class="number">1</span><span class="special">);</span> 182 183 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">de9im</span><span class="special">::</span><span class="identifier">matrix</span> <span class="identifier">matrix</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">relation</span><span class="special">(</span><span class="identifier">p</span><span class="special">,</span> <span class="identifier">poly</span><span class="special">);</span> 184 <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">code</span> <span class="special">=</span> <span class="identifier">matrix</span><span class="special">.</span><span class="identifier">str</span><span class="special">();</span> 185 186 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"relation: "</span> <span class="special"><<</span> <span class="identifier">code</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> 187 188 <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> 189<span class="special">}</span> 190</pre> 191<p> 192 </p> 193<p> 194 Output: 195 </p> 196<pre class="programlisting">relation: 0FFFFF212 197 198<img src="../../../../img/algorithms/within.png" alt="within"> 199</pre> 200<h6> 201<a name="geometry.reference.algorithms.relation.relation_2.h6"></a> 202 <span class="phrase"><a name="geometry.reference.algorithms.relation.relation_2.see_also"></a></span><a class="link" href="relation_2.html#geometry.reference.algorithms.relation.relation_2.see_also">See 203 also</a> 204 </h6> 205<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 206<li class="listitem"> 207 <a class="link" href="../../de9im/de9im_matrix.html" title="de9im::matrix">de9im::matrix</a> 208 </li> 209<li class="listitem"> 210 <a class="link" href="../relate.html" title="relate">relate</a> 211 </li> 212</ul></div> 213</div> 214<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 215<td align="left"></td> 216<td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam 217 Wulkiewicz, Oracle and/or its affiliates<p> 218 Distributed under the Boost Software License, Version 1.0. (See accompanying 219 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>) 220 </p> 221</div></td> 222</tr></table> 223<hr> 224<div class="spirit-nav"> 225<a accesskey="p" href="relation_3_with_strategy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../relation.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="../reverse.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 226</div> 227</body> 228</html> 229
