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.76.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="id853942"></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><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><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><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><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><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">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><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><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">
250 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
255 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
260 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
265 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
270 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
275 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
280 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></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>
302 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
307 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
312 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
317 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
322 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
327 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
332 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
337 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
342 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
354 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
359 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
364 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
369 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
374 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
379 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
384 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
389 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
394 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
406 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
411 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
416 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
421 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
426 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
431 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
436 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
441 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
446 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
458 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
463 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
468 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
473 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
478 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
483 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
488 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
493 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
498 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
510 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
515 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
520 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
525 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
530 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
535 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
540 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
545 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
550 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
562 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
567 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
572 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
577 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
582 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
587 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
592 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
597 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
602 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
614 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
619 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
624 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
629 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
634 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
639 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
644 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
649 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
654 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
666 <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
671 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
676 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
681 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
686 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
691 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
696 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
701 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
706 <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
712 <div class="note"><table border="0" summary="Note">
714 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
715 <th align="left">Note</th>
717 <tr><td align="left" valign="top"><p>
718 In this status matrix above: columns are types of first parameter and
719 rows are types of second parameter. So a point can be checked to be
720 covered by a polygon, but not vice versa.
724 <a name="geometry.reference.algorithms.covered_by.covered_by_2.h7"></a>
725 <span><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>
731 <a name="geometry.reference.algorithms.covered_by.covered_by_2.h8"></a>
732 <span><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
735 <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
736 <a class="link" href="../within.html" title="within">within</a>
738 <div class="note"><table border="0" summary="Note">
740 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
741 <th align="left">Note</th>
743 <tr><td align="left" valign="top"><p>
744 The difference with the <code class="computeroutput"><span class="identifier">within</span></code>
745 algorithm is that this algorithm checks the border by default
749 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
750 <td align="left"></td>
751 <td align="right"><div class="copyright-footer">Copyright © 2009-2012 Barend
752 Gehrels, Bruno Lalande, Mateusz Loskot<p>
753 Distributed under the Boost Software License, Version 1.0. (See accompanying
754 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>)
759 <div class="spirit-nav">
760 <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>