integral-sequence-wrapper.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  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: Integral Sequence Wrapper</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="./extensible-associative-sequence.html" class="navigation-link">Prev</a>&nbsp;<a href="./variadic-sequence.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./extensible-associative-sequence.html" class="navigation-link">Back</a>&nbsp;<a href="./variadic-sequence.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="./integral-sequence-wrapper.html" class="navigation-link">Integral Sequence Wrapper</a></td>
  13. </tr></table><div class="header-separator"></div>
  14. <div class="section" id="integral-sequence-wrapper">
  15. <h1><a class="toc-backref" href="./concepts.html#id1403">Integral Sequence Wrapper</a></h1>
  16. <div class="section" id="id40">
  17. <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  18. <p>An <a class="reference internal" href="./integral-sequence-wrapper.html">Integral Sequence Wrapper</a> is a class template that provides a concise
  19. interface for creating a corresponding sequence of <a class="reference internal" href="./integral-constant.html">Integral Constant</a>s. In
  20. particular, assuming that <tt class="literal"><span class="pre">seq</span></tt> is a name of the wrapper's underlying
  21. sequence and <em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub> are integral constants of an integral type <tt class="literal"><span class="pre">T</span></tt> to
  22. be stored in the sequence, the wrapper provides us with the following
  23. notation:</p>
  24. <blockquote>
  25. <div class="line-block">
  26. <div class="line"><tt class="literal"><span class="pre">seq_c&lt;T</span></tt>,<em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub><tt class="literal"><span class="pre">&gt;</span></tt></div>
  27. </div>
  28. </blockquote>
  29. <p>If <tt class="literal"><span class="pre">seq</span></tt> is a <a class="reference internal" href="./variadic-sequence.html">Variadic Sequence</a>, <em>numbered</em> wrapper forms are
  30. also avaialable:</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">_c&lt;T</span></tt>,<em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub><tt class="literal"><span class="pre">&gt;</span></tt></div>
  34. </div>
  35. </blockquote>
  36. </div>
  37. <div class="section" id="id41">
  38. <h3><a class="subsection-title" href="#expression-requirements" name="expression-requirements">Expression requirements</a></h3>
  39. <p>In the following table and subsequent specifications, <tt class="literal"><span class="pre">seq</span></tt> is a placeholder token for the
  40. <a class="reference internal" href="./integral-sequence-wrapper.html">Integral Sequence Wrapper</a>'s underlying sequence's name.</p>
  41. <table border="1" class="docutils table">
  42. <colgroup>
  43. <col width="38%" />
  44. <col width="28%" />
  45. <col width="33%" />
  46. </colgroup>
  47. <thead valign="bottom">
  48. <tr><th class="head">Expression</th>
  49. <th class="head">Type</th>
  50. <th class="head">Complexity</th>
  51. </tr>
  52. </thead>
  53. <tbody valign="top">
  54. <tr><td><tt class="literal"><span class="pre">seq_c&lt;T</span></tt>,<em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub><tt class="literal"><span class="pre">&gt;</span></tt></td>
  55. <td><a class="reference internal" href="./forward-sequence.html">Forward Sequence</a></td>
  56. <td>Amortized constant time.</td>
  57. </tr>
  58. <tr><td><tt class="literal"><span class="pre">seq_c&lt;T</span></tt>,<em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub><tt class="literal"><span class="pre">&gt;::type</span></tt></td>
  59. <td><a class="reference internal" href="./forward-sequence.html">Forward Sequence</a></td>
  60. <td>Amortized constant time.</td>
  61. </tr>
  62. <tr><td><tt class="literal"><span class="pre">seq_c&lt;T</span></tt>,<em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub><tt class="literal"><span class="pre">&gt;::<a href="./value-type.html" class="identifier">value_type</a></span></tt></td>
  63. <td>An integral type</td>
  64. <td>Amortized constant time.</td>
  65. </tr>
  66. <tr><td><tt class="literal"><span class="pre">seq</span></tt><em>n</em><tt class="literal"><span class="pre">_c&lt;T</span></tt>,<em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub><tt class="literal"><span class="pre">&gt;</span></tt></td>
  67. <td><a class="reference internal" href="./forward-sequence.html">Forward Sequence</a></td>
  68. <td>Amortized constant time.</td>
  69. </tr>
  70. <tr><td><tt class="literal"><span class="pre">seq</span></tt><em>n</em><tt class="literal"><span class="pre">_c&lt;T</span></tt>,<em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub><tt class="literal"><span class="pre">&gt;::type</span></tt></td>
  71. <td><a class="reference internal" href="./forward-sequence.html">Forward Sequence</a></td>
  72. <td>Amortized constant time.</td>
  73. </tr>
  74. <tr><td><tt class="literal"><span class="pre">seq</span></tt><em>n</em><tt class="literal"><span class="pre">_c&lt;T</span></tt>,<em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub><tt class="literal"><span class="pre">&gt;::<a href="./value-type.html" class="identifier">value_type</a></span></tt></td>
  75. <td>An integral type</td>
  76. <td>Amortized constant time.</td>
  77. </tr>
  78. </tbody>
  79. </table>
  80. </div>
  81. <div class="section" id="id42">
  82. <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  83. <pre class="literal-block">
  84. typedef seq_c&lt;T,<em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub>&gt; s;
  85. typedef seq<em>n</em>_c&lt;T,<em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub>&gt; s;
  86. </pre>
  87. <table class="docutils field-list" frame="void" rules="none">
  88. <col class="field-name" />
  89. <col class="field-body" />
  90. <tbody valign="top">
  91. <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 <tt class="literal"><span class="pre">seq</span></tt> of integral constant wrappers <tt class="literal"><span class="pre"><a href="./integral-c.html" class="identifier">integral_c</a>&lt;T,</span></tt><em>c</em><sub>1</sub><tt class="literal"><span class="pre">&gt;</span></tt>,
  92. <tt class="literal"><span class="pre"><a href="./integral-c.html" class="identifier">integral_c</a>&lt;T,</span></tt><em>c</em><sub>2</sub><tt class="literal"><span class="pre">&gt;</span></tt>, ... <tt class="literal"><span class="pre"><a href="./integral-c.html" class="identifier">integral_c</a>&lt;T,</span></tt><em>c</em><sub>n</sub><tt class="literal"><span class="pre">&gt;</span></tt>.</td>
  93. </tr>
  94. <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>.<!-- .. parsed-literal::
  95. BOOST_MPL_ASSERT_RELATION(( at_c<v,0>::type::value,==,\ |c1| ));
  96. BOOST_MPL_ASSERT_RELATION(( at_c<v,1>::type::value,==,\ |c2| ));
  97. ...
  98. BOOST_MPL_ASSERT_RELATION(( at_c<v,\ *n*>::type::value,==,\ |cn| )); -->
  99. </td>
  100. </tr>
  101. </tbody>
  102. </table>
  103. <!-- .......................................................................... -->
  104. <pre class="literal-block">
  105. typedef seq_c&lt;T,<em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub>&gt;::type s;
  106. typedef seq<em>n</em>_c&lt;T,<em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub>&gt;::type s;
  107. </pre>
  108. <table class="docutils field-list" frame="void" rules="none">
  109. <col class="field-name" />
  110. <col class="field-body" />
  111. <tbody valign="top">
  112. <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
  113. <tt class="literal"><span class="pre">seq</span></tt><em>n</em><tt class="literal"><span class="pre">&lt;</span></tt><tt class="literal"><span class="pre"><a href="./integral-c.html" class="identifier">integral_c</a>&lt;T,</span></tt><em>c</em><sub>1</sub><tt class="literal"><span class="pre">&gt;</span></tt>,<tt class="literal"><span class="pre"><a href="./integral-c.html" class="identifier">integral_c</a>&lt;T,</span></tt><em>c</em><sub>2</sub><tt class="literal"><span class="pre">&gt;</span></tt>,
  114. ... <tt class="literal"><span class="pre"><a href="./integral-c.html" class="identifier">integral_c</a>&lt;T,</span></tt><em>c</em><sub>n</sub><tt class="literal"><span class="pre">&gt;</span></tt> <tt class="literal"><span class="pre">&gt;</span></tt>.</td>
  115. </tr>
  116. </tbody>
  117. </table>
  118. <!-- .......................................................................... -->
  119. <pre class="literal-block">
  120. typedef seq_c&lt;T,<em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub>&gt;::<a href="./value-type.html" class="identifier">value_type</a> t;
  121. typedef seq<em>n</em>_c&lt;T,<em>c</em><sub>1</sub>,<em>c</em><sub>2</sub>,... <em>c</em><sub>n</sub>&gt;::<a href="./value-type.html" class="identifier">value_type</a> t;
  122. </pre>
  123. <table class="docutils field-list" frame="void" rules="none">
  124. <col class="field-name" />
  125. <col class="field-body" />
  126. <tbody valign="top">
  127. <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><tt class="literal"><span class="pre">is_same&lt;t,T&gt;::value</span> <span class="pre">==</span> <span class="pre">true</span></tt>.</td>
  128. </tr>
  129. </tbody>
  130. </table>
  131. </div>
  132. <div class="section" id="id43">
  133. <h3><a class="subsection-title" href="#models" name="models">Models</a></h3>
  134. <ul class="simple">
  135. <li><a class="reference internal" href="./vector-c.html">vector_c</a></li>
  136. <li><a class="reference internal" href="./list-c.html">list_c</a></li>
  137. <li><a class="reference internal" href="./set-c.html">set_c</a></li>
  138. </ul>
  139. </div>
  140. <div class="section" id="id44">
  141. <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
  142. <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="./integral-constant.html">Integral Constant</a></p>
  143. <!-- Sequences/Concepts//Variadic Sequence |100 -->
  144. </div>
  145. </div>
  146. <div class="footer-separator"></div>
  147. <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./extensible-associative-sequence.html" class="navigation-link">Prev</a>&nbsp;<a href="./variadic-sequence.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./extensible-associative-sequence.html" class="navigation-link">Back</a>&nbsp;<a href="./variadic-sequence.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>
  148. <td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div>
  149. Distributed under the Boost Software License, Version 1.0. (See accompanying
  150. 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>
  151. </html>