ceph/src/boost/libs/icl/doc/html/boost_icl/function_reference/additional_interval_orderings.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Additional Interval Orderings</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
   7 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Icl">
   8 <link rel="up" href="../function_reference.html" title="Function Reference">
   9 <link rel="prev" href="interval_construction.html" title="Interval Construction">
  10 <link rel="next" href="miscellaneous_interval_functions.html" title="Miscellaneous Interval Functions">
  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="../../../../../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="interval_construction.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../function_reference.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="miscellaneous_interval_functions.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section boost_icl_function_reference_additional_interval_orderings" lang="en">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_icl.function_reference.additional_interval_orderings"></a><a class="link" href="additional_interval_orderings.html" title="Additional Interval Orderings">Additional
  28       Interval Orderings</a>
  29 </h3></div></div></div>
  30 <p>
  31         In addition to the standard orderings <code class="computeroutput"><span class="keyword">operator</span>
  32         <span class="special">&lt;</span></code> and rleated <code class="computeroutput"><span class="special">&gt;</span>
  33         <span class="special">&lt;=</span> <span class="special">&gt;=</span></code>
  34         that you will find in the <a class="link" href="../interface/function_synopsis.html#function_synopsis_table"><span class="emphasis"><em><span class="bold"><strong>librarie's function synopsis</strong></span></em></span></a>, intervals
  35         implement some additional orderings that can be useful.
  36       </p>
  37 <div class="informaltable"><table class="table">
  38 <colgroup>
  39 <col>
  40 <col>
  41 <col>
  42 <col>
  43 <col>
  44 <col>
  45 <col>
  46 </colgroup>
  47 <thead><tr>
  48 <th>
  49               <p>
  50                 T
  51               </p>
  52               </th>
  53 <th>
  54               <p>
  55                 discrete<br> _interval
  56               </p>
  57               </th>
  58 <th>
  59               <p>
  60                 continuous<br> _interval
  61               </p>
  62               </th>
  63 <th>
  64               <p>
  65                 right_open<br> _interval
  66               </p>
  67               </th>
  68 <th>
  69               <p>
  70                 left_open<br> _interval
  71               </p>
  72               </th>
  73 <th>
  74               <p>
  75                 closed<br> _interval
  76               </p>
  77               </th>
  78 <th>
  79               <p>
  80                 open<br> _interval
  81               </p>
  82               </th>
  83 </tr></thead>
  84 <tbody>
  85 <tr>
  86 <td>
  87               <p>
  88                 Interval bounds
  89               </p>
  90               </td>
  91 <td>
  92               <p>
  93                 dynamic
  94               </p>
  95               </td>
  96 <td>
  97               <p>
  98                 dynamic
  99               </p>
 100               </td>
 101 <td>
 102               <p>
 103                 static
 104               </p>
 105               </td>
 106 <td>
 107               <p>
 108                 static
 109               </p>
 110               </td>
 111 <td>
 112               <p>
 113                 static
 114               </p>
 115               </td>
 116 <td>
 117               <p>
 118                 static
 119               </p>
 120               </td>
 121 </tr>
 122 <tr>
 123 <td>
 124               <p>
 125                 Form
 126               </p>
 127               </td>
 128 <td>
 129               <p>
 130               </p>
 131               </td>
 132 <td>
 133               <p>
 134               </p>
 135               </td>
 136 <td>
 137               <p>
 138                 asymmetric
 139               </p>
 140               </td>
 141 <td>
 142               <p>
 143                 asymmetric
 144               </p>
 145               </td>
 146 <td>
 147               <p>
 148                 symmetric
 149               </p>
 150               </td>
 151 <td>
 152               <p>
 153                 symmetric
 154               </p>
 155               </td>
 156 </tr>
 157 <tr>
 158 <td>
 159               <p>
 160                 <span class="emphasis"><em><span class="bold"><strong>Orderings</strong></span></em></span>
 161               </p>
 162               </td>
 163 <td>
 164               <p>
 165               </p>
 166               </td>
 167 <td>
 168               <p>
 169               </p>
 170               </td>
 171 <td>
 172               <p>
 173               </p>
 174               </td>
 175 <td>
 176               <p>
 177               </p>
 178               </td>
 179 <td>
 180               <p>
 181               </p>
 182               </td>
 183 <td>
 184               <p>
 185               </p>
 186               </td>
 187 </tr>
 188 <tr>
 189 <td>
 190               <p>
 191                 <code class="computeroutput"><span class="keyword">bool</span> <span class="identifier">exclusive_less</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;,</span>
 192                 <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span></code>
 193               </p>
 194               </td>
 195 <td>
 196               <p>
 197                 1
 198               </p>
 199               </td>
 200 <td>
 201               <p>
 202                 1
 203               </p>
 204               </td>
 205 <td>
 206               <p>
 207                 1
 208               </p>
 209               </td>
 210 <td>
 211               <p>
 212                 1
 213               </p>
 214               </td>
 215 <td>
 216               <p>
 217                 1
 218               </p>
 219               </td>
 220 <td>
 221               <p>
 222                 1
 223               </p>
 224               </td>
 225 </tr>
 226 <tr>
 227 <td>
 228               <p>
 229
 230 </p>
 231 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">bool</span> <span class="identifier">lower_less</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span>
 232 <span class="keyword">bool</span> <span class="identifier">lower_equal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span>
 233 <span class="keyword">bool</span> <span class="identifier">lower_less_equal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span>
 234 </pre>
 235 <p>
 236               </p>
 237               </td>
 238 <td>
 239               <p>
 240                 1
 241               </p>
 242               </td>
 243 <td>
 244               <p>
 245                 1
 246               </p>
 247               </td>
 248 <td>
 249               <p>
 250                 1
 251               </p>
 252               </td>
 253 <td>
 254               <p>
 255                 1
 256               </p>
 257               </td>
 258 <td>
 259               <p>
 260                 1
 261               </p>
 262               </td>
 263 <td>
 264               <p>
 265                 1
 266               </p>
 267               </td>
 268 </tr>
 269 <tr>
 270 <td>
 271               <p>
 272
 273 </p>
 274 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">bool</span> <span class="identifier">upper_less</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span>
 275 <span class="keyword">bool</span> <span class="identifier">upper_equal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span>
 276 <span class="keyword">bool</span> <span class="identifier">upper_less_equal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span>
 277 </pre>
 278 <p>
 279               </p>
 280               </td>
 281 <td>
 282               <p>
 283                 1
 284               </p>
 285               </td>
 286 <td>
 287               <p>
 288                 1
 289               </p>
 290               </td>
 291 <td>
 292               <p>
 293                 1
 294               </p>
 295               </td>
 296 <td>
 297               <p>
 298                 1
 299               </p>
 300               </td>
 301 <td>
 302               <p>
 303                 1
 304               </p>
 305               </td>
 306 <td>
 307               <p>
 308                 1
 309               </p>
 310               </td>
 311 </tr>
 312 </tbody>
 313 </table></div>
 314 <p>
 315         A central role for the <span class="bold"><strong>icl</strong></span> plays the <code class="computeroutput"><span class="identifier">exclusive_less</span></code> ordering, which is used
 316         in all interval containers. The other orderings can be useful to simplify
 317         comparison of intervals specifically for dynamically bounded ones.
 318       </p>
 319 <div class="informaltable"><table class="table">
 320 <colgroup>
 321 <col>
 322 <col>
 323 </colgroup>
 324 <thead><tr>
 325 <th>
 326               <p>
 327                 <span class="emphasis"><em><span class="bold"><strong>Orderings</strong></span></em></span>
 328               </p>
 329               </th>
 330 <th>
 331               <p>
 332                 Description
 333               </p>
 334               </th>
 335 </tr></thead>
 336 <tbody>
 337 <tr>
 338 <td>
 339               <p>
 340                 <code class="computeroutput"><span class="keyword">bool</span> <span class="identifier">exclusive_less</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;,</span>
 341                 <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span></code>
 342               </p>
 343               </td>
 344 <td>
 345               <p>
 346                 <code class="computeroutput"><span class="identifier">exclusive_less</span><span class="special">(</span><span class="identifier">x1</span><span class="special">,</span> <span class="identifier">x2</span><span class="special">)</span></code>
 347                 is true if every element of interval <code class="computeroutput"><span class="identifier">x1</span></code>
 348                 is less than every element of interval <code class="computeroutput"><span class="identifier">x2</span></code>
 349                 w.r.t. the the intervals <code class="computeroutput"><span class="identifier">Compare</span></code>
 350                 ordering
 351               </p>
 352               </td>
 353 </tr>
 354 <tr>
 355 <td>
 356               <p>
 357
 358 </p>
 359 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">bool</span> <span class="identifier">lower_less</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span>
 360 <span class="keyword">bool</span> <span class="identifier">lower_equal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span>
 361 <span class="keyword">bool</span> <span class="identifier">lower_less_equal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span>
 362 </pre>
 363 <p>
 364               </p>
 365               </td>
 366 <td>
 367               <p>
 368                 Compares the beginnings of intervals.
 369 </p>
 370 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">lower_less</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span>  <span class="special">==</span> <span class="keyword">true</span><span class="special">;</span> <span class="comment">// x begins before y
 371 </span><span class="identifier">lower_equal</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">true</span><span class="special">;</span> <span class="comment">// x and y begin at the same element
 372 </span><span class="identifier">lower_less_equal</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span> <span class="special">==</span> <span class="identifier">lower_less</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span> <span class="special">||</span> <span class="identifier">lower_equal</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">);</span>
 373 </pre>
 374 <p>
 375               </p>
 376               </td>
 377 </tr>
 378 <tr>
 379 <td>
 380               <p>
 381
 382 </p>
 383 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">bool</span> <span class="identifier">upper_less</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span>
 384 <span class="keyword">bool</span> <span class="identifier">upper_equal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span>
 385 <span class="keyword">bool</span> <span class="identifier">upper_less_equal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;)</span>
 386 </pre>
 387 <p>
 388               </p>
 389               </td>
 390 <td>
 391               <p>
 392                 Compares the endings of intervals.
 393 </p>
 394 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">upper_less</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span>  <span class="special">==</span> <span class="keyword">true</span><span class="special">;</span> <span class="comment">// x ends before y
 395 </span><span class="identifier">upper_equal</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">true</span><span class="special">;</span> <span class="comment">// x and y end at the same element
 396 </span><span class="identifier">upper_less_equal</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span> <span class="special">==</span> <span class="identifier">upper_less</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span> <span class="special">||</span> <span class="identifier">upper_equal</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">);</span>
 397 </pre>
 398 <p>
 399               </p>
 400               </td>
 401 </tr>
 402 </tbody>
 403 </table></div>
 404 <p>
 405         <span class="emphasis"><em><span class="bold"><strong>See also . . .</strong></span></em></span>
 406       </p>
 407 <div class="informaltable"><table class="table">
 408 <colgroup><col></colgroup>
 409 <thead><tr></tr></thead>
 410 <tbody><tr><td>
 411               <p>
 412                 <a class="link" href="equivalences_and_orderings.html" title="Equivalences and Orderings"><span class="emphasis"><em><span class="bold"><strong>Equivalences and Orderings</strong></span></em></span></a>
 413               </p>
 414               </td></tr></tbody>
 415 </table></div>
 416 <p>
 417         <span class="emphasis"><em><span class="bold"><strong>Back to section . . .</strong></span></em></span>
 418       </p>
 419 <div class="informaltable"><table class="table">
 420 <colgroup><col></colgroup>
 421 <thead><tr></tr></thead>
 422 <tbody>
 423 <tr><td>
 424               <p>
 425                 <a class="link" href="../interface/function_synopsis.html#additional_interval_functions"><span class="emphasis"><em><span class="bold"><strong>Additional interval functions</strong></span></em></span></a>
 426               </p>
 427               </td></tr>
 428 <tr><td>
 429               <p>
 430                 <a class="link" href="../interface/function_synopsis.html#function_synopsis_table"><span class="emphasis"><em><span class="bold"><strong>Function
 431                 Synopsis</strong></span></em></span></a>
 432               </p>
 433               </td></tr>
 434 <tr><td>
 435               <p>
 436                 <a class="link" href="../interface.html" title="Interface"><span class="emphasis"><em><span class="bold"><strong>Interface</strong></span></em></span></a>
 437               </p>
 438               </td></tr>
 439 </tbody>
 440 </table></div>
 441 </div>
 442 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 443 <td align="left"></td>
 444 <td align="right"><div class="copyright-footer">Copyright &#169; 2007 -2010 Joachim Faulhaber<br>Copyright &#169; 1999 -2006 Cortex Software GmbH<p>
 445         Distributed under the Boost Software License, Version 1.0. (See accompanying
 446         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>)
 447       </p>
 448 </div></td>
 449 </tr></table>
 450 <hr>
 451 <div class="spirit-nav">
 452 <a accesskey="p" href="interval_construction.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../function_reference.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="miscellaneous_interval_functions.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 453 </div>
 454 </body>
 455 </html>