3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>covered_by (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 1. Geometry">
8 <link rel="up" href="../covered_by.html" title="covered_by">
9 <link rel="prev" href="covered_by_2.html" title="covered_by">
10 <link rel="next" href="../crosses.html" title="crosses">
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>
22 <div class="spirit-nav">
23 <a accesskey="p" href="covered_by_2.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../covered_by.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="../crosses.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="titlepage"><div><div><h5 class="title">
27 <a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy"></a><a class="link" href="covered_by_3_with_strategy.html" title="covered_by (with strategy)">covered_by
29 </h5></div></div></div>
31 <a class="indexterm" name="idm46187005039904"></a>
32 Checks if the first geometry is inside or on border the second geometry
33 using the specified strategy.
36 <a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.h0"></a>
37 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.description"></a></span><a class="link" href="covered_by_3_with_strategy.html#geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.description">Description</a>
40 The free function covered_by checks if the first geometry is inside or
41 on border the second geometry, using the specified strategy. Reasons
42 to specify a strategy include: use another coordinate system for calculations;
43 construct the strategy beforehand (e.g. with the radius of the Earth);
44 select a strategy when there are more than one available for a calculation.
47 <a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.h1"></a>
48 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.synopsis"></a></span><a class="link" href="covered_by_3_with_strategy.html#geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.synopsis">Synopsis</a>
52 <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> <span class="keyword">typename</span> <span class="identifier">Strategy</span><span class="special">></span>
53 <span class="keyword">bool</span> <span class="identifier">covered_by</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> <span class="identifier">Strategy</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">strategy</span><span class="special">)</span></pre>
57 <a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.h2"></a>
58 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.parameters"></a></span><a class="link" href="covered_by_3_with_strategy.html#geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.parameters">Parameters</a>
60 <div class="informaltable"><table class="table">
98 Any type fulfilling a Geometry Concept
108 A model of the specified concept which might be inside or on
109 the border of the second geometry
116 Geometry2 const &
121 Any type fulfilling a Geometry Concept
131 A model of the specified concept which might cover the first
158 <a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.h3"></a>
159 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.returns"></a></span><a class="link" href="covered_by_3_with_strategy.html#geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.returns">Returns</a>
162 true if geometry1 is inside of or on the border of geometry2, else false
165 <a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.h4"></a>
166 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.header"></a></span><a class="link" href="covered_by_3_with_strategy.html#geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.header">Header</a>
172 <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>
178 <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">covered_by</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
181 <a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.h5"></a>
182 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.conformance"></a></span><a class="link" href="covered_by_3_with_strategy.html#geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.conformance">Conformance</a>
185 The function covered_by is not defined by OGC.
187 <div class="note"><table border="0" summary="Note">
189 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
190 <th align="left">Note</th>
192 <tr><td align="left" valign="top"><p>
193 Both PostGIS and Oracle contain an algorithm with the same name and
194 the same functionality. See the <a href="http://www.postgis.org/docs/ST_CoveredBy.html" target="_top">PostGIS
199 <a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.h6"></a>
200 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.supported_geometries"></a></span><a class="link" href="covered_by_3_with_strategy.html#geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.supported_geometries">Supported
203 <div class="informaltable"><table class="table">
280 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
285 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
290 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
295 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
300 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
305 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
310 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
315 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
320 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
325 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
337 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
342 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
347 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
352 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
357 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
362 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
367 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
372 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
377 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
382 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
394 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
399 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
404 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
409 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
414 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
419 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
424 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
429 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
434 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
439 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
451 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
456 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
461 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
466 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
471 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
476 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
481 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
486 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
491 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
496 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
508 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
513 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
518 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
523 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
528 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
533 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
538 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
543 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
548 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
553 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
565 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
570 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
575 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
580 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
585 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
590 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
595 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
600 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
605 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
610 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
622 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
627 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
632 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
637 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
642 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
647 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
652 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
657 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
662 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
667 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
679 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
684 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
689 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
694 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
699 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
704 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
709 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
714 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
719 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
724 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
736 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
741 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
746 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
751 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
756 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
761 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
766 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
771 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
776 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
781 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
793 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
798 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
803 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
808 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
813 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
818 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
823 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
828 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
833 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
838 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
844 <div class="note"><table border="0" summary="Note">
846 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
847 <th align="left">Note</th>
849 <tr><td align="left" valign="top"><p>
850 In this status matrix above: columns are types of first parameter and
851 rows are types of second parameter. So a point can be checked to be
852 covered by a polygon, but not vice versa.
856 <a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.h7"></a>
857 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.complexity"></a></span><a class="link" href="covered_by_3_with_strategy.html#geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.complexity">Complexity</a>
863 <a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.h8"></a>
864 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.see_also"></a></span><a class="link" href="covered_by_3_with_strategy.html#geometry.reference.algorithms.covered_by.covered_by_3_with_strategy.see_also">See
867 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
868 <a class="link" href="../within.html" title="within">within</a>
870 <div class="note"><table border="0" summary="Note">
872 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
873 <th align="left">Note</th>
875 <tr><td align="left" valign="top"><p>
876 The difference with the <code class="computeroutput"><span class="identifier">within</span></code>
877 algorithm is that this algorithm checks the border by default
881 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
882 <td align="left"></td>
883 <td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
884 Wulkiewicz, Oracle and/or its affiliates<p>
885 Distributed under the Boost Software License, Version 1.0. (See accompanying
886 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>)
891 <div class="spirit-nav">
892 <a accesskey="p" href="covered_by_2.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../covered_by.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="../crosses.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>