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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>satisfies(UnaryPredicate 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="within_geometry_const___.html" title="within(Geometry const &amp;)">
  10 <link rel="next" href="nearest_geometry_const____unsigned_.html" title="nearest(Geometry const &amp;, unsigned)">
  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="within_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="nearest_geometry_const____unsigned_.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.satisfies_unarypredicate_const___"></a><a name="group__predicates_1ga3213772dd3e54ad03340c2ca66b4f58c"></a><a class="link" href="satisfies_unarypredicate_const___.html" title="satisfies(UnaryPredicate const &amp;)">satisfies(UnaryPredicate
  28           const &amp;)</a>
  29 </h5></div></div></div>
  30 <p>
  31             <a class="indexterm" name="idm46186975912144"></a>
  32 Generate <a class="link" href="satisfies_unarypredicate_const___.html#group__predicates_1ga3213772dd3e54ad03340c2ca66b4f58c">satisfies()</a>
  33             predicate.
  34           </p>
  35 <h6>
  36 <a name="geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___.h0"></a>
  37             <span class="phrase"><a name="geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___.description"></a></span><a class="link" href="satisfies_unarypredicate_const___.html#geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___.description">Description</a>
  38           </h6>
  39 <p>
  40             A wrapper around user-defined UnaryPredicate checking if Value should
  41             be returned by spatial query.
  42           </p>
  43 <h6>
  44 <a name="geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___.h1"></a>
  45             <span class="phrase"><a name="geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___.synopsis"></a></span><a class="link" href="satisfies_unarypredicate_const___.html#geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___.synopsis">Synopsis</a>
  46           </h6>
  47 <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">UnaryPredicate</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
  48 <span class="emphasis"><em>unspecified</em></span> <code class="computeroutput"><span class="identifier">satisfies</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">UnaryPredicate</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">pred</span></code><code class="computeroutput"><span class="special">)</span></code>
  49 </pre>
  50 <h6>
  51 <a name="geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___.h2"></a>
  52             <span class="phrase"><a name="geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___.template_parameter_s_"></a></span><a class="link" href="satisfies_unarypredicate_const___.html#geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___.template_parameter_s_">Template
  53             parameter(s)</a>
  54           </h6>
  55 <div class="informaltable"><table class="table">
  56 <colgroup>
  57 <col>
  58 <col>
  59 </colgroup>
  60 <thead><tr>
  61 <th>
  62                     <p>
  63                       Parameter
  64                     </p>
  65                   </th>
  66 <th>
  67                     <p>
  68                       Description
  69                     </p>
  70                   </th>
  71 </tr></thead>
  72 <tbody><tr>
  73 <td>
  74                     <p>
  75                       <code class="computeroutput"><span class="identifier">UnaryPredicate</span></code>
  76                     </p>
  77                   </td>
  78 <td>
  79                     <p>
  80                       A type of unary predicate function or function object.
  81                     </p>
  82                   </td>
  83 </tr></tbody>
  84 </table></div>
  85 <h6>
  86 <a name="geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___.h3"></a>
  87             <span class="phrase"><a name="geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___.parameter_s_"></a></span><a class="link" href="satisfies_unarypredicate_const___.html#geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___.parameter_s_">Parameter(s)</a>
  88           </h6>
  89 <div class="informaltable"><table class="table">
  90 <colgroup>
  91 <col>
  92 <col>
  93 <col>
  94 </colgroup>
  95 <thead><tr>
  96 <th>
  97                     <p>
  98                       Type
  99                     </p>
 100                   </th>
 101 <th>
 102                     <p>
 103                       Name
 104                     </p>
 105                   </th>
 106 <th>
 107                     <p>
 108                       Description
 109                     </p>
 110                   </th>
 111 </tr></thead>
 112 <tbody><tr>
 113 <td>
 114                     <p>
 115                       <code class="computeroutput"><span class="identifier">UnaryPredicate</span> <span class="keyword">const</span> <span class="special">&amp;</span></code>
 116                     </p>
 117                   </td>
 118 <td>
 119                     <p>
 120                       <code class="computeroutput"><span class="identifier">pred</span></code>
 121                     </p>
 122                   </td>
 123 <td>
 124                     <p>
 125                       The unary predicate function or function object.
 126                     </p>
 127                   </td>
 128 </tr></tbody>
 129 </table></div>
 130 <h6>
 131 <a name="geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___.h4"></a>
 132             <span class="phrase"><a name="geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___.example"></a></span><a class="link" href="satisfies_unarypredicate_const___.html#geometry.reference.spatial_indexes.group__predicates.satisfies_unarypredicate_const___.example">Example</a>
 133           </h6>
 134 <p>
 135 </p>
 136 <pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">is_red</span><span class="special">(</span><span class="identifier">Value</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">is_red</span><span class="special">();</span> <span class="special">}</span>
 137
 138 <span class="keyword">struct</span> <span class="identifier">is_red_o</span> <span class="special">{</span>
 139 <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">&gt;</span> <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">()(</span><span class="identifier">Value</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">is_red</span><span class="special">();</span> <span class="special">}</span>
 140 <span class="special">}</span>
 141
 142 <span class="comment">// ...</span>
 143
 144 <span class="identifier">rt</span><span class="special">.</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">box</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="identifier">index</span><span class="special">::</span><span class="identifier">satisfies</span><span class="special">(</span><span class="identifier">is_red</span><span class="special">),</span>
 145 <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>
 146
 147 <span class="identifier">rt</span><span class="special">.</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">box</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="identifier">index</span><span class="special">::</span><span class="identifier">satisfies</span><span class="special">(</span><span class="identifier">is_red_o</span><span class="special">()),</span>
 148 <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>
 149
 150 <span class="preprocessor">#ifndef</span> <span class="identifier">BOOST_NO_CXX11_LAMBDAS</span>
 151 <span class="identifier">rt</span><span class="special">.</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">box</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="identifier">index</span><span class="special">::</span><span class="identifier">satisfies</span><span class="special">([](</span><span class="identifier">Value</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">is_red</span><span class="special">();</span> <span class="special">}),</span>
 152 <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>
 153 <span class="preprocessor">#endif</span>
 154 </pre>
 155 <p>
 156           </p>
 157 </div>
 158 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 159 <td align="left"></td>
 160 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 161       Wulkiewicz, Oracle and/or its affiliates<p>
 162         Distributed under the Boost Software License, Version 1.0. (See accompanying
 163         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>)
 164       </p>
 165 </div></td>
 166 </tr></table>
 167 <hr>
 168 <div class="spirit-nav">
 169 <a accesskey="p" href="within_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="nearest_geometry_const____unsigned_.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 170 </div>
 171 </body>
 172 </html>