libs/geometry/doc/html/geometry/reference/algorithms/relate/relate_4_with_strategy.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>relate (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="../relate.html" title="relate">
   9 <link rel="prev" href="../relate.html" title="relate">
  10 <link rel="next" href="relate_3.html" title="relate">
  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="../relate.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../relate.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="relate_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.relate.relate_4_with_strategy"></a><a class="link" href="relate_4_with_strategy.html" title="relate (with strategy)">relate
  28           (with strategy)</a>
  29 </h5></div></div></div>
  30 <p>
  31             <a class="indexterm" name="idp103333600"></a>
  32 Checks relation between a pair of geometries defined by a mask.
  33           </p>
  34 <h6>
  35 <a name="geometry.reference.algorithms.relate.relate_4_with_strategy.h0"></a>
  36             <span class="phrase"><a name="geometry.reference.algorithms.relate.relate_4_with_strategy.synopsis"></a></span><a class="link" href="relate_4_with_strategy.html#geometry.reference.algorithms.relate.relate_4_with_strategy.synopsis">Synopsis</a>
  37           </h6>
  38 <p>
  39 </p>
  40 <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">Mask</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Strategy</span><span class="special">&gt;</span>
  41 <span class="keyword">bool</span> <span class="identifier">relate</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">Mask</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">mask</span><span class="special">,</span>
  42             <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>
  43 <p>
  44           </p>
  45 <h6>
  46 <a name="geometry.reference.algorithms.relate.relate_4_with_strategy.h1"></a>
  47             <span class="phrase"><a name="geometry.reference.algorithms.relate.relate_4_with_strategy.parameters"></a></span><a class="link" href="relate_4_with_strategy.html#geometry.reference.algorithms.relate.relate_4_with_strategy.parameters">Parameters</a>
  48           </h6>
  49 <div class="informaltable"><table class="table">
  50 <colgroup>
  51 <col>
  52 <col>
  53 <col>
  54 <col>
  55 </colgroup>
  56 <thead><tr>
  57 <th>
  58                     <p>
  59                       Type
  60                     </p>
  61                   </th>
  62 <th>
  63                     <p>
  64                       Concept
  65                     </p>
  66                   </th>
  67 <th>
  68                     <p>
  69                       Name
  70                     </p>
  71                   </th>
  72 <th>
  73                     <p>
  74                       Description
  75                     </p>
  76                   </th>
  77 </tr></thead>
  78 <tbody>
  79 <tr>
  80 <td>
  81                     <p>
  82                       Geometry1 const &amp;
  83                     </p>
  84                   </td>
  85 <td>
  86                     <p>
  87                       Any type fulfilling a Geometry Concept
  88                     </p>
  89                   </td>
  90 <td>
  91                     <p>
  92                       geometry1
  93                     </p>
  94                   </td>
  95 <td>
  96                     <p>
  97                       A model of the specified concept
  98                     </p>
  99                   </td>
 100 </tr>
 101 <tr>
 102 <td>
 103                     <p>
 104                       Geometry2 const &amp;
 105                     </p>
 106                   </td>
 107 <td>
 108                     <p>
 109                       Any type fulfilling a Geometry Concept
 110                     </p>
 111                   </td>
 112 <td>
 113                     <p>
 114                       geometry2
 115                     </p>
 116                   </td>
 117 <td>
 118                     <p>
 119                       A model of the specified concept
 120                     </p>
 121                   </td>
 122 </tr>
 123 <tr>
 124 <td>
 125                     <p>
 126                       Mask const &amp;
 127                     </p>
 128                   </td>
 129 <td>
 130                     <p>
 131                       An intersection model Mask type.
 132                     </p>
 133                   </td>
 134 <td>
 135                     <p>
 136                       mask
 137                     </p>
 138                   </td>
 139 <td>
 140                     <p>
 141                       An intersection model mask object.
 142                     </p>
 143                   </td>
 144 </tr>
 145 <tr>
 146 <td>
 147                     <p>
 148                       Strategy const &amp;
 149                     </p>
 150                   </td>
 151 <td>
 152                     <p>
 153                       Any type fulfilling a Relate Strategy Concept
 154                     </p>
 155                   </td>
 156 <td>
 157                     <p>
 158                       strategy
 159                     </p>
 160                   </td>
 161 <td>
 162                     <p>
 163                       The strategy which will be used for relate calculations
 164                     </p>
 165                   </td>
 166 </tr>
 167 </tbody>
 168 </table></div>
 169 <h6>
 170 <a name="geometry.reference.algorithms.relate.relate_4_with_strategy.h2"></a>
 171             <span class="phrase"><a name="geometry.reference.algorithms.relate.relate_4_with_strategy.returns"></a></span><a class="link" href="relate_4_with_strategy.html#geometry.reference.algorithms.relate.relate_4_with_strategy.returns">Returns</a>
 172           </h6>
 173 <p>
 174             true if the relation is compatible with the mask, false otherwise.
 175           </p>
 176 <h6>
 177 <a name="geometry.reference.algorithms.relate.relate_4_with_strategy.h3"></a>
 178             <span class="phrase"><a name="geometry.reference.algorithms.relate.relate_4_with_strategy.header"></a></span><a class="link" href="relate_4_with_strategy.html#geometry.reference.algorithms.relate.relate_4_with_strategy.header">Header</a>
 179           </h6>
 180 <p>
 181             Either
 182           </p>
 183 <p>
 184             <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>
 185           </p>
 186 <p>
 187             Or
 188           </p>
 189 <p>
 190             <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">relate</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 191           </p>
 192 <h6>
 193 <a name="geometry.reference.algorithms.relate.relate_4_with_strategy.h4"></a>
 194             <span class="phrase"><a name="geometry.reference.algorithms.relate.relate_4_with_strategy.conformance"></a></span><a class="link" href="relate_4_with_strategy.html#geometry.reference.algorithms.relate.relate_4_with_strategy.conformance">Conformance</a>
 195           </h6>
 196 <p>
 197             The function relate implements function Relate from the <a href="http://www.opengeospatial.org/standards/sfa" target="_top">OGC
 198             Simple Feature Specification</a>.
 199           </p>
 200 <h6>
 201 <a name="geometry.reference.algorithms.relate.relate_4_with_strategy.h5"></a>
 202             <span class="phrase"><a name="geometry.reference.algorithms.relate.relate_4_with_strategy.example"></a></span><a class="link" href="relate_4_with_strategy.html#geometry.reference.algorithms.relate.relate_4_with_strategy.example">Example</a>
 203           </h6>
 204 <p>
 205             Shows how to detect if a point is inside a polygon, or not
 206           </p>
 207 <p>
 208 </p>
 209 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
 210
 211 <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>
 212 <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>
 213 <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>
 214
 215
 216 <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
 217 <span class="special">{</span>
 218     <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">&lt;</span><span class="keyword">double</span><span class="special">&gt;</span> <span class="identifier">point_type</span><span class="special">;</span>
 219     <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">point_type</span><span class="special">&gt;</span> <span class="identifier">polygon_type</span><span class="special">;</span>
 220
 221     <span class="identifier">polygon_type</span> <span class="identifier">poly</span><span class="special">;</span>
 222     <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>
 223         <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>
 224             <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>
 225
 226     <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>
 227
 228     <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">mask</span> <span class="identifier">mask</span><span class="special">(</span><span class="string">"T*F**F***"</span><span class="special">);</span> <span class="comment">// within</span>
 229     <span class="keyword">bool</span> <span class="identifier">check</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">relate</span><span class="special">(</span><span class="identifier">p</span><span class="special">,</span> <span class="identifier">poly</span><span class="special">,</span> <span class="identifier">mask</span><span class="special">);</span>
 230
 231     <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"relate: "</span> <span class="special">&lt;&lt;</span> <span class="special">(</span><span class="identifier">check</span> <span class="special">?</span> <span class="string">"yes"</span> <span class="special">:</span> <span class="string">"no"</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>
 232
 233     <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
 234 <span class="special">}</span>
 235 </pre>
 236 <p>
 237           </p>
 238 <p>
 239             Output:
 240           </p>
 241 <pre class="programlisting">relate: yes
 242
 243 <img src="../../../../img/algorithms/within.png" alt="within">
 244 </pre>
 245 <h6>
 246 <a name="geometry.reference.algorithms.relate.relate_4_with_strategy.h6"></a>
 247             <span class="phrase"><a name="geometry.reference.algorithms.relate.relate_4_with_strategy.see_also"></a></span><a class="link" href="relate_4_with_strategy.html#geometry.reference.algorithms.relate.relate_4_with_strategy.see_also">See
 248             also</a>
 249           </h6>
 250 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 251 <li class="listitem">
 252                 <a class="link" href="../../de9im/de9im_mask.html" title="de9im::mask">de9im::mask</a>
 253               </li>
 254 <li class="listitem">
 255                 <a class="link" href="../../de9im/de9im_static_mask.html" title="de9im::static_mask">de9im::static_mask</a>
 256               </li>
 257 <li class="listitem">
 258                 <a class="link" href="../relation.html" title="relation">relation</a>
 259               </li>
 260 </ul></div>
 261 </div>
 262 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 263 <td align="left"></td>
 264 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2017 Barend
 265       Gehrels, Bruno Lalande, Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its
 266       affiliates<p>
 267         Distributed under the Boost Software License, Version 1.0. (See accompanying
 268         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>)
 269       </p>
 270 </div></td>
 271 </tr></table>
 272 <hr>
 273 <div class="spirit-nav">
 274 <a accesskey="p" href="../relate.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../relate.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="relate_3.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 275 </div>
 276 </body>
 277 </html>