Home Explore Help
Register Sign In
devn00b
/
EQ2EMu
9
3
Fork 0
Files Issues 59
Tree: 955f90a55d
Branches Tags
EQ2EMu
/
EQ2
/
source
/
depends
/
boost_1_72_0
/
libs
/
icl
/
doc
/
html
/
boost_icl
/
function_reference
/
key_types.html

key_types.html 14 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200 
  1. <html>
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
    4. 

  4. <title>Key Types</title>
    5. 

  5. <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
    7. 

  7. <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Icl">
    8. 

  8. <link rel="up" href="../function_reference.html" title="Function Reference">
    9. 

  9. <link rel="prev" href="segmentational_fineness.html" title="Segmentational Fineness">
    10. 

  10. <link rel="next" href="construct__copy__destruct.html" title="Construct, copy, destruct">
    11. 

  11. </head>
    12. 

  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    13. 

  13. <table cellpadding="2" width="100%"><tr>
    14. 

  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
    15. 

  15. <td align="center"><a href="../../../../../../index.html">Home</a></td>
    16. 

  16. <td align="center"><a href="../../../../../libraries.htm">Libraries</a></td>
    17. 

  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
    18. 

  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
    19. 

  19. <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
    20. 

  20. </tr></table>
    21. 

  21. <hr>
    22. 

  22. <div class="spirit-nav">
    23. 

  23. <a accesskey="p" href="segmentational_fineness.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../function_reference.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="construct__copy__destruct.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
    24. 

  24. </div>
    25. 

  25. <div class="section">
    26. 

  26. <div class="titlepage"><div><div><h3 class="title">
    27. 

  27. <a name="boost_icl.function_reference.key_types"></a><a class="link" href="key_types.html" title="Key Types">Key Types</a>
    28. 

  28. </h3></div></div></div>
    29. 

  29. <p>
    30. 

  30.         In an <span class="bold"><strong>stl</strong></span> map <code class="computeroutput"><span class="identifier">map</span><span class="special">&lt;</span><span class="identifier">K</span><span class="special">,</span><span class="identifier">D</span><span class="special">&gt;</span></code> the
    31. 

  31.         first parameter type of the map template <code class="computeroutput"><span class="identifier">K</span></code>
    32. 

  32.         is called <code class="computeroutput"><span class="identifier">key_type</span></code>. It allows
    33. 

  33.         to select key-value pairs pairs via <code class="computeroutput"><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">K</span><span class="special">&amp;)</span></code> and to remove key-value pairs using
    34. 

  34.         <code class="computeroutput"><span class="identifier">erase</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">K</span><span class="special">&amp;)</span></code>. For icl Maps we have generalized key
    35. 

  35.         types to a larger set of types. Not only the <code class="computeroutput"><span class="identifier">key_type</span></code>
    36. 

  36.         (<code class="computeroutput"><span class="identifier">domain_type</span></code>) but also an
    37. 

  37.         interval type and a set type can be <span class="emphasis"><em><span class="bold"><strong>key types</strong></span></em></span>,
    38. 

  38.         that allow for <span class="emphasis"><em><span class="bold"><strong>selection</strong></span></em></span>
    39. 

  39.         and <span class="emphasis"><em><span class="bold"><strong>removal</strong></span></em></span> of map
    40. 

  40.         elements segments and submaps.
    41. 

  41.       </p>
    42. 

  42. <div class="table">
    43. 

  43. <a name="boost_icl.function_reference.key_types.t0"></a><p class="title"><b>Table&#160;1.16.&#160;Selection of elements, segments and sub maps using key types</b></p>
    44. 

  44. <div class="table-contents"><table class="table" summary="Selection of elements, segments and sub maps using key types">
    45. 

  45. <colgroup>
    46. 

  46. <col>
    47. 

  47. <col>
    48. 

  48. <col>
    49. 

  49. </colgroup>
    50. 

  50. <thead><tr>
    51. 

  51. <th>
    52. 

  52.               </th>
    53. 

  53. <th>
    54. 

  54.                 <p>
    55. 

  55.                   <a class="link" href="../interface/function_synopsis.html#interval_map_types"><span class="bold"><strong>M</strong></span></a>:
    56. 

  56.                   <code class="computeroutput"><a class="link" href="../../boost/icl/interval_map.html" title="Class template interval_map">interval_maps</a></code>
    57. 

  57.                 </p>
    58. 

  58.               </th>
    59. 

  59. <th>
    60. 

  60.                 <p>
    61. 

  61.                   <a class="link" href="../interface/function_synopsis.html#itl_map_type"><span class="bold"><strong>m</strong></span></a>:
    62. 

  62.                   icl_map
    63. 

  63.                 </p>
    64. 

  64.               </th>
    65. 

  65. </tr></thead>
    66. 

  66. <tbody>
    67. 

  67. <tr>
    68. 

  68. <td>
    69. 

  69.                 <p>
    70. 

  70.                   <a class="link" href="../interface/function_synopsis.html#element_type"><span class="bold"><strong>e</strong></span></a>:
    71. 

  71.                   <code class="computeroutput"><span class="identifier">domain_type</span></code>
    72. 

  72.                 </p>
    73. 

  73.               </td>
    74. 

  74. <td>
    75. 

  75.                 <p>
    76. 

  76.                   key value pair
    77. 

  77.                 </p>
    78. 

  78.               </td>
    79. 

  79. <td>
    80. 

  80.                 <p>
    81. 

  81.                   key value pair
    82. 

  82.                 </p>
    83. 

  83.               </td>
    84. 

  84. </tr>
    85. 

  85. <tr>
    86. 

  86. <td>
    87. 

  87.                 <p>
    88. 

  88.                   <a class="link" href="../interface/function_synopsis.html#interval_type"><span class="bold"><strong>i</strong></span></a>:
    89. 

  89.                   <code class="computeroutput"><span class="identifier">interval_type</span></code>
    90. 

  90.                 </p>
    91. 

  91.               </td>
    92. 

  92. <td>
    93. 

  93.                 <p>
    94. 

  94.                   interval value pair
    95. 

  95.                 </p>
    96. 

  96.               </td>
    97. 

  97. <td>
    98. 

  98.               </td>
    99. 

  99. </tr>
    100. 

  100. <tr>
    101. 

  101. <td>
    102. 

  102.                 <p>
    103. 

  103.                   <a class="link" href="../interface/function_synopsis.html#interval_set_types"><span class="bold"><strong>S</strong></span></a>:
    104. 

  104.                   <code class="computeroutput"><a class="link" href="../../boost/icl/interval_set.html" title="Class template interval_set">interval_sets</a></code>
    105. 

  105.                 </p>
    106. 

  106.               </td>
    107. 

  107. <td>
    108. 

  108.                 <p>
    109. 

  109.                   interval map
    110. 

  110.                 </p>
    111. 

  111.               </td>
    112. 

  112. <td>
    113. 

  113.               </td>
    114. 

  114. </tr>
    115. 

  115. <tr>
    116. 

  116. <td>
    117. 

  117.                 <p>
    118. 

  118.                   <a class="link" href="../interface/function_synopsis.html#itl_set_type"><span class="bold"><strong>s</strong></span></a>:
    119. 

  119.                   <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>
    120. 

  120.                 </p>
    121. 

  121.               </td>
    122. 

  122. <td>
    123. 

  123.               </td>
    124. 

  124. <td>
    125. 

  125.                 <p>
    126. 

  126.                   interval map
    127. 

  127.                 </p>
    128. 

  128.               </td>
    129. 

  129. </tr>
    130. 

  130. </tbody>
    131. 

  131. </table></div>
    132. 

  132. </div>
    133. 

  133. <br class="table-break"><p>
    134. 

  134.         <a class="link" href="subtraction.html" title="Subtraction"><span class="emphasis"><em><span class="bold"><strong>Subtraction</strong></span></em></span></a>, <a class="link" href="erasure.html" title="Erasure"><span class="emphasis"><em><span class="bold"><strong>erasure</strong></span></em></span></a>, <a class="link" href="intersection.html" title="Intersection"><span class="emphasis"><em><span class="bold"><strong>intersection</strong></span></em></span></a> and <a class="link" href="containedness.html" title="Containedness"><span class="emphasis"><em><span class="bold"><strong>containedness</strong></span></em></span></a> predicates can be
    135. 

  135.         used with those kinds of key types. For instance, the overload table for
    136. 

  136.         intersection
    137. 

  137.       </p>
    138. 

  138. <p>
    139. 

  139. </p>
    140. 

  140. <pre class="programlisting"><span class="comment">// overload tables for</span>
    141. 

  141. <span class="identifier">T</span><span class="special">&amp;</span> <span class="keyword">operator</span> <span class="special">&amp;=</span> <span class="special">(</span><span class="identifier">T</span><span class="special">&amp;,</span> <span class="keyword">const</span> <span class="identifier">P</span><span class="special">&amp;)</span>
    142. 

  142. 

  143. <span class="identifier">element</span> <span class="identifier">containers</span><span class="special">:</span>     <span class="identifier">interval</span> <span class="identifier">containers</span><span class="special">:</span>
    144. 

  144. <span class="special">&amp;=</span> <span class="special">|</span> <span class="identifier">e</span> <span class="identifier">b</span> <span class="identifier">s</span> <span class="identifier">m</span>            <span class="special">&amp;=</span> <span class="special">|</span> <span class="identifier">e</span> <span class="identifier">i</span> <span class="identifier">b</span> <span class="identifier">p</span> <span class="identifier">S</span> <span class="identifier">M</span>
    145. 

  145. <span class="special">---+--------</span>            <span class="special">---+------------</span>
    146. 

  146. <span class="identifier">s</span>  <span class="special">|</span> <span class="identifier">s</span>   <span class="identifier">s</span>              <span class="identifier">S</span>  <span class="special">|</span> <span class="identifier">S</span> <span class="identifier">S</span>     <span class="identifier">S</span>
    147. 

  147. <span class="identifier">m</span>  <span class="special">|</span> <span class="identifier">m</span> <span class="identifier">m</span> <span class="identifier">m</span> <span class="identifier">m</span>            <span class="identifier">M</span>  <span class="special">|</span> <span class="identifier">M</span> <span class="identifier">M</span> <span class="identifier">M</span> <span class="identifier">M</span> <span class="identifier">M</span> <span class="identifier">M</span>
    148. 

  148. </pre>
    149. 

  149. <p>
    150. 

  150.       </p>
    151. 

  151. <p>
    152. 

  152.         has a part that that allows for selection by key objects
    153. 

  153.       </p>
    154. 

  154. <p>
    155. 

  155. </p>
    156. 

  156. <pre class="programlisting"><span class="identifier">element</span> <span class="identifier">containers</span><span class="special">:</span>     <span class="identifier">interval</span> <span class="identifier">containers</span><span class="special">:</span>
    157. 

  157. <span class="special">&amp;=</span> <span class="special">|</span> <span class="identifier">e</span> <span class="identifier">b</span> <span class="identifier">s</span> <span class="identifier">m</span>            <span class="special">&amp;=</span> <span class="special">|</span> <span class="identifier">e</span> <span class="identifier">i</span> <span class="identifier">b</span> <span class="identifier">p</span> <span class="identifier">S</span> <span class="identifier">M</span>
    158. 

  158. <span class="special">---+--------</span>            <span class="special">---+------------</span>
    159. 

  159. <span class="identifier">s</span>  <span class="special">|</span> <span class="identifier">s</span>   <span class="identifier">s</span>              <span class="identifier">S</span>  <span class="special">|</span> <span class="identifier">S</span> <span class="identifier">S</span>     <span class="identifier">S</span>
    160. 

  160. <span class="identifier">m</span>  <span class="special">|</span> <span class="identifier">m</span>   <span class="identifier">m</span>              <span class="identifier">M</span>  <span class="special">|</span> <span class="identifier">M</span> <span class="identifier">M</span>     <span class="identifier">M</span>
    161. 

  161. </pre>
    162. 

  162. <p>
    163. 

  163.       </p>
    164. 

  164. <p>
    165. 

  165.         and another part that provides overloads for generalized intersection:
    166. 

  166.       </p>
    167. 

  167. <p>
    168. 

  168. </p>
    169. 

  169. <pre class="programlisting"><span class="identifier">element</span> <span class="identifier">containers</span><span class="special">:</span>     <span class="identifier">interval</span> <span class="identifier">containers</span><span class="special">:</span>
    170. 

  170. <span class="special">&amp;=</span> <span class="special">|</span> <span class="identifier">e</span> <span class="identifier">b</span> <span class="identifier">s</span> <span class="identifier">m</span>            <span class="special">&amp;=</span> <span class="special">|</span> <span class="identifier">e</span> <span class="identifier">i</span> <span class="identifier">b</span> <span class="identifier">p</span> <span class="identifier">S</span> <span class="identifier">M</span>
    171. 

  171. <span class="special">---+--------</span>            <span class="special">---+------------</span>
    172. 

  172. <span class="identifier">s</span>  <span class="special">|</span> <span class="identifier">s</span>   <span class="identifier">s</span>              <span class="identifier">S</span>  <span class="special">|</span> <span class="identifier">S</span> <span class="identifier">S</span>     <span class="identifier">S</span>
    173. 

  173. <span class="identifier">m</span>  <span class="special">|</span>   <span class="identifier">m</span>   <span class="identifier">m</span>            <span class="identifier">M</span>  <span class="special">|</span>     <span class="identifier">M</span> <span class="identifier">M</span>   <span class="identifier">M</span>
    174. 

  174. </pre>
    175. 

  175. <p>
    176. 

  176.       </p>
    177. 

  177. <p>
    178. 

  178.         For <code class="computeroutput"><span class="identifier">Sets</span></code>, the <span class="emphasis"><em><span class="bold"><strong>key types</strong></span></em></span> defined for maps are identical
    179. 

  179.         with the set types themselves. So the distinction between the function groups
    180. 

  180.         <span class="emphasis"><em><span class="bold"><strong>selection by key</strong></span></em></span> and
    181. 

  181.         <span class="emphasis"><em><span class="bold"><strong>generalized intersection</strong></span></em></span>
    182. 

  182.         fall together in the well known <span class="emphasis"><em><span class="bold"><strong>set intersection</strong></span></em></span>.
    183. 

  183.       </p>
    184. 

  184. </div>
    185. 

  185. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    186. 

  186. <td align="left"></td>
    187. 

  187. <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2010 Joachim
    188. 

  188.       Faulhaber<br>Copyright &#169; 1999-2006 Cortex Software
    189. 

  189.       GmbH<p>
    190. 

  190.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    191. 

  191.         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>)
    192. 

  192.       </p>
    193. 

  193. </div></td>
    194. 

  194. </tr></table>
    195. 

  195. <hr>
    196. 

  196. <div class="spirit-nav">
    197. 

  197. <a accesskey="p" href="segmentational_fineness.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../function_reference.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="construct__copy__destruct.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
    198. 

  198. </div>
    199. 

  199. </body>
    200. 

  200. </html>
    201.