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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>boost::geometry::index::indexable</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="../observers.html" title="Observers (boost::geometry::index::)">
  10 <link rel="next" href="boost__geometry__index__equal_to.html" title="boost::geometry::index::equal_to">
  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="../observers.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="boost__geometry__index__equal_to.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__indexable"></a><a name="structboost_1_1geometry_1_1index_1_1indexable"></a><a class="link" href="boost__geometry__index__indexable.html" title="boost::geometry::index::indexable">boost::geometry::index::indexable</a>
  28 </h5></div></div></div>
  29 <div class="toc"><dl class="toc">
  30 <dt><span class="section"><a href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___value_const___">operator()(Value
  31             const &amp;)</a></span></dt>
  32 <dt><span class="section"><a href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___v_const___">operator()(V
  33             const &amp;)</a></span></dt>
  34 </dl></div>
  35 <p>
  36             <a class="indexterm" name="idm46186976893536"></a><a class="indexterm" name="idm46186976892848"></a><a class="indexterm" name="idm46186976892160"></a><a class="indexterm" name="idm46186976891472"></a>
  37 The function object extracting Indexable from Value.
  38           </p>
  39 <h6>
  40 <a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.h0"></a>
  41             <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.description"></a></span><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.description">Description</a>
  42           </h6>
  43 <p>
  44             It translates Value object to Indexable object. By default, it can handle
  45             Values which are Indexables, std::pair&lt;Indexable, T2&gt;, boost::tuple&lt;Indexable,
  46             ...&gt; and std::tuple&lt;Indexable, ...&gt; if STD tuples and variadic
  47             templates are supported.
  48           </p>
  49 <h6>
  50 <a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.h1"></a>
  51             <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.header"></a></span><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.header">Header</a>
  52           </h6>
  53 <p>
  54             <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">indexable</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
  55           </p>
  56 <h6>
  57 <a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.h2"></a>
  58             <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.synopsis"></a></span><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.synopsis">Synopsis</a>
  59           </h6>
  60 <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>
  61 <code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">indexable</span></code>
  62 <code class="computeroutput"><span class="special">{</span></code>
  63 <code class="computeroutput">  <span class="comment">// ...</span></code>
  64 <code class="computeroutput"><span class="special">};</span></code>
  65 </pre>
  66 <h6>
  67 <a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.h3"></a>
  68             <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.template_parameter_s_"></a></span><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.template_parameter_s_">Template
  69             parameter(s)</a>
  70           </h6>
  71 <div class="informaltable"><table class="table">
  72 <colgroup>
  73 <col>
  74 <col>
  75 </colgroup>
  76 <thead><tr>
  77 <th>
  78                     <p>
  79                       Parameter
  80                     </p>
  81                   </th>
  82 <th>
  83                     <p>
  84                       Description
  85                     </p>
  86                   </th>
  87 </tr></thead>
  88 <tbody><tr>
  89 <td>
  90                     <p>
  91                       <code class="computeroutput"><span class="identifier">Value</span></code>
  92                     </p>
  93                   </td>
  94 <td>
  95                     <p>
  96                       The Value type which may be translated directly to the Indexable.
  97                     </p>
  98                   </td>
  99 </tr></tbody>
 100 </table></div>
 101 <h6>
 102 <a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.h4"></a>
 103             <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.typedef_s_"></a></span><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.typedef_s_">Typedef(s)</a>
 104           </h6>
 105 <div class="informaltable"><table class="table">
 106 <colgroup>
 107 <col>
 108 <col>
 109 </colgroup>
 110 <thead><tr>
 111 <th>
 112                     <p>
 113                       Type
 114                     </p>
 115                   </th>
 116 <th>
 117                     <p>
 118                       Description
 119                     </p>
 120                   </th>
 121 </tr></thead>
 122 <tbody><tr>
 123 <td>
 124                     <p>
 125                       <a name="structboost_1_1geometry_1_1index_1_1indexable_1af6f21324f6484330b9deb0ee0629f4b4"></a><code class="computeroutput"><span class="identifier">result_type</span></code>
 126                     </p>
 127                   </td>
 128 <td>
 129                     <p>
 130                       The type of result returned by function object. It should be
 131                       const Indexable reference.
 132                     </p>
 133                   </td>
 134 </tr></tbody>
 135 </table></div>
 136 <h6>
 137 <a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.h5"></a>
 138             <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.member_s_"></a></span><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.member_s_">Member(s)</a>
 139           </h6>
 140 <div class="informaltable"><table class="table">
 141 <colgroup>
 142 <col>
 143 <col>
 144 <col>
 145 </colgroup>
 146 <thead><tr>
 147 <th>
 148                     <p>
 149                       Modifier
 150                     </p>
 151                   </th>
 152 <th>
 153                     <p>
 154                       Function
 155                     </p>
 156                   </th>
 157 <th>
 158                     <p>
 159                       Description
 160                     </p>
 161                   </th>
 162 </tr></thead>
 163 <tbody>
 164 <tr>
 165 <td>
 166                     <p>
 167                       <code class="computeroutput"><span class="keyword">const</span></code>
 168                     </p>
 169                   </td>
 170 <td>
 171                     <p>
 172                       <a class="link" href="boost__geometry__index__indexable.html#structboost_1_1geometry_1_1index_1_1indexable_1a0bbe640be9ae0475e1b56f5b2e08877e"><code class="computeroutput"><span class="keyword">operator</span><span class="special">()(</span><span class="identifier">Value</span> <span class="keyword">const</span>
 173                       <span class="special">&amp;)</span></code></a>
 174                     </p>
 175                   </td>
 176 <td>
 177                     <p>
 178                       Return indexable extracted from the value.
 179                     </p>
 180                   </td>
 181 </tr>
 182 <tr>
 183 <td>
 184                     <p>
 185                       <code class="computeroutput"><span class="keyword">const</span></code>
 186                     </p>
 187                   </td>
 188 <td>
 189                     <p>
 190                       <a class="link" href="boost__geometry__index__indexable.html#structboost_1_1geometry_1_1index_1_1indexable_1a4aa66ffe2975f655bada9e6b5a65317b"><code class="computeroutput"><span class="keyword">operator</span><span class="special">()(</span><span class="identifier">V</span> <span class="keyword">const</span>
 191                       <span class="special">&amp;)</span></code></a>
 192                     </p>
 193                   </td>
 194 <td>
 195                     <p>
 196                       Return indexable extracted from the value. Overload for types
 197                       compatible with Value but different yet holding referencable
 198                       Indexable, e.g. tuple containing a reference.
 199                     </p>
 200                   </td>
 201 </tr>
 202 </tbody>
 203 </table></div>
 204 <div class="section">
 205 <div class="titlepage"><div><div><h6 class="title">
 206 <a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___value_const___"></a><a name="structboost_1_1geometry_1_1index_1_1indexable_1a0bbe640be9ae0475e1b56f5b2e08877e"></a><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___value_const___" title="operator()(Value const &amp;)">operator()(Value
 207             const &amp;)</a>
 208 </h6></div></div></div>
 209 <p>
 210               <a class="indexterm" name="idm46186976812528"></a>
 211 Return indexable extracted from the value.
 212             </p>
 213 <h7><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___value_const___.h0"></a>
 214               <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___value_const___.synopsis"></a></span><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___value_const___.synopsis">Synopsis</a>
 215             </h7><pre class="programlisting"><code class="literal"><a class="link" href="boost__geometry__index__indexable.html#structboost_1_1geometry_1_1index_1_1indexable_1af6f21324f6484330b9deb0ee0629f4b4">result_type</a></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">v</span></code><code class="computeroutput"><span class="special">)</span></code>
 216 </pre>
 217 <h7><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___value_const___.h1"></a>
 218               <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___value_const___.modifier_s_"></a></span><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___value_const___.modifier_s_">Modifier(s)</a>
 219             </h7><p>
 220 </p>
 221 <pre class="programlisting"><span class="keyword">const</span></pre>
 222 <p>
 223             </p>
 224 <h7><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___value_const___.h2"></a>
 225               <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___value_const___.parameter_s_"></a></span><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___value_const___.parameter_s_">Parameter(s)</a>
 226             </h7><div class="informaltable"><table class="table">
 227 <colgroup>
 228 <col>
 229 <col>
 230 <col>
 231 </colgroup>
 232 <thead><tr>
 233 <th>
 234                       <p>
 235                         Type
 236                       </p>
 237                     </th>
 238 <th>
 239                       <p>
 240                         Name
 241                       </p>
 242                     </th>
 243 <th>
 244                       <p>
 245                         Description
 246                       </p>
 247                     </th>
 248 </tr></thead>
 249 <tbody><tr>
 250 <td>
 251                       <p>
 252                         <code class="computeroutput"><span class="identifier">Value</span> <span class="keyword">const</span>
 253                         <span class="special">&amp;</span></code>
 254                       </p>
 255                     </td>
 256 <td>
 257                       <p>
 258                         <code class="computeroutput"><span class="identifier">v</span></code>
 259                       </p>
 260                     </td>
 261 <td>
 262                       <p>
 263                         The value.
 264                       </p>
 265                     </td>
 266 </tr></tbody>
 267 </table></div>
 268 <h7><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___value_const___.h3"></a>
 269               <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___value_const___.returns"></a></span><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___value_const___.returns">Returns</a>
 270             </h7><p>
 271               The indexable.
 272             </p>
 273 </div>
 274 <div class="section">
 275 <div class="titlepage"><div><div><h6 class="title">
 276 <a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___v_const___"></a><a name="structboost_1_1geometry_1_1index_1_1indexable_1a4aa66ffe2975f655bada9e6b5a65317b"></a><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___v_const___" title="operator()(V const &amp;)">operator()(V
 277             const &amp;)</a>
 278 </h6></div></div></div>
 279 <p>
 280               <a class="indexterm" name="idm46186976772992"></a>
 281 Return indexable extracted from the value. Overload for types compatible
 282               with Value but different yet holding referencable Indexable, e.g. tuple
 283               containing a reference.
 284             </p>
 285 <h7><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___v_const___.h0"></a>
 286               <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___v_const___.synopsis"></a></span><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___v_const___.synopsis">Synopsis</a>
 287             </h7><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">V</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
 288 <code class="literal"><a class="link" href="boost__geometry__index__indexable.html#structboost_1_1geometry_1_1index_1_1indexable_1af6f21324f6484330b9deb0ee0629f4b4">result_type</a></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">V</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code>
 289 </pre>
 290 <h7><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___v_const___.h1"></a>
 291               <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___v_const___.modifier_s_"></a></span><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___v_const___.modifier_s_">Modifier(s)</a>
 292             </h7><p>
 293 </p>
 294 <pre class="programlisting"><span class="keyword">const</span></pre>
 295 <p>
 296             </p>
 297 <h7><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___v_const___.h2"></a>
 298               <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___v_const___.parameter_s_"></a></span><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___v_const___.parameter_s_">Parameter(s)</a>
 299             </h7><div class="informaltable"><table class="table">
 300 <colgroup>
 301 <col>
 302 <col>
 303 <col>
 304 </colgroup>
 305 <thead><tr>
 306 <th>
 307                       <p>
 308                         Type
 309                       </p>
 310                     </th>
 311 <th>
 312                       <p>
 313                         Name
 314                       </p>
 315                     </th>
 316 <th>
 317                       <p>
 318                         Description
 319                       </p>
 320                     </th>
 321 </tr></thead>
 322 <tbody><tr>
 323 <td>
 324                       <p>
 325                         <code class="computeroutput"><span class="identifier">V</span> <span class="keyword">const</span>
 326                         <span class="special">&amp;</span></code>
 327                       </p>
 328                     </td>
 329 <td>
 330                       <p>
 331                         <code class="computeroutput"><span class="identifier">v</span></code>
 332                       </p>
 333                     </td>
 334 <td>
 335                       <p>
 336                         The value.
 337                       </p>
 338                     </td>
 339 </tr></tbody>
 340 </table></div>
 341 <h7><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___v_const___.h3"></a>
 342               <span class="phrase"><a name="geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___v_const___.returns"></a></span><a class="link" href="boost__geometry__index__indexable.html#geometry.reference.spatial_indexes.observers.boost__geometry__index__indexable.operator___v_const___.returns">Returns</a>
 343             </h7><p>
 344               The indexable.
 345             </p>
 346 </div>
 347 </div>
 348 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 349 <td align="left"></td>
 350 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 351       Wulkiewicz, Oracle and/or its affiliates<p>
 352         Distributed under the Boost Software License, Version 1.0. (See accompanying
 353         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>)
 354       </p>
 355 </div></td>
 356 </tr></table>
 357 <hr>
 358 <div class="spirit-nav">
 359 <a accesskey="p" href="../observers.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="boost__geometry__index__equal_to.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 360 </div>
 361 </body>
 362 </html>