]> git.proxmox.com Git - ceph.git/blame - ceph/src/boost/libs/icl/doc/html/boost_icl/customization.html
projects / ceph.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
bump version to 12.2.2-pve1
[ceph.git] / ceph / src / boost / libs / icl / doc / html / boost_icl / customization.html
CommitLineData
7c673cae
FG		 1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4<title>Customization</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="../index.html" title="Chapter&#160;1.&#160;Boost.Icl">
9<link rel="prev" href="interface/function_synopsis.html" title="Function Synopsis">
10<link rel="next" href="implementation.html" title="Implementation">
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="interface/function_synopsis.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="implementation.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section boost_icl_customization" lang="en">
26<div class="titlepage"><div><div><h2 class="title" style="clear: both">
27<a name="boost_icl.customization"></a><a class="link" href="customization.html" title="Customization">Customization</a>
28</h2></div></div></div>
29<div class="toc"><dl><dt><span class="section"><a href="customization.html#boost_icl.customization.intervals">Intervals</a></span></dt></dl></div>
30<div class="section boost_icl_customization_intervals" lang="en">
31<div class="titlepage"><div><div><h3 class="title">
32<a name="boost_icl.customization.intervals"></a><a class="link" href="customization.html#boost_icl.customization.intervals" title="Intervals">Intervals</a>
33</h3></div></div></div>
34<p>
35 The <span class="bold"><strong>icl</strong></span> provides the possibility of customizing
36 user defined interval class templates and class types with static interval
37 borders to be used with interval containers.
38 </p>
39<p>
40 There is a template <code class="computeroutput"><a class="link" href="../boost/icl/interval_traits.html" title="Struct template interval_traits">interval_traits</a></code>,
41 that has to be instatiated for the user defined interval type, in order to
42 provide associated types and basic functions. Bound types of the interval
43 are assigned by specializing the template <code class="computeroutput"><span class="identifier">interval_bound_type</span></code>.
44 </p>
45<div class="informaltable"><table class="table">
46<colgroup>
47<col>
48<col>
49<col>
50</colgroup>
51<thead><tr>
52<th>
53 <p>
54 Customize
55 </p>
56 </th>
57<th>
58 <p>
59 Name
60 </p>
61 </th>
62<th>
63 <p>
64 Description
65 </p>
66 </th>
67</tr></thead>
68<tbody>
69<tr>
70<td>
71 <p>
72 associated types
73 </p>
74 </td>
75<td>
76 <p>
77 <code class="computeroutput"><span class="identifier">interval_type</span></code>
78 </p>
79 </td>
80<td>
81 <p>
82 interval type of the partial specialisation for the user defined
83 type
84 </p>
85 </td>
86</tr>
87<tr>
88<td>
89 <p>
90 </p>
91 </td>
92<td>
93 <p>
94 <code class="computeroutput"><span class="identifier">domain_type</span></code>
95 </p>
96 </td>
97<td>
98 <p>
99 the domain or element type of the interval
100 </p>
101 </td>
102</tr>
103<tr>
104<td>
105 <p>
106 </p>
107 </td>
108<td>
109 <p>
110 <code class="computeroutput"><span class="identifier">domain_compare</span></code>
111 </p>
112 </td>
113<td>
114 <p>
115 the ordering on the elements
116 </p>
117 </td>
118</tr>
119<tr>
120<td>
121 <p>
122 basic functions
123 </p>
124 </td>
125<td>
126 <p>
127 <code class="computeroutput"><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="keyword">const</span>
128 <span class="identifier">domain_type</span><span class="special">&amp;)</span></code>
129 </p>
130 </td>
131<td>
132 <p>
133 construct an interval
134 </p>
135 </td>
136</tr>
137<tr>
138<td>
139 <p>
140 </p>
141 </td>
142<td>
143 <p>
144 <code class="computeroutput"><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></code>
145 </p>
146 </td>
147<td>
148 <p>
149 select the interval's lower bound
150 </p>
151 </td>
152</tr>
153<tr>
154<td>
155 <p>
156 </p>
157 </td>
158<td>
159 <p>
160 <code class="computeroutput"><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></code>
161 </p>
162 </td>
163<td>
164 <p>
165 select the interval's upper bound
166 </p>
167 </td>
168</tr>
169<tr>
170<td>
171 <p>
172 interval bounds
173 </p>
174 </td>
175<td>
176 <p>
177 <code class="computeroutput"><span class="identifier">interval_bound_type</span><span class="special">&lt;</span><span class="identifier">interval_type</span><span class="special">&gt;{...}</span></code>
178 </p>
179 </td>
180<td>
181 <p>
182 specialize meta function <code class="computeroutput"><span class="identifier">interval_bound_type</span></code>
183 to assign one of the 4 bound types to the user defined interval.
184 </p>
185 </td>
186</tr>
187</tbody>
188</table></div>
189<p>
190 How to do the customization in detail is shown in example <a class="link" href="examples/custom_interval.html" title="Custom interval">custom
191 interval</a>.
192 </p>
193</div>
194</div>
195<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
196<td align="left"></td>
197<td align="right"><div class="copyright-footer">Copyright &#169; 2007 -2010 Joachim Faulhaber<br>Copyright &#169; 1999 -2006 Cortex Software GmbH<p>
198 Distributed under the Boost Software License, Version 1.0. (See accompanying
199 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>)
200 </p>
201</div></td>
202</tr></table>
203<hr>
204<div class="spirit-nav">
205<a accesskey="p" href="interface/function_synopsis.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="implementation.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
206</div>
207</body>
208</html>
Ceph