3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>covered_by(Geometry const &)</title>
5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="../../../../index.html" title="Chapter 1. Geometry">
8 <link rel="up" href="../group__predicates.html" title="Predicates (boost::geometry::index::)">
9 <link rel="prev" href="contains_geometry_const___.html" title="contains(Geometry const &)">
10 <link rel="next" href="covers_geometry_const___.html" title="covers(Geometry const &)">
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="contains_geometry_const___.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../group__predicates.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="covers_geometry_const___.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.spatial_indexes.group__predicates.covered_by_geometry_const___"></a><a name="group__predicates_1ga67e42f17aad97c80f7c0b7a8c111cab4"></a><a class="link" href="covered_by_geometry_const___.html" title="covered_by(Geometry const &)">covered_by(Geometry
29 </h5></div></div></div>
31 <a class="indexterm" name="idp132272496"></a>
32 Generate <code class="literal"><a class="link" href="covered_by_geometry_const___.html#group__predicates_1ga67e42f17aad97c80f7c0b7a8c111cab4">covered_by()</a></code>
36 <a name="geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.h0"></a>
37 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.description"></a></span><a class="link" href="covered_by_geometry_const___.html#geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.description">Description</a>
40 Generate a predicate defining Value and Geometry relationship. Value
41 will be returned by the query if <code class="literal"><code class="computeroutput"><span class="identifier">bg</span><span class="special">::</span><span class="identifier">covered_by</span><span class="special">(</span><span class="identifier">Indexable</span><span class="special">,</span> <span class="identifier">Geometry</span><span class="special">)</span></code></code> returns true.
44 <a name="geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.h1"></a>
45 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.synopsis"></a></span><a class="link" href="covered_by_geometry_const___.html#geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.synopsis">Synopsis</a>
47 <pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special"><</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Geometry</span></code><code class="computeroutput"><span class="special">></span></code>
48 <code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">spatial_predicate</span><span class="special"><</span><span class="identifier">Geometry</span><span class="special">,</span> <span class="identifier">detail</span><span class="special">::</span><span class="identifier">covered_by_tag</span><span class="special">,</span> <span class="keyword">false</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">index</span><span class="special">::</span><span class="identifier">covered_by</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">g</span></code><code class="computeroutput"><span class="special">)</span></code>
51 <a name="geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.h2"></a>
52 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.template_parameter_s_"></a></span><a class="link" href="covered_by_geometry_const___.html#geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.template_parameter_s_">Template
55 <div class="informaltable"><table class="table">
75 <code class="computeroutput"><span class="identifier">Geometry</span></code>
86 <a name="geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.h3"></a>
87 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.parameter_s_"></a></span><a class="link" href="covered_by_geometry_const___.html#geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.parameter_s_">Parameter(s)</a>
89 <div class="informaltable"><table class="table">
115 <code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span>
116 <span class="special">&</span></code>
121 <code class="computeroutput"><span class="identifier">g</span></code>
132 <a name="geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.h4"></a>
133 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.example"></a></span><a class="link" href="covered_by_geometry_const___.html#geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.example">Example</a>
137 <pre class="programlisting"><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">spatial_index</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">covered_by</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
142 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
143 <td align="left"></td>
144 <td align="right"><div class="copyright-footer">Copyright © 2009-2014 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
145 Wulkiewicz, Oracle and/or its affiliates<p>
146 Distributed under the Boost Software License, Version 1.0. (See accompanying
147 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>)
152 <div class="spirit-nav">
153 <a accesskey="p" href="contains_geometry_const___.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../group__predicates.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="covers_geometry_const___.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>