libs/geometry/doc/html/geometry/reference/spatial_indexes/observers/boost__geometry__index__equal_to.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>boost::geometry::index::equal_to</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="../observers.html" title="Observers (boost::geometry::index::)">
   9 <link rel="prev" href="boost__geometry__index__indexable.html" title="boost::geometry::index::indexable">
  10 <link rel="next" href="../group__inserters.html" title="Inserters (boost::geometry::index::)">
  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="boost__geometry__index__indexable.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../observers.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="../group__inserters.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.observers.boost__geometry__index__equal_to"></a><a name="structboost_1_1geometry_1_1index_1_1equal__to"></a><a class="link" href="boost__geometry__index__equal_to.html" title="boost::geometry::index::equal_to">boost::geometry::index::equal_to</a>
  28 </h5></div></div></div>
  29 <div class="toc"><dl class="toc"><dt><span class="section"><a href="boost__geometry__index__equal_to.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.operator___value_const____value_const___">operator()(Value
  30             const &amp;, Value const &amp;)</a></span></dt></dl></div>
  31 <p>
  32             <a class="indexterm" name="idm46186976729616"></a><a class="indexterm" name="idm46186976728928"></a><a class="indexterm" name="idm46186976728240"></a><a class="indexterm" name="idm46186976727552"></a>
  33 The function object comparing Values.
  34           </p>
  35 <h6>
  36 <a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.h0"></a>
  37             <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.description"></a></span><a class="link" href="boost__geometry__index__equal_to.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.description">Description</a>
  38           </h6>
  39 <p>
  40             The default version handles Values which are Indexables, std::pair&lt;T1,
  41             T2&gt;, boost::tuple&lt;...&gt; and std::tuple&lt;...&gt; if STD tuples
  42             and variadic templates are supported. All members are compared from left
  43             to right, Geometries using boost::geometry::equals() function, other
  44             types using operator==.
  45           </p>
  46 <h6>
  47 <a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.h1"></a>
  48             <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.header"></a></span><a class="link" href="boost__geometry__index__equal_to.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.header">Header</a>
  49           </h6>
  50 <p>
  51             <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</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">equal_to</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
  52           </p>
  53 <h6>
  54 <a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.h2"></a>
  55             <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.synopsis"></a></span><a class="link" href="boost__geometry__index__equal_to.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.synopsis">Synopsis</a>
  56           </h6>
  57 <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">Value</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
  58 <code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">equal_to</span></code>
  59 <code class="computeroutput"><span class="special">{</span></code>
  60 <code class="computeroutput">  <span class="comment">// ...</span></code>
  61 <code class="computeroutput"><span class="special">};</span></code>
  62 </pre>
  63 <h6>
  64 <a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.h3"></a>
  65             <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.template_parameter_s_"></a></span><a class="link" href="boost__geometry__index__equal_to.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.template_parameter_s_">Template
  66             parameter(s)</a>
  67           </h6>
  68 <div class="informaltable"><table class="table">
  69 <colgroup>
  70 <col>
  71 <col>
  72 </colgroup>
  73 <thead><tr>
  74 <th>
  75                     <p>
  76                       Parameter
  77                     </p>
  78                   </th>
  79 <th>
  80                     <p>
  81                       Description
  82                     </p>
  83                   </th>
  84 </tr></thead>
  85 <tbody><tr>
  86 <td>
  87                     <p>
  88                       <code class="computeroutput"><span class="identifier">Value</span></code>
  89                     </p>
  90                   </td>
  91 <td>
  92                     <p>
  93                       The type of objects which are compared by this function object.
  94                     </p>
  95                   </td>
  96 </tr></tbody>
  97 </table></div>
  98 <h6>
  99 <a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.h4"></a>
 100             <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.typedef_s_"></a></span><a class="link" href="boost__geometry__index__equal_to.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.typedef_s_">Typedef(s)</a>
 101           </h6>
 102 <div class="informaltable"><table class="table">
 103 <colgroup>
 104 <col>
 105 <col>
 106 </colgroup>
 107 <thead><tr>
 108 <th>
 109                     <p>
 110                       Type
 111                     </p>
 112                   </th>
 113 <th>
 114                     <p>
 115                       Description
 116                     </p>
 117                   </th>
 118 </tr></thead>
 119 <tbody><tr>
 120 <td>
 121                     <p>
 122                       <a name="structboost_1_1geometry_1_1index_1_1equal__to_1ae6a986988e380c2ba4afa646294cfd93"></a><code class="computeroutput"><span class="identifier">result_type</span></code>
 123                     </p>
 124                   </td>
 125 <td>
 126                     <p>
 127                       The type of result returned by function object.
 128                     </p>
 129                   </td>
 130 </tr></tbody>
 131 </table></div>
 132 <h6>
 133 <a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.h5"></a>
 134             <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.member_s_"></a></span><a class="link" href="boost__geometry__index__equal_to.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.member_s_">Member(s)</a>
 135           </h6>
 136 <div class="informaltable"><table class="table">
 137 <colgroup>
 138 <col>
 139 <col>
 140 <col>
 141 </colgroup>
 142 <thead><tr>
 143 <th>
 144                     <p>
 145                       Modifier
 146                     </p>
 147                   </th>
 148 <th>
 149                     <p>
 150                       Function
 151                     </p>
 152                   </th>
 153 <th>
 154                     <p>
 155                       Description
 156                     </p>
 157                   </th>
 158 </tr></thead>
 159 <tbody><tr>
 160 <td>
 161                     <p>
 162                       <code class="computeroutput"><span class="keyword">const</span></code>
 163                     </p>
 164                   </td>
 165 <td>
 166                     <p>
 167                       <a class="link" href="boost__geometry__index__equal_to.html#structboost_1_1geometry_1_1index_1_1equal__to_1aaeece0d0d4cc09ee939b85db0c08b584"><code class="computeroutput"><span class="keyword">operator</span><span class="special">()(</span><span class="identifier">Value</span> <span class="keyword">const</span>
 168                       <span class="special">&amp;,</span> <span class="identifier">Value</span>
 169                       <span class="keyword">const</span> <span class="special">&amp;)</span></code></a>
 170                     </p>
 171                   </td>
 172 <td>
 173                     <p>
 174                       Compare Values.
 175                     </p>
 176                   </td>
 177 </tr></tbody>
 178 </table></div>
 179 <div class="section">
 180 <div class="titlepage"><div><div><h6 class="title">
 181 <a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.operator___value_const____value_const___"></a><a name="structboost_1_1geometry_1_1index_1_1equal__to_1aaeece0d0d4cc09ee939b85db0c08b584"></a><a class="link" href="boost__geometry__index__equal_to.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.operator___value_const____value_const___" title="operator()(Value const &amp;, Value const &amp;)">operator()(Value
 182             const &amp;, Value const &amp;)</a>
 183 </h6></div></div></div>
 184 <p>
 185               <a class="indexterm" name="idm46186976655520"></a>
 186 Compare Values.
 187             </p>
 188 <h7><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.operator___value_const____value_const___.h0"></a>
 189               <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.operator___value_const____value_const___.synopsis"></a></span><a class="link" href="boost__geometry__index__equal_to.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.operator___value_const____value_const___.synopsis">Synopsis</a>
 190             </h7><pre class="programlisting"><code class="computeroutput"><span class="keyword">bool</span></code> <code class="computeroutput"><span class="keyword">operator</span><span class="special">()</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Value</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">l</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">Value</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">r</span></code><code class="computeroutput"><span class="special">)</span></code>
 191 </pre>
 192 <h7><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.operator___value_const____value_const___.h1"></a>
 193               <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.operator___value_const____value_const___.modifier_s_"></a></span><a class="link" href="boost__geometry__index__equal_to.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.operator___value_const____value_const___.modifier_s_">Modifier(s)</a>
 194             </h7><p>
 195 </p>
 196 <pre class="programlisting"><span class="keyword">const</span></pre>
 197 <p>
 198             </p>
 199 <h7><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.operator___value_const____value_const___.h2"></a>
 200               <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.operator___value_const____value_const___.parameter_s_"></a></span><a class="link" href="boost__geometry__index__equal_to.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.operator___value_const____value_const___.parameter_s_">Parameter(s)</a>
 201             </h7><div class="informaltable"><table class="table">
 202 <colgroup>
 203 <col>
 204 <col>
 205 <col>
 206 </colgroup>
 207 <thead><tr>
 208 <th>
 209                       <p>
 210                         Type
 211                       </p>
 212                     </th>
 213 <th>
 214                       <p>
 215                         Name
 216                       </p>
 217                     </th>
 218 <th>
 219                       <p>
 220                         Description
 221                       </p>
 222                     </th>
 223 </tr></thead>
 224 <tbody>
 225 <tr>
 226 <td>
 227                       <p>
 228                         <code class="computeroutput"><span class="identifier">Value</span> <span class="keyword">const</span>
 229                         <span class="special">&amp;</span></code>
 230                       </p>
 231                     </td>
 232 <td>
 233                       <p>
 234                         <code class="computeroutput"><span class="identifier">l</span></code>
 235                       </p>
 236                     </td>
 237 <td>
 238                       <p>
 239                         First value.
 240                       </p>
 241                     </td>
 242 </tr>
 243 <tr>
 244 <td>
 245                       <p>
 246                         <code class="computeroutput"><span class="identifier">Value</span> <span class="keyword">const</span>
 247                         <span class="special">&amp;</span></code>
 248                       </p>
 249                     </td>
 250 <td>
 251                       <p>
 252                         <code class="computeroutput"><span class="identifier">r</span></code>
 253                       </p>
 254                     </td>
 255 <td>
 256                       <p>
 257                         Second value.
 258                       </p>
 259                     </td>
 260 </tr>
 261 </tbody>
 262 </table></div>
 263 <h7><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.operator___value_const____value_const___.h3"></a>
 264               <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.operator___value_const____value_const___.returns"></a></span><a class="link" href="boost__geometry__index__equal_to.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__equal_to.operator___value_const____value_const___.returns">Returns</a>
 265             </h7><p>
 266               true if Values are equal.
 267             </p>
 268 </div>
 269 </div>
 270 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 271 <td align="left"></td>
 272 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 273       Wulkiewicz, Oracle and/or its affiliates<p>
 274         Distributed under the Boost Software License, Version 1.0. (See accompanying
 275         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>)
 276       </p>
 277 </div></td>
 278 </tr></table>
 279 <hr>
 280 <div class="spirit-nav">
 281 <a accesskey="p" href="boost__geometry__index__indexable.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../observers.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="../group__inserters.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 282 </div>
 283 </body>
 284 </html>