Accueil Explorer Aide
S'inscrire Connexion
devn00b
/
EQ2EMu
9
3
Fork 0
Fichiers Tickets 59
Aborescence: 206dc6819b
Branches Tags
EQ2EMu
/
EQ2
/
source
/
depends
/
boost_1_72_0
/
libs
/
bimap
/
doc
/
html
/
boost_bimap
/
the_tutorial
/
complete_instantiation_scheme.html

complete_instantiation_scheme.html 16 KB
Historique Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240 
  1. <html>
    2. 

  2. <head>
    3. 

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

  4. <title>Complete instantiation scheme</title>
    5. 

  5. <link rel="stylesheet" href="../../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.Bimap">
    8. 

  8. <link rel="up" href="../the_tutorial.html" title="The tutorial">
    9. 

  9. <link rel="prev" href="additional_information.html" title="Additional information">
    10. 

  10. <link rel="next" href="../bimap_and_boost.html" title="Bimap and Boost">
    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="../../../../../../libs/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="additional_information.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../the_tutorial.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="../bimap_and_boost.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_bimap.the_tutorial.complete_instantiation_scheme"></a><a class="link" href="complete_instantiation_scheme.html" title="Complete instantiation scheme">Complete
    28. 

  28.       instantiation scheme</a>
    29. 

  29. </h3></div></div></div>
    30. 

  30. <p>
    31. 

  31.         To summarize, this is the complete instantiation scheme.
    32. 

  32.       </p>
    33. 

  33. <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">bimap</span>
    34. 

  34. <span class="special">&lt;</span>
    35. 

  35.     <span class="identifier">LeftCollectionType</span><span class="special">,</span> <span class="identifier">RightCollectionType</span>
    36. 

  36. 

  37.     <span class="special">[</span> <span class="special">,</span> <span class="identifier">SetTypeOfRelation</span>  <span class="special">]</span>  <span class="comment">// Default to left_based</span>
    38. 

  38.     <span class="special">[</span> <span class="special">,</span> <span class="identifier">with_info</span><span class="special">&lt;</span> <span class="identifier">Info</span> <span class="special">&gt;</span>  <span class="special">]</span>  <span class="comment">// Default to no info</span>
    39. 

  39.     <span class="special">[</span> <span class="special">,</span> <span class="identifier">Allocator</span>          <span class="special">]</span>  <span class="comment">// Default to std::allocator&lt;&gt;</span>
    40. 

  40. 

  41. <span class="special">&gt;</span> <span class="identifier">bm</span><span class="special">;</span>
    42. 

  42. </pre>
    43. 

  43. <p>
    44. 

  44.         <code class="computeroutput"><span class="special">{</span><span class="identifier">Side</span><span class="special">}</span><span class="identifier">CollectionType</span></code>
    45. 

  45.         can directly be a type. This defaults to <code class="computeroutput"><span class="identifier">set_of</span><span class="special">&lt;</span><span class="identifier">Type</span><span class="special">&gt;</span></code>, or can be a <code class="computeroutput"><span class="special">{</span><span class="identifier">CollectionType</span><span class="special">}</span><span class="identifier">_of</span><span class="special">&lt;</span><span class="identifier">Type</span><span class="special">&gt;</span></code>
    46. 

  46.         specification. Additionally, the type of this two parameters can be tagged
    47. 

  47.         to specify user defined names instead of the usual <code class="computeroutput"><span class="identifier">member_at</span><span class="special">::-</span><span class="identifier">Side</span><span class="special">-</span></code> tags.
    48. 

  48.       </p>
    49. 

  49. <p>
    50. 

  50.         The possible way to use the first parameter are:
    51. 

  51.       </p>
    52. 

  52. <pre class="programlisting"><span class="identifier">bimap</span><span class="special">&lt;</span> <span class="identifier">Type</span><span class="special">,</span> <span class="identifier">R</span> <span class="special">&gt;</span>
    53. 

  53. </pre>
    54. 

  54. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    55. 

  55. <li class="listitem">
    56. 

  56.             Left type: <code class="computeroutput"><span class="identifier">Type</span></code>
    57. 

  57.           </li>
    58. 

  58. <li class="listitem">
    59. 

  59.             Left collection type: <code class="computeroutput"><span class="identifier">set_of</span><span class="special">&lt;</span> <span class="identifier">Type</span>
    60. 

  60.             <span class="special">&gt;</span></code>
    61. 

  61.           </li>
    62. 

  62. <li class="listitem">
    63. 

  63.             Left tag: <code class="computeroutput"><span class="identifier">member_at</span><span class="special">::</span><span class="identifier">left</span></code>
    64. 

  64.           </li>
    65. 

  65. </ul></div>
    66. 

  66. <pre class="programlisting"><span class="identifier">bimap</span><span class="special">&lt;</span> <span class="special">{</span><span class="identifier">CollectionType</span><span class="special">}</span><span class="identifier">_of</span><span class="special">&lt;</span> <span class="identifier">Type</span> <span class="special">&gt;,</span> <span class="identifier">R</span> <span class="special">&gt;</span>
    67. 

  67. </pre>
    68. 

  68. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    69. 

  69. <li class="listitem">
    70. 

  70.             Left type: <code class="computeroutput"><span class="identifier">Type</span></code>
    71. 

  71.           </li>
    72. 

  72. <li class="listitem">
    73. 

  73.             Left collection type: <code class="computeroutput"><span class="special">{</span><span class="identifier">CollectionType</span><span class="special">}</span><span class="identifier">_of</span><span class="special">&lt;</span> <span class="identifier">LeftType</span> <span class="special">&gt;</span></code>
    74. 

  74.           </li>
    75. 

  75. <li class="listitem">
    76. 

  76.             Left tag: <code class="computeroutput"><span class="identifier">member_at</span><span class="special">::</span><span class="identifier">left</span></code>
    77. 

  77.           </li>
    78. 

  78. </ul></div>
    79. 

  79. <pre class="programlisting"><span class="identifier">bimap</span><span class="special">&lt;</span> <span class="identifier">tagged</span><span class="special">&lt;</span> <span class="identifier">Type</span><span class="special">,</span> <span class="identifier">Tag</span> <span class="special">&gt;,</span> <span class="identifier">R</span> <span class="special">&gt;</span>
    80. 

  80. </pre>
    81. 

  81. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    82. 

  82. <li class="listitem">
    83. 

  83.             Left type: <code class="computeroutput"><span class="identifier">Type</span></code>
    84. 

  84.           </li>
    85. 

  85. <li class="listitem">
    86. 

  86.             Left collection type: <code class="computeroutput"><span class="identifier">set_of</span><span class="special">&lt;</span> <span class="identifier">LeftType</span>
    87. 

  87.             <span class="special">&gt;</span></code>
    88. 

  88.           </li>
    89. 

  89. <li class="listitem">
    90. 

  90.             Left tag: <code class="computeroutput"><span class="identifier">Tag</span></code>
    91. 

  91.           </li>
    92. 

  92. </ul></div>
    93. 

  93. <pre class="programlisting"><span class="identifier">bimap</span><span class="special">&lt;</span> <span class="special">{</span><span class="identifier">CollectionType</span><span class="special">}</span><span class="identifier">_of</span><span class="special">&lt;</span> <span class="identifier">tagged</span><span class="special">&lt;</span> <span class="identifier">Type</span><span class="special">,</span> <span class="identifier">Tag</span> <span class="special">&gt;</span> <span class="special">&gt;,</span> <span class="identifier">R</span> <span class="special">&gt;</span>
    94. 

  94. </pre>
    95. 

  95. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    96. 

  96. <li class="listitem">
    97. 

  97.             Left type: <code class="computeroutput"><span class="identifier">Type</span></code>
    98. 

  98.           </li>
    99. 

  99. <li class="listitem">
    100. 

  100.             Left collection type: <code class="computeroutput"><span class="special">{</span><span class="identifier">CollectionType</span><span class="special">}</span><span class="identifier">_of</span><span class="special">&lt;</span> <span class="identifier">LeftType</span> <span class="special">&gt;</span></code>
    101. 

  101.           </li>
    102. 

  102. <li class="listitem">
    103. 

  103.             Left tag: <code class="computeroutput"><span class="identifier">Tag</span></code>
    104. 

  104.           </li>
    105. 

  105. </ul></div>
    106. 

  106. <p>
    107. 

  107.         The same options are available for the second parameter.
    108. 

  108.       </p>
    109. 

  109. <p>
    110. 

  110.         The last three parameters are used to specify the collection type of the
    111. 

  111.         relation, the information member and the allocator type.
    112. 

  112.       </p>
    113. 

  113. <p>
    114. 

  114.         If you want to specify a custom allocator type while relying on the default
    115. 

  115.         value of CollectionTypeOfRelation, you can do so by simply writing <code class="computeroutput"><span class="identifier">bimap</span><span class="special">&lt;</span><span class="identifier">LeftKeyType</span><span class="special">,</span>
    116. 

  116.         <span class="identifier">RightKeyType</span><span class="special">,</span>
    117. 

  117.         <span class="identifier">Allocator</span><span class="special">&gt;</span></code>.
    118. 

  118.         Boost.Bimap's internal machinery detects that the third parameter in this
    119. 

  119.         case does not refer to the relation type but rather to an allocator.
    120. 

  120.       </p>
    121. 

  121. <p>
    122. 

  122.         The following are the possible ways of instantiating the last three parameters
    123. 

  123.         of a bimap. You can ignore some of the parameter but the order must be respected.
    124. 

  124.       </p>
    125. 

  125. <pre class="programlisting"><span class="identifier">bimap</span><span class="special">&lt;</span> <span class="identifier">L</span><span class="special">,</span> <span class="identifier">R</span> <span class="special">&gt;</span>
    126. 

  126. </pre>
    127. 

  127. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    128. 

  128. <li class="listitem">
    129. 

  129.             set_of_relation_type: based on the left key type
    130. 

  130.           </li>
    131. 

  131. <li class="listitem">
    132. 

  132.             info: no info
    133. 

  133.           </li>
    134. 

  134. <li class="listitem">
    135. 

  135.             allocator: std::allocator
    136. 

  136.           </li>
    137. 

  137. </ul></div>
    138. 

  138. <pre class="programlisting"><span class="identifier">bimap</span><span class="special">&lt;</span> <span class="identifier">L</span><span class="special">,</span> <span class="identifier">R</span> <span class="special">,</span><span class="identifier">SetOfRelationType</span><span class="special">&gt;</span>
    139. 

  139. </pre>
    140. 

  140. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    141. 

  141. <li class="listitem">
    142. 

  142.             set_of_relation_type: SetOfRelationType
    143. 

  143.           </li>
    144. 

  144. <li class="listitem">
    145. 

  145.             info: no info
    146. 

  146.           </li>
    147. 

  147. <li class="listitem">
    148. 

  148.             allocator: std::allocator
    149. 

  149.           </li>
    150. 

  150. </ul></div>
    151. 

  151. <pre class="programlisting"><span class="identifier">bimap</span><span class="special">&lt;</span> <span class="identifier">L</span><span class="special">,</span> <span class="identifier">R</span> <span class="special">,</span> <span class="identifier">SetOfRelationType</span><span class="special">,</span> <span class="identifier">with_info</span><span class="special">&lt;</span><span class="identifier">Info</span><span class="special">&gt;</span> <span class="special">&gt;</span>
    152. 

  152. </pre>
    153. 

  153. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    154. 

  154. <li class="listitem">
    155. 

  155.             set_of_relation_type: SetOfRelationType
    156. 

  156.           </li>
    157. 

  157. <li class="listitem">
    158. 

  158.             info: Info
    159. 

  159.           </li>
    160. 

  160. <li class="listitem">
    161. 

  161.             allocator: std::allocator
    162. 

  162.           </li>
    163. 

  163. </ul></div>
    164. 

  164. <pre class="programlisting"><span class="identifier">bimap</span><span class="special">&lt;</span> <span class="identifier">L</span><span class="special">,</span> <span class="identifier">R</span> <span class="special">,</span> <span class="identifier">SetOfRelationType</span><span class="special">,</span> <span class="identifier">with_info</span><span class="special">&lt;</span><span class="identifier">Info</span><span class="special">&gt;,</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
    165. 

  165. </pre>
    166. 

  166. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    167. 

  167. <li class="listitem">
    168. 

  168.             set_of_relation_type: SetOfRelationType
    169. 

  169.           </li>
    170. 

  170. <li class="listitem">
    171. 

  171.             info: Info
    172. 

  172.           </li>
    173. 

  173. <li class="listitem">
    174. 

  174.             allocator: Allocator
    175. 

  175.           </li>
    176. 

  176. </ul></div>
    177. 

  177. <pre class="programlisting"><span class="identifier">bimap</span><span class="special">&lt;</span> <span class="identifier">L</span><span class="special">,</span> <span class="identifier">R</span> <span class="special">,</span> <span class="identifier">SetOfRelationType</span><span class="special">,</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
    178. 

  178. </pre>
    179. 

  179. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    180. 

  180. <li class="listitem">
    181. 

  181.             set_of_relation_type: SetOfRelationType
    182. 

  182.           </li>
    183. 

  183. <li class="listitem">
    184. 

  184.             info: no info
    185. 

  185.           </li>
    186. 

  186. <li class="listitem">
    187. 

  187.             allocator: Allocator
    188. 

  188.           </li>
    189. 

  189. </ul></div>
    190. 

  190. <pre class="programlisting"><span class="identifier">bimap</span><span class="special">&lt;</span> <span class="identifier">L</span><span class="special">,</span> <span class="identifier">R</span> <span class="special">,</span> <span class="identifier">with_info</span><span class="special">&lt;</span><span class="identifier">Info</span><span class="special">&gt;</span> <span class="special">&gt;</span>
    191. 

  191. </pre>
    192. 

  192. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    193. 

  193. <li class="listitem">
    194. 

  194.             set_of_relation_type: based on the left key type
    195. 

  195.           </li>
    196. 

  196. <li class="listitem">
    197. 

  197.             info: Info
    198. 

  198.           </li>
    199. 

  199. <li class="listitem">
    200. 

  200.             allocator: std::allocator
    201. 

  201.           </li>
    202. 

  202. </ul></div>
    203. 

  203. <pre class="programlisting"><span class="identifier">bimap</span><span class="special">&lt;</span> <span class="identifier">L</span><span class="special">,</span> <span class="identifier">R</span> <span class="special">,</span> <span class="identifier">with_info</span><span class="special">&lt;</span><span class="identifier">Info</span><span class="special">&gt;,</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
    204. 

  204. </pre>
    205. 

  205. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    206. 

  206. <li class="listitem">
    207. 

  207.             set_of_relation_type: based on the left key type
    208. 

  208.           </li>
    209. 

  209. <li class="listitem">
    210. 

  210.             allocator: Allocator
    211. 

  211.           </li>
    212. 

  212. </ul></div>
    213. 

  213. <pre class="programlisting"><span class="identifier">bimap</span><span class="special">&lt;</span> <span class="identifier">L</span><span class="special">,</span> <span class="identifier">R</span> <span class="special">,</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
    214. 

  214. </pre>
    215. 

  215. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    216. 

  216. <li class="listitem">
    217. 

  217.             set_of_relation_type: based on the left key type
    218. 

  218.           </li>
    219. 

  219. <li class="listitem">
    220. 

  220.             info: no info
    221. 

  221.           </li>
    222. 

  222. <li class="listitem">
    223. 

  223.             allocator: Allocator
    224. 

  224.           </li>
    225. 

  225. </ul></div>
    226. 

  226. </div>
    227. 

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

  228. <td align="left"></td>
    229. 

  229. <td align="right"><div class="copyright-footer">Copyright &#169; 2006-2012 Matias Capeletto<p>
    230. 

  230.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    231. 

  231.         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>)
    232. 

  232.       </p>
    233. 

  233. </div></td>
    234. 

  234. </tr></table>
    235. 

  235. <hr>
    236. 

  236. <div class="spirit-nav">
    237. 

  237. <a accesskey="p" href="additional_information.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../the_tutorial.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="../bimap_and_boost.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
    238. 

  238. </div>
    239. 

  239. </body>
    240. 

  240. </html>
    241.