libs/geometry/doc/html/geometry/reference/algorithms/intersection/intersection_4_with_strategy.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>intersection (with strategy)</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&#160;1.&#160;Geometry">
   8 <link rel="up" href="../intersection.html" title="intersection">
   9 <link rel="prev" href="../intersection.html" title="intersection">
  10 <link rel="next" href="intersection_3.html" title="intersection">
  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="../intersection.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../intersection.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="intersection_3.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.intersection.intersection_4_with_strategy"></a><a class="link" href="intersection_4_with_strategy.html" title="intersection (with strategy)">intersection
  28           (with strategy)</a>
  29 </h5></div></div></div>
  30 <p>
  31             <a class="indexterm" name="idm46186998118528"></a>
  32 Calculate the intersection of two geometries.
  33           </p>
  34 <h6>
  35 <a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.h0"></a>
  36             <span class="phrase"><a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.description"></a></span><a class="link" href="intersection_4_with_strategy.html#geometry.reference.algorithms.intersection.intersection_4_with_strategy.description">Description</a>
  37           </h6>
  38 <p>
  39             The free function intersection calculates the spatial set theoretic intersection
  40             of two geometries.
  41           </p>
  42 <h6>
  43 <a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.h1"></a>
  44             <span class="phrase"><a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.synopsis"></a></span><a class="link" href="intersection_4_with_strategy.html#geometry.reference.algorithms.intersection.intersection_4_with_strategy.synopsis">Synopsis</a>
  45           </h6>
  46 <p>
  47 </p>
  48 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</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> <span class="keyword">typename</span> <span class="identifier">GeometryOut</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Strategy</span><span class="special">&gt;</span>
  49 <span class="keyword">bool</span> <span class="identifier">intersection</span><span class="special">(</span><span class="identifier">Geometry1</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">geometry1</span><span class="special">,</span> <span class="identifier">Geometry2</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">geometry2</span><span class="special">,</span> <span class="identifier">GeometryOut</span> <span class="special">&amp;</span> <span class="identifier">geometry_out</span><span class="special">,</span>
  50                   <span class="identifier">Strategy</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">strategy</span><span class="special">)</span></pre>
  51 <p>
  52           </p>
  53 <h6>
  54 <a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.h2"></a>
  55             <span class="phrase"><a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.parameters"></a></span><a class="link" href="intersection_4_with_strategy.html#geometry.reference.algorithms.intersection.intersection_4_with_strategy.parameters">Parameters</a>
  56           </h6>
  57 <div class="informaltable"><table class="table">
  58 <colgroup>
  59 <col>
  60 <col>
  61 <col>
  62 <col>
  63 </colgroup>
  64 <thead><tr>
  65 <th>
  66                     <p>
  67                       Type
  68                     </p>
  69                   </th>
  70 <th>
  71                     <p>
  72                       Concept
  73                     </p>
  74                   </th>
  75 <th>
  76                     <p>
  77                       Name
  78                     </p>
  79                   </th>
  80 <th>
  81                     <p>
  82                       Description
  83                     </p>
  84                   </th>
  85 </tr></thead>
  86 <tbody>
  87 <tr>
  88 <td>
  89                     <p>
  90                       Geometry1 const &amp;
  91                     </p>
  92                   </td>
  93 <td>
  94                     <p>
  95                       Any type fulfilling a Geometry Concept
  96                     </p>
  97                   </td>
  98 <td>
  99                     <p>
 100                       geometry1
 101                     </p>
 102                   </td>
 103 <td>
 104                     <p>
 105                       A model of the specified concept
 106                     </p>
 107                   </td>
 108 </tr>
 109 <tr>
 110 <td>
 111                     <p>
 112                       Geometry2 const &amp;
 113                     </p>
 114                   </td>
 115 <td>
 116                     <p>
 117                       Any type fulfilling a Geometry Concept
 118                     </p>
 119                   </td>
 120 <td>
 121                     <p>
 122                       geometry2
 123                     </p>
 124                   </td>
 125 <td>
 126                     <p>
 127                       A model of the specified concept
 128                     </p>
 129                   </td>
 130 </tr>
 131 <tr>
 132 <td>
 133                     <p>
 134                       GeometryOut &amp;
 135                     </p>
 136                   </td>
 137 <td>
 138                     <p>
 139                       Collection of geometries (e.g. std::vector, std::deque, boost::geometry::multi*)
 140                       of which the value_type fulfills a Point, LineString or Polygon
 141                       concept, or it is the output geometry (e.g. for a box)
 142                     </p>
 143                   </td>
 144 <td>
 145                     <p>
 146                       geometry_out
 147                     </p>
 148                   </td>
 149 <td>
 150                     <p>
 151                       The output geometry, either a multi_point, multi_polygon, multi_linestring,
 152                       or a box (for intersection of two boxes)
 153                     </p>
 154                   </td>
 155 </tr>
 156 <tr>
 157 <td>
 158                     <p>
 159                       Strategy const &amp;
 160                     </p>
 161                   </td>
 162 <td>
 163                     <p>
 164                       Any type fulfilling a Intersection Strategy Concept
 165                     </p>
 166                   </td>
 167 <td>
 168                     <p>
 169                       strategy
 170                     </p>
 171                   </td>
 172 <td>
 173                     <p>
 174                       The strategy which will be used for intersection calculations
 175                     </p>
 176                   </td>
 177 </tr>
 178 </tbody>
 179 </table></div>
 180 <h6>
 181 <a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.h3"></a>
 182             <span class="phrase"><a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.header"></a></span><a class="link" href="intersection_4_with_strategy.html#geometry.reference.algorithms.intersection.intersection_4_with_strategy.header">Header</a>
 183           </h6>
 184 <p>
 185             Either
 186           </p>
 187 <p>
 188             <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</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">&gt;</span></code>
 189           </p>
 190 <p>
 191             Or
 192           </p>
 193 <p>
 194             <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</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">intersection</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 195           </p>
 196 <h6>
 197 <a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.h4"></a>
 198             <span class="phrase"><a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.conformance"></a></span><a class="link" href="intersection_4_with_strategy.html#geometry.reference.algorithms.intersection.intersection_4_with_strategy.conformance">Conformance</a>
 199           </h6>
 200 <p>
 201             The function intersection implements function Intersection from the
 202             <a href="http://www.opengeospatial.org/standards/sfa" target="_top">OGC Simple Feature
 203             Specification</a>.
 204           </p>
 205 <h6>
 206 <a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.h5"></a>
 207             <span class="phrase"><a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.behavior"></a></span><a class="link" href="intersection_4_with_strategy.html#geometry.reference.algorithms.intersection.intersection_4_with_strategy.behavior">Behavior</a>
 208           </h6>
 209 <div class="informaltable"><table class="table">
 210 <colgroup>
 211 <col>
 212 <col>
 213 </colgroup>
 214 <thead><tr>
 215 <th>
 216                     <p>
 217                       Case
 218                     </p>
 219                   </th>
 220 <th>
 221                     <p>
 222                       Behavior
 223                     </p>
 224                   </th>
 225 </tr></thead>
 226 <tbody>
 227 <tr>
 228 <td>
 229                     <p>
 230                       GeometryOut is a Point
 231                     </p>
 232                   </td>
 233 <td>
 234                     <p>
 235                       Calculates intersection points of input geometries
 236                     </p>
 237                   </td>
 238 </tr>
 239 <tr>
 240 <td>
 241                     <p>
 242                       GeometryOut is a Linestring
 243                     </p>
 244                   </td>
 245 <td>
 246                     <p>
 247                       Calculates intersection linestrings of input (multi)linestrings
 248                     </p>
 249                   </td>
 250 </tr>
 251 <tr>
 252 <td>
 253                     <p>
 254                       GeometryOut is a Polygon
 255                     </p>
 256                   </td>
 257 <td>
 258                     <p>
 259                       Calculates intersection polygons of input (multi)polygons and/or
 260                       boxes
 261                     </p>
 262                   </td>
 263 </tr>
 264 </tbody>
 265 </table></div>
 266 <div class="note"><table border="0" summary="Note">
 267 <tr>
 268 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
 269 <th align="left">Note</th>
 270 </tr>
 271 <tr><td align="left" valign="top"><p>
 272               Check the <a class="link" href="../../concepts/concept_polygon.html" title="Polygon Concept">Polygon
 273               Concept</a> for the rules that polygon input for this algorithm
 274               should fulfill
 275             </p></td></tr>
 276 </table></div>
 277 <h6>
 278 <a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.h6"></a>
 279             <span class="phrase"><a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.example"></a></span><a class="link" href="intersection_4_with_strategy.html#geometry.reference.algorithms.intersection.intersection_4_with_strategy.example">Example</a>
 280           </h6>
 281 <p>
 282             Shows the intersection of two polygons
 283           </p>
 284 <p>
 285 </p>
 286 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
 287 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">deque</span><span class="special">&gt;</span>
 288
 289 <span class="preprocessor">#include</span> <span class="special">&lt;</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">&gt;</span>
 290 <span class="preprocessor">#include</span> <span class="special">&lt;</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">&gt;</span>
 291 <span class="preprocessor">#include</span> <span class="special">&lt;</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">&gt;</span>
 292
 293 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">foreach</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 294
 295
 296 <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
 297 <span class="special">{</span>
 298     <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">&lt;</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">&lt;</span><span class="keyword">double</span><span class="special">&gt;</span> <span class="special">&gt;</span> <span class="identifier">polygon</span><span class="special">;</span>
 299
 300     <span class="identifier">polygon</span> <span class="identifier">green</span><span class="special">,</span> <span class="identifier">blue</span><span class="special">;</span>
 301
 302     <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>
 303         <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>
 304             <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">green</span><span class="special">);</span>
 305
 306     <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>
 307         <span class="string">"POLYGON((4.0 -0.5 , 3.5 1.0 , 2.0 1.5 , 3.5 2.0 , 4.0 3.5 , 4.5 2.0 , 6.0 1.5 , 4.5 1.0 , 4.0 -0.5))"</span><span class="special">,</span> <span class="identifier">blue</span><span class="special">);</span>
 308
 309     <span class="identifier">std</span><span class="special">::</span><span class="identifier">deque</span><span class="special">&lt;</span><span class="identifier">polygon</span><span class="special">&gt;</span> <span class="identifier">output</span><span class="special">;</span>
 310     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">intersection</span><span class="special">(</span><span class="identifier">green</span><span class="special">,</span> <span class="identifier">blue</span><span class="special">,</span> <span class="identifier">output</span><span class="special">);</span>
 311
 312     <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span>
 313     <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"green &amp;&amp; blue:"</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
 314     <span class="identifier">BOOST_FOREACH</span><span class="special">(</span><span class="identifier">polygon</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">p</span><span class="special">,</span> <span class="identifier">output</span><span class="special">)</span>
 315     <span class="special">{</span>
 316         <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">i</span><span class="special">++</span> <span class="special">&lt;&lt;</span> <span class="string">": "</span> <span class="special">&lt;&lt;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">area</span><span class="special">(</span><span class="identifier">p</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
 317     <span class="special">}</span>
 318
 319
 320     <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
 321 <span class="special">}</span>
 322 </pre>
 323 <p>
 324           </p>
 325 <p>
 326             Output:
 327           </p>
 328 <pre class="programlisting">green &amp;&amp; blue:
 329 0: 2.50205
 330
 331 <img src="../../../../img/algorithms/intersection.png" alt="intersection">
 332
 333 </pre>
 334 <h6>
 335 <a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.h7"></a>
 336             <span class="phrase"><a name="geometry.reference.algorithms.intersection.intersection_4_with_strategy.see_also"></a></span><a class="link" href="intersection_4_with_strategy.html#geometry.reference.algorithms.intersection.intersection_4_with_strategy.see_also">See
 337             also</a>
 338           </h6>
 339 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 340 <li class="listitem">
 341                 <a class="link" href="../union_.html" title="union_">union</a>
 342               </li>
 343 <li class="listitem">
 344                 <a class="link" href="../difference.html" title="difference">difference</a>
 345               </li>
 346 <li class="listitem">
 347                 <a class="link" href="../sym_difference.html" title="sym_difference">sym_difference
 348                 (symmetric difference)</a>
 349               </li>
 350 </ul></div>
 351 </div>
 352 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 353 <td align="left"></td>
 354 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 355       Wulkiewicz, Oracle and/or its affiliates<p>
 356         Distributed under the Boost Software License, Version 1.0. (See accompanying
 357         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>)
 358       </p>
 359 </div></td>
 360 </tr></table>
 361 <hr>
 362 <div class="spirit-nav">
 363 <a accesskey="p" href="../intersection.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../intersection.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="intersection_3.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 364 </div>
 365 </body>
 366 </html>