concepts.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179
  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.79.1">
  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">
  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 class="toc">
  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">
  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. </td>
  70. <td>
  71. <p>
  72. <code class="computeroutput"><span class="identifier">Set</span></code>
  73. </p>
  74. </td>
  75. <td>
  76. <p>
  77. <code class="computeroutput"><span class="identifier">Map</span></code>
  78. </p>
  79. </td>
  80. </tr>
  81. <tr>
  82. <td>
  83. <p>
  84. element container
  85. </p>
  86. </td>
  87. <td>
  88. <p>
  89. <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>
  90. </p>
  91. </td>
  92. <td>
  93. <p>
  94. <code class="computeroutput"><a class="link" href="../boost/icl/map.html" title="Class template map">icl::map</a></code>
  95. </p>
  96. </td>
  97. </tr>
  98. <tr>
  99. <td>
  100. <p>
  101. interval container
  102. </p>
  103. </td>
  104. <td>
  105. <p>
  106. <code class="computeroutput"><a class="link" href="../boost/icl/interval_set.html" title="Class template interval_set">interval_set</a></code>,
  107. <code class="computeroutput"><a class="link" href="../boost/icl/separate_interval_set.html" title="Class template separate_interval_set">separate_interval_set</a></code>,
  108. <code class="computeroutput"><a class="link" href="../boost/icl/split_interval_set.html" title="Class template split_interval_set">split_interval_set</a></code>
  109. </p>
  110. </td>
  111. <td>
  112. <p>
  113. <code class="computeroutput"><a class="link" href="../boost/icl/interval_map.html" title="Class template interval_map">interval_map</a></code>,
  114. <code class="computeroutput"><a class="link" href="../boost/icl/split_interval_map.html" title="Class template split_interval_map">split_interval_map</a></code>
  115. </p>
  116. </td>
  117. </tr>
  118. </tbody>
  119. </table></div>
  120. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  121. <li class="listitem">
  122. Containers std:set, <code class="computeroutput"><a class="link" href="../boost/icl/interval_set.html" title="Class template interval_set">interval_set</a></code>,
  123. <code class="computeroutput"><a class="link" href="../boost/icl/separate_interval_set.html" title="Class template separate_interval_set">separate_interval_set</a></code>,
  124. <code class="computeroutput"><a class="link" href="../boost/icl/split_interval_set.html" title="Class template split_interval_set">split_interval_set</a></code>
  125. are models of concept <code class="computeroutput"><span class="identifier">Set</span></code>.
  126. </li>
  127. <li class="listitem">
  128. 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>
  129. are models of concept <code class="computeroutput"><span class="identifier">Map</span></code>.
  130. </li>
  131. <li class="listitem">
  132. Containers that are <span class="emphasis"><em><span class="bold"><strong>implemented</strong></span></em></span>
  133. using elements or element value pairs are called <span class="emphasis"><em><span class="bold"><strong>element containers</strong></span></em></span>.
  134. </li>
  135. <li class="listitem">
  136. Containers that are <span class="emphasis"><em><span class="bold"><strong>implemented</strong></span></em></span>
  137. using intervals or interval value pairs (also called segments) are called
  138. <span class="emphasis"><em><span class="bold"><strong>interval containers</strong></span></em></span>.
  139. </li>
  140. <li class="listitem">
  141. When we talk about <code class="computeroutput"><span class="identifier">Sets</span></code>
  142. or <code class="computeroutput"><span class="identifier">Maps</span></code> we abstract from
  143. the way they are implemented.
  144. </li>
  145. <li class="listitem">
  146. When we talk about <span class="emphasis"><em>element containers</em></span> or <span class="emphasis"><em>interval
  147. containers</em></span> we refer to the way they are implemented.
  148. </li>
  149. <li class="listitem">
  150. <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
  151. <code class="computeroutput"><span class="identifier">Set</span></code> concept.
  152. </li>
  153. <li class="listitem">
  154. <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> a model of the icl's <code class="computeroutput"><span class="identifier">Map</span></code> concept.
  155. </li>
  156. <li class="listitem">
  157. The <span class="bold"><strong>icl's</strong></span> element map is always denoted
  158. qualified as <code class="computeroutput"><a class="link" href="../boost/icl/map.html" title="Class template map">icl::map</a></code> to
  159. avoid confusion with<code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span></code>.
  160. </li>
  161. </ul></div>
  162. </div>
  163. </div>
  164. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  165. <td align="left"></td>
  166. <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2010 Joachim
  167. Faulhaber<br>Copyright &#169; 1999-2006 Cortex Software
  168. GmbH<p>
  169. Distributed under the Boost Software License, Version 1.0. (See accompanying
  170. 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>)
  171. </p>
  172. </div></td>
  173. </tr></table>
  174. <hr>
  175. <div class="spirit-nav">
  176. <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>
  177. </div>
  178. </body>
  179. </html>