ceph/src/boost/libs/icl/doc/html/boost/icl/discrete_interval.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template discrete_interval</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="../../header/boost/icl/discrete_interval_hpp.html" title="Header &lt;boost/icl/discrete_interval.hpp&gt;">
   9 <link rel="prev" href="../../header/boost/icl/discrete_interval_hpp.html" title="Header &lt;boost/icl/discrete_interval.hpp&gt;">
  10 <link rel="next" href="interval_traits_i_id646891.html" title="Struct template interval_traits&lt;icl::discrete_interval&lt; DomainT, Compare &gt;&gt;">
  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="../../header/boost/icl/discrete_interval_hpp.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/icl/discrete_interval_hpp.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="interval_traits_i_id646891.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry" lang="en">
  26 <a name="boost.icl.discrete_interval"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template discrete_interval</span></h2>
  29 <p>boost::icl::discrete_interval</p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../header/boost/icl/discrete_interval_hpp.html" title="Header &lt;boost/icl/discrete_interval.hpp&gt;">boost/icl/discrete_interval.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> DomainT<span class="special">,</span>
  35          <span class="identifier">ICL_COMPARE</span> Compare <span class="special">=</span> <span class="identifier">ICL_COMPARE_INSTANCE</span><span class="special">(</span><span class="identifier">ICL_COMPARE_DEFAULT</span><span class="special">,</span> <span class="identifier">DomainT</span><span class="special">)</span><span class="special">&gt;</span>
  36 <span class="keyword">class</span> <a class="link" href="discrete_interval.html" title="Class template discrete_interval">discrete_interval</a> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38   <span class="comment">// types</span>
  39   <span class="keyword">typedef</span> <span class="identifier">discrete_interval</span><span class="special">&lt;</span> <span class="identifier">DomainT</span><span class="special">,</span> <span class="identifier">Compare</span> <span class="special">&gt;</span> <a name="boost.icl.discrete_interval.type"></a><span class="identifier">type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">DomainT</span>                               <a name="boost.icl.discrete_interval.domain_type"></a><span class="identifier">domain_type</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">bounded_value</span><span class="special">&lt;</span> <span class="identifier">DomainT</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>        <a name="boost.icl.discrete_interval.bounded_domain_type"></a><span class="identifier">bounded_domain_type</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="discrete_interval.html#boost.icl.discrete_intervalconstruct-copy-destruct">construct/copy/destruct</a></span>
  44   <a class="link" href="discrete_interval.html#id645666-bb"><span class="identifier">discrete_interval</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  45   <span class="keyword">explicit</span> <a class="link" href="discrete_interval.html#id645674-bb"><span class="identifier">discrete_interval</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  46   <a class="link" href="discrete_interval.html#id645689-bb"><span class="identifier">discrete_interval</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span><span class="special">,</span>
  47                     <span class="identifier">interval_bounds</span> <span class="special">=</span> <span class="identifier">interval_bounds</span><span class="special">::</span><span class="identifier">right_open</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
  48                     <span class="identifier">discrete_interval</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
  49
  50   <span class="comment">// <a class="link" href="discrete_interval.html#id645630-bb">public member functions</a></span>
  51   <span class="keyword">typedef</span> <a class="link" href="discrete_interval.html#id645632-bb"><span class="identifier">ICL_COMPARE_DOMAIN</span></a><span class="special">(</span><span class="identifier">Compare</span><span class="special">,</span> <span class="identifier">DomainT</span><span class="special">)</span><span class="special">;</span>
  52   <span class="identifier">domain_type</span> <a class="link" href="discrete_interval.html#id645648-bb"><span class="identifier">lower</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  53   <span class="identifier">domain_type</span> <a class="link" href="discrete_interval.html#id645654-bb"><span class="identifier">upper</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  54   <span class="identifier">interval_bounds</span> <a class="link" href="discrete_interval.html#id645660-bb"><span class="identifier">bounds</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  55
  56   <span class="comment">// <a class="link" href="discrete_interval.html#id645728-bb">public static functions</a></span>
  57   <span class="keyword">static</span> <span class="identifier">discrete_interval</span> <a class="link" href="discrete_interval.html#id645731-bb"><span class="identifier">open</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  58   <span class="keyword">static</span> <span class="identifier">discrete_interval</span> <a class="link" href="discrete_interval.html#id645746-bb"><span class="identifier">right_open</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  59   <span class="keyword">static</span> <span class="identifier">discrete_interval</span> <a class="link" href="discrete_interval.html#id645762-bb"><span class="identifier">left_open</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  60   <span class="keyword">static</span> <span class="identifier">discrete_interval</span> <a class="link" href="discrete_interval.html#id646876-bb"><span class="identifier">closed</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  61 <span class="special">}</span><span class="special">;</span></pre></div>
  62 <div class="refsect1" lang="en">
  63 <a name="id1206546"></a><h2>Description</h2>
  64 <div class="refsect2" lang="en">
  65 <a name="id1206550"></a><h3>
  66 <a name="boost.icl.discrete_intervalconstruct-copy-destruct"></a><code class="computeroutput">discrete_interval</code>
  67         public
  68        construct/copy/destruct</h3>
  69 <div class="orderedlist"><ol type="1">
  70 <li>
  71 <pre class="literallayout"><a name="id645666-bb"></a><span class="identifier">discrete_interval</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  72 <p>Default constructor; yields an empty interval <code class="computeroutput">[0,0)</code>. </p>
  73 </li>
  74 <li>
  75 <pre class="literallayout"><span class="keyword">explicit</span> <a name="id645674-bb"></a><span class="identifier">discrete_interval</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span> val<span class="special">)</span><span class="special">;</span></pre>
  76 <p>Constructor for a closed singleton interval <code class="computeroutput">[val,val]</code> </p>
  77 </li>
  78 <li>
  79 <pre class="literallayout"><a name="id645689-bb"></a><span class="identifier">discrete_interval</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span> low<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span> up<span class="special">,</span>
  80                   <span class="identifier">interval_bounds</span> bounds <span class="special">=</span> <span class="identifier">interval_bounds</span><span class="special">::</span><span class="identifier">right_open</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
  81                   <span class="identifier">discrete_interval</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre>
  82 <p>Interval from <code class="computeroutput">low</code> to <code class="computeroutput">up</code> with bounds <code class="computeroutput">bounds</code> </p>
  83 </li>
  84 </ol></div>
  85 </div>
  86 <div class="refsect2" lang="en">
  87 <a name="id1206771"></a><h3>
  88 <a name="id645630-bb"></a><code class="computeroutput">discrete_interval</code> public member functions</h3>
  89 <div class="orderedlist"><ol type="1">
  90 <li><pre class="literallayout"><span class="keyword">typedef</span> <a name="id645632-bb"></a><span class="identifier">ICL_COMPARE_DOMAIN</span><span class="special">(</span><span class="identifier">Compare</span><span class="special">,</span> <span class="identifier">DomainT</span><span class="special">)</span><span class="special">;</span></pre></li>
  91 <li><pre class="literallayout"><span class="identifier">domain_type</span> <a name="id645648-bb"></a><span class="identifier">lower</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  92 <li><pre class="literallayout"><span class="identifier">domain_type</span> <a name="id645654-bb"></a><span class="identifier">upper</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  93 <li><pre class="literallayout"><span class="identifier">interval_bounds</span> <a name="id645660-bb"></a><span class="identifier">bounds</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  94 </ol></div>
  95 </div>
  96 <div class="refsect2" lang="en">
  97 <a name="id1206921"></a><h3>
  98 <a name="id645728-bb"></a><code class="computeroutput">discrete_interval</code> public static functions</h3>
  99 <div class="orderedlist"><ol type="1">
 100 <li><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">discrete_interval</span> <a name="id645731-bb"></a><span class="identifier">open</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span> lo<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span> up<span class="special">)</span><span class="special">;</span></pre></li>
 101 <li><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">discrete_interval</span> <a name="id645746-bb"></a><span class="identifier">right_open</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span> lo<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span> up<span class="special">)</span><span class="special">;</span></pre></li>
 102 <li><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">discrete_interval</span> <a name="id645762-bb"></a><span class="identifier">left_open</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span> lo<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span> up<span class="special">)</span><span class="special">;</span></pre></li>
 103 <li><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">discrete_interval</span> <a name="id646876-bb"></a><span class="identifier">closed</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span> lo<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DomainT</span> <span class="special">&amp;</span> up<span class="special">)</span><span class="special">;</span></pre></li>
 104 </ol></div>
 105 </div>
 106 </div>
 107 </div>
 108 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 109 <td align="left"></td>
 110 <td align="right"><div class="copyright-footer">Copyright &#169; 2007 -2010 Joachim Faulhaber<br>Copyright &#169; 1999 -2006 Cortex Software GmbH<p>
 111         Distributed under the Boost Software License, Version 1.0. (See accompanying
 112         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>)
 113       </p>
 114 </div></td>
 115 </tr></table>
 116 <hr>
 117 <div class="spirit-nav">
 118 <a accesskey="p" href="../../header/boost/icl/discrete_interval_hpp.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/icl/discrete_interval_hpp.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="interval_traits_i_id646891.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 119 </div>
 120 </body>
 121 </html>