3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>covered_by</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.html" title="covered_by">
10 <link rel="next" href="covered_by_3_with_strategy.html" title="covered_by (with strategy)">
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.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="covered_by_3_with_strategy.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_2"></a><a class="link" href="covered_by_2.html" title="covered_by">covered_by</a>
28 </h5></div></div></div>
30 <a class="indexterm" name="idm46716147747424"></a>
31 Checks if the first geometry is inside or on border the second geometry.
34 <a name="geometry.reference.algorithms.covered_by.covered_by_2.h0"></a>
35 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_2.description"></a></span><a class="link" href="covered_by_2.html#geometry.reference.algorithms.covered_by.covered_by_2.description">Description</a>
38 The free function covered_by checks if the first geometry is inside or
39 on border the second geometry.
42 <a name="geometry.reference.algorithms.covered_by.covered_by_2.h1"></a>
43 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_2.synopsis"></a></span><a class="link" href="covered_by_2.html#geometry.reference.algorithms.covered_by.covered_by_2.synopsis">Synopsis</a>
47 <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>
48 <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></pre>
52 <a name="geometry.reference.algorithms.covered_by.covered_by_2.h2"></a>
53 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_2.parameters"></a></span><a class="link" href="covered_by_2.html#geometry.reference.algorithms.covered_by.covered_by_2.parameters">Parameters</a>
55 <div class="informaltable"><table class="table">
93 Any type fulfilling a Geometry Concept
103 A model of the specified concept which might be inside or on
104 the border of the second geometry
111 Geometry2 const &
116 Any type fulfilling a Geometry Concept
126 A model of the specified concept which might cover the first
134 <a name="geometry.reference.algorithms.covered_by.covered_by_2.h3"></a>
135 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_2.returns"></a></span><a class="link" href="covered_by_2.html#geometry.reference.algorithms.covered_by.covered_by_2.returns">Returns</a>
138 true if geometry1 is inside of or on the border of geometry2, else false
141 <a name="geometry.reference.algorithms.covered_by.covered_by_2.h4"></a>
142 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_2.header"></a></span><a class="link" href="covered_by_2.html#geometry.reference.algorithms.covered_by.covered_by_2.header">Header</a>
148 <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>
154 <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>
157 <a name="geometry.reference.algorithms.covered_by.covered_by_2.h5"></a>
158 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_2.conformance"></a></span><a class="link" href="covered_by_2.html#geometry.reference.algorithms.covered_by.covered_by_2.conformance">Conformance</a>
161 The function covered_by is not defined by OGC.
163 <div class="note"><table border="0" summary="Note">
165 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
166 <th align="left">Note</th>
168 <tr><td align="left" valign="top"><p>
169 Both PostGIS and Oracle contain an algorithm with the same name and
170 the same functionality. See the <a href="http://www.postgis.org/docs/ST_CoveredBy.html" target="_top">PostGIS
175 <a name="geometry.reference.algorithms.covered_by.covered_by_2.h6"></a>
176 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_2.supported_geometries"></a></span><a class="link" href="covered_by_2.html#geometry.reference.algorithms.covered_by.covered_by_2.supported_geometries">Supported
179 <div class="informaltable"><table class="table">
256 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
261 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
266 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
271 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
276 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
281 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
286 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
291 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
296 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
301 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
313 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
318 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
323 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
328 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
333 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
338 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
343 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
348 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
353 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
358 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
370 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
375 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
380 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
385 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
390 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
395 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
400 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
405 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
410 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
415 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
427 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
432 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
437 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
442 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
447 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
452 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
457 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
462 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
467 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
472 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
484 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
489 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
494 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
499 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
504 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
509 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
514 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
519 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
524 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
529 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
541 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
546 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
551 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
556 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
561 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
566 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
571 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
576 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
581 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
586 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
598 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
603 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
608 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
613 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
618 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
623 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
628 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
633 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
638 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
643 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
655 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
660 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
665 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
670 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
675 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
680 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
685 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
690 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
695 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
700 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
712 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
717 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
722 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
727 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
732 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
737 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
742 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
747 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
752 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
757 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
769 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
774 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
779 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
784 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
789 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
794 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
799 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
804 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
809 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
814 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
820 <div class="note"><table border="0" summary="Note">
822 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
823 <th align="left">Note</th>
825 <tr><td align="left" valign="top"><p>
826 In this status matrix above: columns are types of first parameter and
827 rows are types of second parameter. So a point can be checked to be
828 covered by a polygon, but not vice versa.
832 <a name="geometry.reference.algorithms.covered_by.covered_by_2.h7"></a>
833 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_2.complexity"></a></span><a class="link" href="covered_by_2.html#geometry.reference.algorithms.covered_by.covered_by_2.complexity">Complexity</a>
839 <a name="geometry.reference.algorithms.covered_by.covered_by_2.h8"></a>
840 <span class="phrase"><a name="geometry.reference.algorithms.covered_by.covered_by_2.see_also"></a></span><a class="link" href="covered_by_2.html#geometry.reference.algorithms.covered_by.covered_by_2.see_also">See
843 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
844 <a class="link" href="../within.html" title="within">within</a>
846 <div class="note"><table border="0" summary="Note">
848 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
849 <th align="left">Note</th>
851 <tr><td align="left" valign="top"><p>
852 The difference with the <code class="computeroutput"><span class="identifier">within</span></code>
853 algorithm is that this algorithm checks the border by default
857 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
858 <td align="left"></td>
859 <td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
860 Wulkiewicz, Oracle and/or its affiliates<p>
861 Distributed under the Boost Software License, Version 1.0. (See accompanying
862 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>)
867 <div class="spirit-nav">
868 <a accesskey="p" href="../covered_by.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="covered_by_3_with_strategy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>