extensible-associative-sequence.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
  7. <title>The MPL Reference Manual: Extensible Associative Sequence</title>
  8. <link rel="stylesheet" href="../style.css" type="text/css" />
  9. </head>
  10. <body class="docframe refmanual">
  11. <table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./associative-sequence.html" class="navigation-link">Prev</a>&nbsp;<a href="./integral-sequence-wrapper.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./associative-sequence.html" class="navigation-link">Back</a>&nbsp;<a href="./integral-sequence-wrapper.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./concepts.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
  12. <td class="header-group page-location"><a href="../refmanual.html" class="navigation-link">Front Page</a> / <a href="./sequences.html" class="navigation-link">Sequences</a> / <a href="./concepts.html" class="navigation-link">Concepts</a> / <a href="./extensible-associative-sequence.html" class="navigation-link">Extensible Associative Sequence</a></td>
  13. </tr></table><div class="header-separator"></div>
  14. <div class="section" id="extensible-associative-sequence">
  15. <h1><a class="toc-backref" href="./concepts.html#id1402">Extensible Associative Sequence</a></h1>
  16. <div class="section" id="id35">
  17. <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  18. <p>An <a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a> is an <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a> that supports
  19. insertion and removal of elements. In contrast to <a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a>,
  20. <a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a> does not provide a mechanism for
  21. inserting an element at a specific position.</p>
  22. </div>
  23. <div class="section" id="id36">
  24. <h3><a class="subsection-title" href="#expression-requirements" name="expression-requirements">Expression requirements</a></h3>
  25. <p>In the following table and subsequent specifications, <tt class="literal"><span class="pre">s</span></tt> is an <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a>,
  26. <tt class="literal"><span class="pre">pos</span></tt> is an iterator into <tt class="literal"><span class="pre">s</span></tt>, and <tt class="literal"><span class="pre">x</span></tt> and <tt class="literal"><span class="pre">k</span></tt> are arbitrary types.</p>
  27. <p>In addition to the <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a> requirements, the following must be met:</p>
  28. <table border="1" class="docutils table">
  29. <colgroup>
  30. <col width="32%" />
  31. <col width="40%" />
  32. <col width="28%" />
  33. </colgroup>
  34. <thead valign="bottom">
  35. <tr><th class="head">Expression</th>
  36. <th class="head">Type</th>
  37. <th class="head">Complexity</th>
  38. </tr>
  39. </thead>
  40. <tbody valign="top">
  41. <tr><td><tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;s,x&gt;::type</span></tt></td>
  42. <td><a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a></td>
  43. <td>Amortized constant time</td>
  44. </tr>
  45. <tr><td><tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;s,pos,x&gt;::type</span></tt></td>
  46. <td><a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a></td>
  47. <td>Amortized constant time</td>
  48. </tr>
  49. <tr><td><tt class="literal"><span class="pre"><a href="./erase-key.html" class="identifier">erase_key</a>&lt;s,k&gt;::type</span></tt></td>
  50. <td><a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a></td>
  51. <td>Amortized constant time</td>
  52. </tr>
  53. <tr><td><tt class="literal"><span class="pre"><a href="./erase.html" class="identifier">erase</a>&lt;s,pos&gt;::type</span></tt></td>
  54. <td><a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a></td>
  55. <td>Amortized constant time</td>
  56. </tr>
  57. <tr><td><tt class="literal"><span class="pre"><a href="./clear.html" class="identifier">clear</a>&lt;s&gt;::type</span></tt></td>
  58. <td><a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a></td>
  59. <td>Amortized constant time</td>
  60. </tr>
  61. </tbody>
  62. </table>
  63. </div>
  64. <div class="section" id="id37">
  65. <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  66. <p>The semantics of an expression are defined only
  67. where they differ from, or are not defined in <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a>.</p>
  68. <table border="1" class="docutils table">
  69. <colgroup>
  70. <col width="32%" />
  71. <col width="68%" />
  72. </colgroup>
  73. <thead valign="bottom">
  74. <tr><th class="head">Expression</th>
  75. <th class="head">Semantics</th>
  76. </tr>
  77. </thead>
  78. <tbody valign="top">
  79. <tr><td><tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;s,x&gt;::type</span></tt></td>
  80. <td><p class="first">Inserts <tt class="literal"><span class="pre">x</span></tt> into <tt class="literal"><span class="pre">s</span></tt>; the resulting sequence <tt class="literal"><span class="pre">r</span></tt> is
  81. equivalent to <tt class="literal"><span class="pre">s</span></tt> except that</p>
  82. <pre class="literal-block">
  83. <a href="./at.html" class="identifier">at</a>&lt; r, <a href="./key-type.html" class="identifier">key_type</a>&lt;s,x&gt;::type &gt;::type
  84. </pre>
  85. <p class="last">is identical to <tt class="literal"><span class="pre"><a href="./value-type.html" class="identifier">value_type</a>&lt;s,x&gt;::type</span></tt>; see <a class="reference internal" href="./insert.html">insert</a>.</p>
  86. </td>
  87. </tr>
  88. <tr><td><tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;s,pos,x&gt;::type</span></tt></td>
  89. <td>Equivalent to <tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;s,x&gt;::type</span></tt>; <tt class="literal"><span class="pre">pos</span></tt> is ignored;
  90. see <a class="reference internal" href="./insert.html">insert</a>.</td>
  91. </tr>
  92. <tr><td><tt class="literal"><span class="pre"><a href="./erase-key.html" class="identifier">erase_key</a>&lt;s,k&gt;::type</span></tt></td>
  93. <td>Erases elements in <tt class="literal"><span class="pre">s</span></tt> associated with the key <tt class="literal"><span class="pre">k</span></tt>;
  94. the resulting sequence <tt class="literal"><span class="pre">r</span></tt> is equivalent to <tt class="literal"><span class="pre">s</span></tt> except
  95. that <tt class="literal"><span class="pre"><a href="./has-key.html" class="identifier">has_key</a>&lt;r,k&gt;::value</span> <span class="pre">==</span> <span class="pre">false</span></tt>; see <a class="reference internal" href="./erase-key.html">erase_key</a>.</td>
  96. </tr>
  97. <tr><td><tt class="literal"><span class="pre"><a href="./erase.html" class="identifier">erase</a>&lt;s,pos&gt;::type</span></tt></td>
  98. <td>Erases the element at a specific position; equivalent to
  99. <tt class="literal"><span class="pre"><a href="./erase-key.html" class="identifier">erase_key</a>&lt;s,</span> <span class="pre"><a href="./deref.html" class="identifier">deref</a>&lt;pos&gt;::type</span> <span class="pre">&gt;::type</span></tt>; see <a class="reference internal" href="./erase.html">erase</a>.</td>
  100. </tr>
  101. <tr><td><tt class="literal"><span class="pre"><a href="./clear.html" class="identifier">clear</a>&lt;s&gt;::type</span></tt></td>
  102. <td>An empty sequence concept-identical to <tt class="literal"><span class="pre">s</span></tt>; see
  103. <a class="reference internal" href="./clear.html">clear</a>.</td>
  104. </tr>
  105. </tbody>
  106. </table>
  107. <!-- Invariants
  108. - - - - - - - - - -
  109. For any extensible associative sequence ``s`` the following invariants always hold: -->
  110. </div>
  111. <div class="section" id="id38">
  112. <h3><a class="subsection-title" href="#models" name="models">Models</a></h3>
  113. <ul class="simple">
  114. <li><a class="reference internal" href="./set.html">set</a></li>
  115. <li><a class="reference internal" href="./map.html">map</a></li>
  116. </ul>
  117. <!-- * |multiset| -->
  118. </div>
  119. <div class="section" id="id39">
  120. <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
  121. <p><a class="reference internal" href="./sequences.html">Sequences</a>, <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a>, <a class="reference internal" href="./insert.html">insert</a>, <a class="reference internal" href="./erase.html">erase</a>, <a class="reference internal" href="./clear.html">clear</a></p>
  122. <!-- Sequences/Concepts//Integral Sequence Wrapper |90 -->
  123. </div>
  124. </div>
  125. <div class="footer-separator"></div>
  126. <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./associative-sequence.html" class="navigation-link">Prev</a>&nbsp;<a href="./integral-sequence-wrapper.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./associative-sequence.html" class="navigation-link">Back</a>&nbsp;<a href="./integral-sequence-wrapper.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./concepts.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
  127. <td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div>
  128. Distributed under the Boost Software License, Version 1.0. (See accompanying
  129. file LICENSE_1_0.txt or copy at <a class="reference external" href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</div></td></tr></table></body>
  130. </html>