libs/geometry/doc/html/geometry/reference/spatial_indexes/group__predicates/covered_by_geometry_const___.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>covered_by(Geometry const &amp;)</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="../group__predicates.html" title="Predicates (boost::geometry::index::)">
   9 <link rel="prev" href="contains_geometry_const___.html" title="contains(Geometry const &amp;)">
  10 <link rel="next" href="covers_geometry_const___.html" title="covers(Geometry const &amp;)">
  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="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>
  24 </div>
  25 <div class="section">
  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_1ga02dbb7cca47de0b921ef96af464d9590"></a><a class="link" href="covered_by_geometry_const___.html" title="covered_by(Geometry const &amp;)">covered_by(Geometry
  28           const &amp;)</a>
  29 </h5></div></div></div>
  30 <p>
  31             <a class="indexterm" name="idm46716118706528"></a>
  32 Generate <code class="literal"><a class="link" href="covered_by_geometry_const___.html#group__predicates_1ga02dbb7cca47de0b921ef96af464d9590">covered_by()</a></code>
  33             predicate.
  34           </p>
  35 <h6>
  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>
  38           </h6>
  39 <p>
  40             Generate a predicate defining Value and Geometry relationship. With this
  41             predicate query returns indexed Values that are covered by passed Geometry.
  42             Value is 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 <code class="literal"><code class="computeroutput"><span class="keyword">true</span></code></code>.
  43           </p>
  44 <h6>
  45 <a name="geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.h1"></a>
  46             <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           </h6>
  48 <pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Geometry</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
  49 <span class="emphasis"><em>unspecified</em></span> <code class="computeroutput"><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">&amp;</span></code> <code class="computeroutput"><span class="identifier">g</span></code><code class="computeroutput"><span class="special">)</span></code>
  50 </pre>
  51 <h6>
  52 <a name="geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.h2"></a>
  53             <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
  54             parameter(s)</a>
  55           </h6>
  56 <div class="informaltable"><table class="table">
  57 <colgroup>
  58 <col>
  59 <col>
  60 </colgroup>
  61 <thead><tr>
  62 <th>
  63                     <p>
  64                       Parameter
  65                     </p>
  66                   </th>
  67 <th>
  68                     <p>
  69                       Description
  70                     </p>
  71                   </th>
  72 </tr></thead>
  73 <tbody><tr>
  74 <td>
  75                     <p>
  76                       <code class="computeroutput"><span class="identifier">Geometry</span></code>
  77                     </p>
  78                   </td>
  79 <td>
  80                     <p>
  81                       The Geometry type.
  82                     </p>
  83                   </td>
  84 </tr></tbody>
  85 </table></div>
  86 <h6>
  87 <a name="geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.h3"></a>
  88             <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           </h6>
  90 <div class="informaltable"><table class="table">
  91 <colgroup>
  92 <col>
  93 <col>
  94 <col>
  95 </colgroup>
  96 <thead><tr>
  97 <th>
  98                     <p>
  99                       Type
 100                     </p>
 101                   </th>
 102 <th>
 103                     <p>
 104                       Name
 105                     </p>
 106                   </th>
 107 <th>
 108                     <p>
 109                       Description
 110                     </p>
 111                   </th>
 112 </tr></thead>
 113 <tbody><tr>
 114 <td>
 115                     <p>
 116                       <code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span>
 117                       <span class="special">&amp;</span></code>
 118                     </p>
 119                   </td>
 120 <td>
 121                     <p>
 122                       <code class="computeroutput"><span class="identifier">g</span></code>
 123                     </p>
 124                   </td>
 125 <td>
 126                     <p>
 127                       The Geometry object.
 128                     </p>
 129                   </td>
 130 </tr></tbody>
 131 </table></div>
 132 <h6>
 133 <a name="geometry.reference.spatial_indexes.group__predicates.covered_by_geometry_const___.h4"></a>
 134             <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>
 135           </h6>
 136 <p>
 137 </p>
 138 <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>
 139 </pre>
 140 <p>
 141           </p>
 142 </div>
 143 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 144 <td align="left"></td>
 145 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 146       Wulkiewicz, Oracle and/or its affiliates<p>
 147         Distributed under the Boost Software License, Version 1.0. (See accompanying
 148         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>)
 149       </p>
 150 </div></td>
 151 </tr></table>
 152 <hr>
 153 <div class="spirit-nav">
 154 <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>
 155 </div>
 156 </body>
 157 </html>