ceph/src/boost/libs/icl/doc/html/boost_icl/concepts.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Concepts</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="projects.html" title="Projects">
  10 <link rel="next" href="concepts/aspects.html" title="Aspects">
  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="projects.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="concepts/aspects.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section boost_icl_concepts" lang="en">
  26 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  27 <a name="boost_icl.concepts"></a><a class="link" href="concepts.html" title="Concepts">Concepts</a>
  28 </h2></div></div></div>
  29 <div class="toc"><dl>
  30 <dt><span class="section"><a href="concepts.html#boost_icl.concepts.naming">Naming</a></span></dt>
  31 <dt><span class="section"><a href="concepts/aspects.html">Aspects</a></span></dt>
  32 <dt><span class="section"><a href="concepts/sets_and_maps.html">Sets and Maps</a></span></dt>
  33 <dt><span class="section"><a href="concepts/aggrovering.html"> Addability, Subtractability
  34       and Aggregate on Overlap</a></span></dt>
  35 <dt><span class="section"><a href="concepts/map_traits.html">Map Traits</a></span></dt>
  36 </dl></div>
  37 <div class="section boost_icl_concepts_naming" lang="en">
  38 <div class="titlepage"><div><div><h3 class="title">
  39 <a name="boost_icl.concepts.naming"></a><a class="link" href="concepts.html#boost_icl.concepts.naming" title="Naming">Naming</a>
  40 </h3></div></div></div>
  41 <p>
  42         The <span class="bold"><strong>icl</strong></span> is about sets and maps and a useful
  43         implementation of sets and maps using intervals. In the documentation of
  44         the <span class="bold"><strong>icl</strong></span> the different set and map types
  45         are grouped in various ways. In order to distinguish those groups we use
  46         a naming convention.
  47       </p>
  48 <p>
  49         Names of concepts start with a capital letter. So <code class="computeroutput"><span class="identifier">Set</span></code>
  50         and <code class="computeroutput"><span class="identifier">Map</span></code> stand for the <span class="emphasis"><em>concept</em></span>
  51         of a set and a map as defined in the <span class="bold"><strong>icl</strong></span>.
  52         When we talk about <code class="computeroutput"><span class="identifier">Sets</span></code> and
  53         <code class="computeroutput"><span class="identifier">Maps</span></code> though, most of the
  54         time we do not not talk about the concepts themselves but the set of types
  55         that implement those concepts in the <span class="bold"><strong>icl</strong></span>.
  56         The main groups, <span class="emphasis"><em><span class="bold"><strong>icl containers</strong></span></em></span>
  57         can be divided in, are summarized in the next table:
  58       </p>
  59 <div class="informaltable"><table class="table">
  60 <colgroup>
  61 <col>
  62 <col>
  63 <col>
  64 </colgroup>
  65 <thead><tr></tr></thead>
  66 <tbody>
  67 <tr>
  68 <td>
  69               <p>
  70               </p>
  71               </td>
  72 <td>
  73               <p>
  74                 <code class="computeroutput"><span class="identifier">Set</span></code>
  75               </p>
  76               </td>
  77 <td>
  78               <p>
  79                 <code class="computeroutput"><span class="identifier">Map</span></code>
  80               </p>
  81               </td>
  82 </tr>
  83 <tr>
  84 <td>
  85               <p>
  86                 element container
  87               </p>
  88               </td>
  89 <td>
  90               <p>
  91                 <a href="http://www.cplusplus.com/reference/stl/set/" target="_top"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code> </a>
  92               </p>
  93               </td>
  94 <td>
  95               <p>
  96                 <code class="computeroutput"><a class="link" href="../boost/icl/map.html" title="Class template map">icl::map</a></code>
  97               </p>
  98               </td>
  99 </tr>
 100 <tr>
 101 <td>
 102               <p>
 103                 interval container
 104               </p>
 105               </td>
 106 <td>
 107               <p>
 108                 <code class="computeroutput"><a class="link" href="../boost/icl/interval_set.html" title="Class template interval_set">interval_set</a></code>,
 109                 <code class="computeroutput"><a class="link" href="../boost/icl/separate_interval_set.html" title="Class template separate_interval_set">separate_interval_set</a></code>,
 110                 <code class="computeroutput"><a class="link" href="../boost/icl/split_interval_set.html" title="Class template split_interval_set">split_interval_set</a></code>
 111               </p>
 112               </td>
 113 <td>
 114               <p>
 115                 <code class="computeroutput"><a class="link" href="../boost/icl/interval_map.html" title="Class template interval_map">interval_map</a></code>,
 116                 <code class="computeroutput"><a class="link" href="../boost/icl/split_interval_map.html" title="Class template split_interval_map">split_interval_map</a></code>
 117               </p>
 118               </td>
 119 </tr>
 120 </tbody>
 121 </table></div>
 122 <div class="itemizedlist"><ul type="disc">
 123 <li>
 124           Containers std:set, <code class="computeroutput"><a class="link" href="../boost/icl/interval_set.html" title="Class template interval_set">interval_set</a></code>,
 125           <code class="computeroutput"><a class="link" href="../boost/icl/separate_interval_set.html" title="Class template separate_interval_set">separate_interval_set</a></code>,
 126           <code class="computeroutput"><a class="link" href="../boost/icl/split_interval_set.html" title="Class template split_interval_set">split_interval_set</a></code>
 127           are models of concept <code class="computeroutput"><span class="identifier">Set</span></code>.
 128         </li>
 129 <li>
 130           Containers <code class="computeroutput"><a class="link" href="../boost/icl/map.html" title="Class template map">icl::map</a></code>, <code class="computeroutput"><a class="link" href="../boost/icl/interval_map.html" title="Class template interval_map">interval_map</a></code>, <code class="computeroutput"><a class="link" href="../boost/icl/split_interval_map.html" title="Class template split_interval_map">split_interval_map</a></code>
 131           are models of concept <code class="computeroutput"><span class="identifier">Map</span></code>.
 132         </li>
 133 <li>
 134           Containers that are <span class="emphasis"><em><span class="bold"><strong>implemented</strong></span></em></span>
 135           using elements or element value pairs are called <span class="emphasis"><em><span class="bold"><strong>element
 136           containers</strong></span></em></span>.
 137         </li>
 138 <li>
 139           Containers that are <span class="emphasis"><em><span class="bold"><strong>implemented</strong></span></em></span>
 140           using intervals or interval value pairs (also called segments) are called
 141           <span class="emphasis"><em><span class="bold"><strong>interval containers</strong></span></em></span>.
 142         </li>
 143 <li>
 144           When we talk about <code class="computeroutput"><span class="identifier">Sets</span></code>
 145           or <code class="computeroutput"><span class="identifier">Maps</span></code> we abstract from
 146           the way they are implemented.
 147         </li>
 148 <li>
 149           When we talk about <span class="emphasis"><em>element containers</em></span> or <span class="emphasis"><em>interval
 150           containers</em></span> we refer to the way they are implemented.
 151         </li>
 152 <li>
 153 <a href="http://www.cplusplus.com/reference/stl/set/" target="_top"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code> </a> is a model of the icl's
 154           <code class="computeroutput"><span class="identifier">Set</span></code> concept.
 155         </li>
 156 <li>
 157 <a href="http://www.cplusplus.com/reference/stl/set/" target="_top"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span></code> </a> is <span class="emphasis"><em><span class="bold"><strong>not</strong></span></em></span>
 158           a model of the icl's <code class="computeroutput"><span class="identifier">Map</span></code>
 159           concept.
 160         </li>
 161 <li>
 162           The <span class="bold"><strong>icl's</strong></span> element map is always denoted
 163           qualified as <code class="computeroutput"><a class="link" href="../boost/icl/map.html" title="Class template map">icl::map</a></code> to avoid
 164           confusion with<code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span></code>.
 165         </li>
 166 </ul></div>
 167 </div>
 168 </div>
 169 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 170 <td align="left"></td>
 171 <td align="right"><div class="copyright-footer">Copyright &#169; 2007 -2010 Joachim Faulhaber<br>Copyright &#169; 1999 -2006 Cortex Software GmbH<p>
 172         Distributed under the Boost Software License, Version 1.0. (See accompanying
 173         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>)
 174       </p>
 175 </div></td>
 176 </tr></table>
 177 <hr>
 178 <div class="spirit-nav">
 179 <a accesskey="p" href="projects.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="concepts/aspects.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 180 </div>
 181 </body>
 182 </html>