variadic-sequence.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  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: Variadic 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="./integral-sequence-wrapper.html" class="navigation-link">Prev</a>&nbsp;<a href="./classes.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./integral-sequence-wrapper.html" class="navigation-link">Back</a>&nbsp;Along</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="./variadic-sequence.html" class="navigation-link">Variadic Sequence</a></td>
  13. </tr></table><div class="header-separator"></div>
  14. <div class="section" id="variadic-sequence">
  15. <h1><a class="toc-backref" href="./concepts.html#id1404">Variadic Sequence</a></h1>
  16. <div class="section" id="id45">
  17. <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  18. <p>A <a class="reference internal" href="./variadic-sequence.html">Variadic Sequence</a> is a member of a family of sequence classes with both
  19. <em>variadic</em> and <em>numbered</em> forms. If <tt class="literal"><span class="pre">seq</span></tt> is a generic name for some
  20. <a class="reference internal" href="./variadic-sequence.html">Variadic Sequence</a>, its <em>variadic form</em> allows us to specify a sequence of
  21. <em>n</em> elements <em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>, for any <em>n</em> from 0 up to a
  22. <a class="reference internal" href="./configuration.html">preprocessor-configurable limit</a> <tt class="literal"><span class="pre">BOOST_MPL_LIMIT_</span></tt><em>seq</em><tt class="literal"><span class="pre">_SIZE</span></tt>,
  23. using the following notation:</p>
  24. <blockquote>
  25. <div class="line-block">
  26. <div class="line"><tt class="literal"><span class="pre">seq&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></div>
  27. </div>
  28. </blockquote>
  29. <p>By contrast, each <em>numbered</em> sequence form accepts the exact number of elements
  30. that is encoded in the name of the corresponding class template:</p>
  31. <blockquote>
  32. <div class="line-block">
  33. <div class="line"><tt class="literal"><span class="pre">seq</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></div>
  34. </div>
  35. </blockquote>
  36. <p>For numbered forms, there is no predefined top limit for <em>n</em>, aside from compiler
  37. limitations on the number of template parameters.</p>
  38. <!-- The variadic form of sequence ``seq`` is defined in
  39. ``<boost/mpl/``\ *seq*\ ``.hpp>`` header.
  40. The numbered forms are defined in batches of 10. -->
  41. </div>
  42. <div class="section" id="id47">
  43. <h3><a class="subsection-title" href="#expression-requirements" name="expression-requirements">Expression requirements</a></h3>
  44. <p>In the following table and subsequent specifications, <tt class="literal"><span class="pre">seq</span></tt> is a placeholder token for the actual
  45. <a class="reference internal" href="./variadic-sequence.html">Variadic Sequence</a> name.</p>
  46. <table border="1" class="docutils table">
  47. <colgroup>
  48. <col width="35%" />
  49. <col width="30%" />
  50. <col width="35%" />
  51. </colgroup>
  52. <thead valign="bottom">
  53. <tr><th class="head">Expression</th>
  54. <th class="head">Type</th>
  55. <th class="head">Complexity</th>
  56. </tr>
  57. </thead>
  58. <tbody valign="top">
  59. <tr><td><tt class="literal"><span class="pre">seq&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></td>
  60. <td><a class="reference internal" href="./forward-sequence.html">Forward Sequence</a></td>
  61. <td>Amortized constant time</td>
  62. </tr>
  63. <tr><td><tt class="literal"><span class="pre">seq&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;::type</span></tt></td>
  64. <td><a class="reference internal" href="./forward-sequence.html">Forward Sequence</a></td>
  65. <td>Amortized constant time</td>
  66. </tr>
  67. <tr><td><tt class="literal"><span class="pre">seq</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></td>
  68. <td><a class="reference internal" href="./forward-sequence.html">Forward Sequence</a></td>
  69. <td>Amortized constant time</td>
  70. </tr>
  71. <tr><td><tt class="literal"><span class="pre">seq</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;::type</span></tt></td>
  72. <td><a class="reference internal" href="./forward-sequence.html">Forward Sequence</a></td>
  73. <td>Amortized constant time</td>
  74. </tr>
  75. </tbody>
  76. </table>
  77. </div>
  78. <div class="section" id="id48">
  79. <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  80. <pre class="literal-block">
  81. typedef seq&lt;<em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>&gt; s;
  82. typedef seq<em>n</em>&lt;<em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>&gt; s;
  83. </pre>
  84. <table class="docutils field-list" frame="void" rules="none">
  85. <col class="field-name" />
  86. <col class="field-body" />
  87. <tbody valign="top">
  88. <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><tt class="literal"><span class="pre">s</span></tt> is a sequence of elements <em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>.</td>
  89. </tr>
  90. <tr class="field"><th class="field-name">Postcondition:</th><td class="field-body"><tt class="literal"><span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s&gt;::value</span> <span class="pre">==</span> <span class="pre">n</span></tt>.<!-- FIXME .. parsed-literal::
  91. BOOST_MPL_ASSERT((|is_same|\< at_c<v,0>::type,\ |t1| >));
  92. BOOST_MPL_ASSERT((|is_same|\< at_c<v,1>::type,\ |t2| >));
  93. ...
  94. BOOST_MPL_ASSERT((|is_same|\< at_c<v,\ *n*>::type,\ |tn| >)); -->
  95. </td>
  96. </tr>
  97. </tbody>
  98. </table>
  99. <!-- .......................................................................... -->
  100. <pre class="literal-block">
  101. typedef seq&lt;<em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>&gt;::type s;
  102. typedef seq<em>n</em>&lt;<em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>&gt;::type s;
  103. </pre>
  104. <table class="docutils field-list" frame="void" rules="none">
  105. <col class="field-name" />
  106. <col class="field-body" />
  107. <tbody valign="top">
  108. <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><tt class="literal"><span class="pre">s</span></tt> is identical to <tt class="literal"><span class="pre">seq</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>.</td>
  109. </tr>
  110. <tr class="field"><th class="field-name">Postcondition:</th><td class="field-body"><tt class="literal"><span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s&gt;::value</span> <span class="pre">==</span> <span class="pre">n</span></tt>.</td>
  111. </tr>
  112. </tbody>
  113. </table>
  114. </div>
  115. <div class="section" id="id49">
  116. <h3><a class="subsection-title" href="#models" name="models">Models</a></h3>
  117. <ul class="simple">
  118. <li><a class="reference internal" href="./vector.html">vector</a></li>
  119. <li><a class="reference internal" href="./list.html">list</a></li>
  120. <li><a class="reference internal" href="./map.html">map</a></li>
  121. </ul>
  122. </div>
  123. <div class="section" id="id50">
  124. <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
  125. <p><a class="reference internal" href="./sequences.html">Sequences</a>, <a class="reference internal" href="./configuration.html">Configuration</a>, <a class="reference internal" href="./integral-sequence-wrapper.html">Integral Sequence Wrapper</a></p>
  126. </div>
  127. </div>
  128. <div class="footer-separator"></div>
  129. <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./integral-sequence-wrapper.html" class="navigation-link">Prev</a>&nbsp;<a href="./classes.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./integral-sequence-wrapper.html" class="navigation-link">Back</a>&nbsp;Along</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>
  130. <td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div>
  131. Distributed under the Boost Software License, Version 1.0. (See accompanying
  132. 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>
  133. </html>