list.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  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: list</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="./vector.html" class="navigation-link">Prev</a>&nbsp;<a href="./deque.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./vector.html" class="navigation-link">Back</a>&nbsp;<a href="./deque.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./classes.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="./classes.html" class="navigation-link">Classes</a> / <a href="./list.html" class="navigation-link">list</a></td>
  13. </tr></table><div class="header-separator"></div>
  14. <div class="section" id="list">
  15. <h1><a class="toc-backref" href="./classes.html#id1407">list</a></h1>
  16. <div class="section" id="id56">
  17. <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  18. <p>A <tt class="literal"><span class="pre"><a href="./list.html" class="identifier">list</a></span></tt> is a <a class="reference internal" href="./variadic-sequence.html">variadic</a>, <a class="reference internal" href="./forward-sequence.html">forward</a>, <a class="reference internal" href="./extensible-sequence.html">extensible</a> sequence of types that
  19. supports constant-time insertion and removal of elements at the beginning, and
  20. linear-time insertion and removal of elements at the end and in the middle.</p>
  21. </div>
  22. <div class="section" id="id59">
  23. <h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
  24. <table border="1" class="docutils table">
  25. <colgroup>
  26. <col width="26%" />
  27. <col width="74%" />
  28. </colgroup>
  29. <thead valign="bottom">
  30. <tr><th class="head">Sequence form</th>
  31. <th class="head">Header</th>
  32. </tr>
  33. </thead>
  34. <tbody valign="top">
  35. <tr><td>Variadic</td>
  36. <td><tt class="literal"><span class="pre">#include &lt;<a href="../../../../boost/mpl/list.hpp" class="header">boost/mpl/list.hpp</a>&gt;</span></tt></td>
  37. </tr>
  38. <tr><td>Numbered</td>
  39. <td><tt class="literal"><span class="pre">#include &lt;boost/mpl/list/list</span></tt><em>n</em><tt class="literal"><span class="pre">.hpp&gt;</span></tt></td>
  40. </tr>
  41. </tbody>
  42. </table>
  43. </div>
  44. <div class="section" id="id60">
  45. <h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
  46. <ul class="simple">
  47. <li><a class="reference internal" href="./variadic-sequence.html">Variadic Sequence</a></li>
  48. <li><a class="reference internal" href="./forward-sequence.html">Forward Sequence</a></li>
  49. <li><a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a></li>
  50. <li><a class="reference internal" href="./front-extensible-sequence.html">Front Extensible Sequence</a></li>
  51. </ul>
  52. </div>
  53. <div class="section" id="id61">
  54. <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  55. <p>In the following table, <tt class="literal"><span class="pre">l</span></tt> is a <tt class="literal"><span class="pre"><a href="./list.html" class="identifier">list</a></span></tt>, <tt class="literal"><span class="pre">pos</span></tt> and <tt class="literal"><span class="pre">last</span></tt> are iterators into <tt class="literal"><span class="pre">l</span></tt>,
  56. <tt class="literal"><span class="pre">r</span></tt> is a <a class="reference internal" href="./forward-sequence.html">Forward Sequence</a>, and <em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub> and <tt class="literal"><span class="pre">x</span></tt> are arbitrary types.</p>
  57. <table border="1" class="docutils table">
  58. <colgroup>
  59. <col width="40%" />
  60. <col width="60%" />
  61. </colgroup>
  62. <thead valign="bottom">
  63. <tr><th class="head">Expression</th>
  64. <th class="head">Semantics</th>
  65. </tr>
  66. </thead>
  67. <tbody valign="top">
  68. <tr><td><pre class="first last literal-block">
  69. <a href="./list.html" class="identifier">list</a>&lt;<em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>&gt;
  70. <a href="./list.html" class="identifier">list</a><em>n</em>&lt;<em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>&gt;
  71. </pre>
  72. </td>
  73. <td><tt class="literal"><span class="pre"><a href="./list.html" class="identifier">list</a></span></tt> of elements <em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>; see
  74. <a class="reference internal" href="./variadic-sequence.html">Variadic Sequence</a>.</td>
  75. </tr>
  76. <tr><td><pre class="first last literal-block">
  77. <a href="./list.html" class="identifier">list</a>&lt;<em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>&gt;::type
  78. <a href="./list.html" class="identifier">list</a><em>n</em>&lt;<em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>&gt;::type
  79. </pre>
  80. </td>
  81. <td>Identical to <tt class="literal"><span class="pre"><a href="./list.html" class="identifier">list</a></span></tt><em>n</em><tt class="literal"><span class="pre">&lt;</span></tt><em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub><tt class="literal"><span class="pre">&gt;</span></tt>;
  82. see <a class="reference internal" href="./variadic-sequence.html">Variadic Sequence</a>.</td>
  83. </tr>
  84. <tr><td><tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;l&gt;::type</span></tt></td>
  85. <td>An iterator to the beginning of <tt class="literal"><span class="pre">l</span></tt>;
  86. see <a class="reference internal" href="./forward-sequence.html">Forward Sequence</a>.</td>
  87. </tr>
  88. <tr><td><tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;l&gt;::type</span></tt></td>
  89. <td>An iterator to the end of <tt class="literal"><span class="pre">l</span></tt>;
  90. see <a class="reference internal" href="./forward-sequence.html">Forward Sequence</a>.</td>
  91. </tr>
  92. <tr><td><tt class="literal"><span class="pre"><a href="./size.html" class="identifier">size</a>&lt;l&gt;::type</span></tt></td>
  93. <td>The size of <tt class="literal"><span class="pre">l</span></tt>; see <a class="reference internal" href="./forward-sequence.html">Forward Sequence</a>.</td>
  94. </tr>
  95. <tr><td><tt class="literal"><span class="pre"><a href="./empty.html" class="identifier">empty</a>&lt;l&gt;::type</span></tt></td>
  96. <td>A boolean <a class="reference internal" href="./integral-constant.html">Integral Constant</a> <tt class="literal"><span class="pre">c</span></tt> such that
  97. <tt class="literal"><span class="pre">c::value</span> <span class="pre">==</span> <span class="pre">true</span></tt> if and only if <tt class="literal"><span class="pre">l</span></tt> is empty; see
  98. <a class="reference internal" href="./forward-sequence.html">Forward Sequence</a>.</td>
  99. </tr>
  100. <tr><td><tt class="literal"><span class="pre"><a href="./front.html" class="identifier">front</a>&lt;l&gt;::type</span></tt></td>
  101. <td>The first element in <tt class="literal"><span class="pre">l</span></tt>; see
  102. <a class="reference internal" href="./forward-sequence.html">Forward Sequence</a>.</td>
  103. </tr>
  104. <tr><td><tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;l,pos,x&gt;::type</span></tt></td>
  105. <td>A new <tt class="literal"><span class="pre"><a href="./list.html" class="identifier">list</a></span></tt> of following elements:
  106. [<tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;l&gt;::type</span></tt>, <tt class="literal"><span class="pre">pos</span></tt>), <tt class="literal"><span class="pre">x</span></tt>,
  107. [<tt class="literal"><span class="pre">pos</span></tt>, <tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;l&gt;::type</span></tt>); see <a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a>.</td>
  108. </tr>
  109. <tr><td><tt class="literal"><span class="pre"><a href="./insert-range.html" class="identifier">insert_range</a>&lt;l,pos,r&gt;::type</span></tt></td>
  110. <td>A new <tt class="literal"><span class="pre"><a href="./list.html" class="identifier">list</a></span></tt> of following elements:
  111. [<tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;l&gt;::type</span></tt>, <tt class="literal"><span class="pre">pos</span></tt>),
  112. [<tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;r&gt;::type</span></tt>, <tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;r&gt;::type</span></tt>)
  113. [<tt class="literal"><span class="pre">pos</span></tt>, <tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;l&gt;::type</span></tt>); see <a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a>.</td>
  114. </tr>
  115. <tr><td><tt class="literal"><span class="pre"><a href="./erase.html" class="identifier">erase</a>&lt;l,pos&gt;::type</span></tt></td>
  116. <td>A new <tt class="literal"><span class="pre"><a href="./list.html" class="identifier">list</a></span></tt> of following elements:
  117. [<tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;l&gt;::type</span></tt>, <tt class="literal"><span class="pre">pos</span></tt>),
  118. [<tt class="literal"><span class="pre"><a href="./next.html" class="identifier">next</a>&lt;pos&gt;::type</span></tt>, <tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;l&gt;::type</span></tt>); see
  119. <a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a>.</td>
  120. </tr>
  121. <tr><td><tt class="literal"><span class="pre"><a href="./erase.html" class="identifier">erase</a>&lt;l,pos,last&gt;::type</span></tt></td>
  122. <td>A new <tt class="literal"><span class="pre"><a href="./list.html" class="identifier">list</a></span></tt> of following elements:
  123. [<tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;l&gt;::type</span></tt>, <tt class="literal"><span class="pre">pos</span></tt>),
  124. [<tt class="literal"><span class="pre">last</span></tt>, <tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;l&gt;::type</span></tt>); see <a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a>.</td>
  125. </tr>
  126. <tr><td><tt class="literal"><span class="pre"><a href="./clear.html" class="identifier">clear</a>&lt;l&gt;::type</span></tt></td>
  127. <td>An empty <tt class="literal"><span class="pre"><a href="./list.html" class="identifier">list</a></span></tt>; see <a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a>.</td>
  128. </tr>
  129. <tr><td><tt class="literal"><span class="pre"><a href="./push-front.html" class="identifier">push_front</a>&lt;l,x&gt;::type</span></tt></td>
  130. <td>A new <tt class="literal"><span class="pre"><a href="./list.html" class="identifier">list</a></span></tt> containing <tt class="literal"><span class="pre">x</span></tt> as its first
  131. element; see <a class="reference internal" href="./front-extensible-sequence.html">Front Extensible Sequence</a>.</td>
  132. </tr>
  133. <tr><td><tt class="literal"><span class="pre"><a href="./pop-front.html" class="identifier">pop_front</a>&lt;l&gt;::type</span></tt></td>
  134. <td>A new <tt class="literal"><span class="pre"><a href="./list.html" class="identifier">list</a></span></tt> containing all but the first elements
  135. of <tt class="literal"><span class="pre">l</span></tt> in the same order; see
  136. <a class="reference internal" href="./front-extensible-sequence.html">Front Extensible Sequence</a>.</td>
  137. </tr>
  138. </tbody>
  139. </table>
  140. </div>
  141. <div class="section" id="id62">
  142. <h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
  143. <pre class="literal-block">
  144. typedef <a href="./list.html" class="identifier">list</a>&lt;float,double,long double&gt; floats;
  145. typedef <a href="./push-front.html" class="identifier">push_front</a>&lt;floats,int&gt;::type types;
  146. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./front.html" class="identifier">front</a>&lt;types&gt;::type, int > ));
  147. </pre>
  148. </div>
  149. <div class="section" id="id63">
  150. <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
  151. <p><a class="reference internal" href="./sequences.html">Sequences</a>, <a class="reference internal" href="./variadic-sequence.html">Variadic Sequence</a>, <a class="reference internal" href="./forward-sequence.html">Forward Sequence</a>, <a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a>, <a class="reference internal" href="./vector.html">vector</a>, <a class="reference internal" href="./list-c.html">list_c</a></p>
  152. <!-- Sequences/Classes//deque |30 -->
  153. </div>
  154. </div>
  155. <div class="footer-separator"></div>
  156. <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./vector.html" class="navigation-link">Prev</a>&nbsp;<a href="./deque.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./vector.html" class="navigation-link">Back</a>&nbsp;<a href="./deque.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./classes.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>
  157. <td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div>
  158. Distributed under the Boost Software License, Version 1.0. (See accompanying
  159. 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>
  160. </html>