• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>Custom interval</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 1. Boost.Icl">
8<link rel="up" href="../examples.html" title="Examples">
9<link rel="prev" href="std_transform.html" title="Std transform">
10<link rel="next" href="../projects.html" title="Projects">
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="std_transform.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../examples.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="../projects.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h3 class="title">
27<a name="boost_icl.examples.custom_interval"></a><a class="link" href="custom_interval.html" title="Custom interval">Custom interval</a>
28</h3></div></div></div>
29<p>
30        Example <span class="bold"><strong>custom interval</strong></span> demonstrates how
31        to use interval containers with an own interval class type.
32      </p>
33<p>
34</p>
35<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
36<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">icl</span><span class="special">/</span><span class="identifier">interval_set</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
37
38<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">std</span><span class="special">;</span>
39<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">icl</span><span class="special">;</span>
40
41<span class="comment">// Here is a typical class that may model intervals in your application.</span>
42<span class="keyword">class</span> <span class="identifier">MyInterval</span>
43<span class="special">{</span>
44<span class="keyword">public</span><span class="special">:</span>
45    <span class="identifier">MyInterval</span><span class="special">():</span> <span class="identifier">_first</span><span class="special">(),</span> <span class="identifier">_past</span><span class="special">(){}</span>
46    <span class="identifier">MyInterval</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">lo</span><span class="special">,</span> <span class="keyword">int</span> <span class="identifier">up</span><span class="special">):</span> <span class="identifier">_first</span><span class="special">(</span><span class="identifier">lo</span><span class="special">),</span> <span class="identifier">_past</span><span class="special">(</span><span class="identifier">up</span><span class="special">){}</span>
47    <span class="keyword">int</span> <span class="identifier">first</span><span class="special">()</span><span class="keyword">const</span><span class="special">{</span> <span class="keyword">return</span> <span class="identifier">_first</span><span class="special">;</span> <span class="special">}</span>
48    <span class="keyword">int</span> <span class="identifier">past</span> <span class="special">()</span><span class="keyword">const</span><span class="special">{</span> <span class="keyword">return</span> <span class="identifier">_past</span><span class="special">;</span> <span class="special">}</span>
49<span class="keyword">private</span><span class="special">:</span>
50    <span class="keyword">int</span> <span class="identifier">_first</span><span class="special">,</span> <span class="identifier">_past</span><span class="special">;</span>
51<span class="special">};</span>
52
53<span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">icl</span>
54<span class="special">{</span>
55<span class="comment">// Class template interval_traits serves as adapter to register and customize your interval class</span>
56<span class="keyword">template</span><span class="special">&lt;&gt;</span>
57<span class="keyword">struct</span> <span class="identifier">interval_traits</span><span class="special">&lt;</span> <span class="identifier">MyInterval</span> <span class="special">&gt;</span>       <span class="comment">//1.  Partially specialize interval_traits for </span>
58<span class="special">{</span>                                          <span class="comment">//    your class MyInterval</span>
59                                           <span class="comment">//2.  Define associated types</span>
60    <span class="keyword">typedef</span> <span class="identifier">MyInterval</span>     <span class="identifier">interval_type</span><span class="special">;</span>  <span class="comment">//2.1 MyInterval will be the interval_type</span>
61    <span class="keyword">typedef</span> <span class="keyword">int</span>            <span class="identifier">domain_type</span><span class="special">;</span>    <span class="comment">//2.2 The elements of the domain are ints </span>
62    <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">less</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">domain_compare</span><span class="special">;</span> <span class="comment">//2.3 This is the way our element shall be ordered.</span>
63                                           <span class="comment">//3.  Next we define the essential functions </span>
64                                           <span class="comment">//    of the specialisation</span>
65                                           <span class="comment">//3.1 Construction of intervals</span>
66    <span class="keyword">static</span> <span class="identifier">interval_type</span> <span class="identifier">construct</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">domain_type</span><span class="special">&amp;</span> <span class="identifier">lo</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">domain_type</span><span class="special">&amp;</span> <span class="identifier">up</span><span class="special">)</span>
67    <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">interval_type</span><span class="special">(</span><span class="identifier">lo</span><span class="special">,</span> <span class="identifier">up</span><span class="special">);</span> <span class="special">}</span>
68                                           <span class="comment">//3.2 Selection of values </span>
69    <span class="keyword">static</span> <span class="identifier">domain_type</span> <span class="identifier">lower</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">interval_type</span><span class="special">&amp;</span> <span class="identifier">inter_val</span><span class="special">){</span> <span class="keyword">return</span> <span class="identifier">inter_val</span><span class="special">.</span><span class="identifier">first</span><span class="special">();</span> <span class="special">};</span>
70    <span class="keyword">static</span> <span class="identifier">domain_type</span> <span class="identifier">upper</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">interval_type</span><span class="special">&amp;</span> <span class="identifier">inter_val</span><span class="special">){</span> <span class="keyword">return</span> <span class="identifier">inter_val</span><span class="special">.</span><span class="identifier">past</span><span class="special">();</span> <span class="special">};</span>
71<span class="special">};</span>
72
73<span class="keyword">template</span><span class="special">&lt;&gt;</span>
74<span class="keyword">struct</span> <span class="identifier">interval_bound_type</span><span class="special">&lt;</span><span class="identifier">MyInterval</span><span class="special">&gt;</span>     <span class="comment">//4.  Finally we define the interval borders.</span>
75<span class="special">{</span>                                          <span class="comment">//    Choose between static_open         (lo..up)</span>
76    <span class="keyword">typedef</span> <span class="identifier">interval_bound_type</span> <span class="identifier">type</span><span class="special">;</span>      <span class="comment">//                   static_left_open    (lo..up]</span>
77    <span class="identifier">BOOST_STATIC_CONSTANT</span><span class="special">(</span><span class="identifier">bound_type</span><span class="special">,</span> <span class="identifier">value</span> <span class="special">=</span> <span class="identifier">interval_bounds</span><span class="special">::</span><span class="identifier">static_right_open</span><span class="special">);</span>
78<span class="special">};</span>                                         <span class="comment">//               and static_closed       [lo..up] </span>
79
80<span class="special">}}</span> <span class="comment">// namespace boost icl</span>
81
82<span class="keyword">void</span> <span class="identifier">custom_interval</span><span class="special">()</span>
83<span class="special">{</span>
84    <span class="comment">// Now we can use class MyInterval with interval containers:</span>
85    <span class="keyword">typedef</span> <span class="identifier">interval_set</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">less</span><span class="special">,</span> <span class="identifier">MyInterval</span><span class="special">&gt;</span> <span class="identifier">MyIntervalSet</span><span class="special">;</span>
86    <span class="identifier">MyIntervalSet</span> <span class="identifier">mySet</span><span class="special">;</span>
87    <span class="identifier">mySet</span> <span class="special">+=</span> <span class="identifier">MyInterval</span><span class="special">(</span><span class="number">1</span><span class="special">,</span><span class="number">9</span><span class="special">);</span>
88    <span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">mySet</span> <span class="special">&lt;&lt;</span> <span class="identifier">endl</span><span class="special">;</span>
89    <span class="identifier">mySet</span><span class="special">.</span><span class="identifier">subtract</span><span class="special">(</span><span class="number">3</span><span class="special">)</span> <span class="special">-=</span> <span class="number">6</span><span class="special">;</span>
90    <span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">mySet</span> <span class="special">&lt;&lt;</span> <span class="string">"            subtracted 3 and 6\n"</span><span class="special">;</span>
91    <span class="identifier">mySet</span> <span class="special">^=</span> <span class="identifier">MyInterval</span><span class="special">(</span><span class="number">2</span><span class="special">,</span><span class="number">8</span><span class="special">);</span>
92    <span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">mySet</span> <span class="special">&lt;&lt;</span>      <span class="string">"  flipped between 2 and 7\n"</span><span class="special">;</span>
93<span class="special">}</span>
94
95
96<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
97<span class="special">{</span>
98    <span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"&gt;&gt;Interval Container Library: Sample custom_interval.cpp &lt;&lt;\n"</span><span class="special">;</span>
99    <span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"-----------------------------------------------------------\n"</span><span class="special">;</span>
100    <span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"This program uses a user defined interval class:\n"</span><span class="special">;</span>
101    <span class="identifier">custom_interval</span><span class="special">();</span>
102    <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
103<span class="special">}</span>
104
105<span class="comment">// Program output:</span>
106<span class="comment">/*-----------------------------------------------------------------------------
107&gt;&gt;Interval Container Library: Sample custom_interval.cpp &lt;&lt;
108-----------------------------------------------------------
109This program uses a user defined interval class:
110{[1,                      9)}
111{[1,  3)   [4,  6)   [7,  9)}       subtracted 3 and 6
112{[1,2) [3,4)     [6,7) [8,9)}  flipped between 2 and 7
113-----------------------------------------------------------------------------*/</span>
114</pre>
115<p>
116      </p>
117</div>
118<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
119<td align="left"></td>
120<td align="right"><div class="copyright-footer">Copyright © 2007-2010 Joachim
121      Faulhaber<br>Copyright © 1999-2006 Cortex Software
122      GmbH<p>
123        Distributed under the Boost Software License, Version 1.0. (See accompanying
124        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>)
125      </p>
126</div></td>
127</tr></table>
128<hr>
129<div class="spirit-nav">
130<a accesskey="p" href="std_transform.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../examples.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="../projects.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
131</div>
132</body>
133</html>
134