pop-front.html 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  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: pop_front</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="./pop-back.html" class="navigation-link">Prev</a>&nbsp;<a href="./push-back.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./pop-back.html" class="navigation-link">Back</a>&nbsp;<a href="./push-back.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./intrinsic-metafunctions.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="./intrinsic-metafunctions.html" class="navigation-link">Intrinsic Metafunctions</a> / <a href="./pop-front.html" class="navigation-link">pop_front</a></td>
  13. </tr></table><div class="header-separator"></div>
  14. <div class="section" id="pop-front">
  15. <h1><a class="toc-backref" href="./intrinsic-metafunctions.html#id1442">pop_front</a></h1>
  16. <div class="section" id="id327">
  17. <h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
  18. <pre class="literal-block">
  19. template&lt;
  20. typename Sequence
  21. &gt;
  22. struct <a href="./pop-front.html" class="identifier">pop_front</a>
  23. {
  24. typedef <em>unspecified</em> type;
  25. };
  26. </pre>
  27. </div>
  28. <div class="section" id="id328">
  29. <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  30. <p><tt class="literal"><span class="pre"><a href="./pop-front.html" class="identifier">pop_front</a></span></tt> performs a removal at the beginning of the sequence with guaranteed <em>O(1)</em>
  31. complexity.</p>
  32. </div>
  33. <div class="section" id="id329">
  34. <h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
  35. <pre class="literal-block">
  36. #include &lt;<a href="../../../../boost/mpl/pop_front.hpp" class="header">boost/mpl/pop_front.hpp</a>&gt;
  37. </pre>
  38. </div>
  39. <div class="section" id="id330">
  40. <h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
  41. <p><a class="reference internal" href="./tag-dispatched-metafunction.html">Tag Dispatched Metafunction</a></p>
  42. </div>
  43. <div class="section" id="id331">
  44. <h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
  45. <table border="1" class="docutils table">
  46. <colgroup>
  47. <col width="15%" />
  48. <col width="36%" />
  49. <col width="48%" />
  50. </colgroup>
  51. <thead valign="bottom">
  52. <tr><th class="head">Parameter</th>
  53. <th class="head">Requirement</th>
  54. <th class="head">Description</th>
  55. </tr>
  56. </thead>
  57. <tbody valign="top">
  58. <tr><td><tt class="literal"><span class="pre">Sequence</span></tt></td>
  59. <td><a class="reference internal" href="./front-extensible-sequence.html">Front Extensible Sequence</a></td>
  60. <td>A sequence to erase the first element from.</td>
  61. </tr>
  62. </tbody>
  63. </table>
  64. </div>
  65. <div class="section" id="id332">
  66. <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  67. <p>For any <a class="reference internal" href="./front-extensible-sequence.html">Front Extensible Sequence</a> <tt class="literal"><span class="pre">s</span></tt>:</p>
  68. <pre class="literal-block">
  69. typedef <a href="./pop-front.html" class="identifier">pop_front</a>&lt;s&gt;::type r;
  70. </pre>
  71. <table class="docutils field-list" frame="void" rules="none">
  72. <col class="field-name" />
  73. <col class="field-body" />
  74. <tbody valign="top">
  75. <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="./front-extensible-sequence.html">Front Extensible Sequence</a>.</td>
  76. </tr>
  77. <tr class="field"><th class="field-name">Precondition:</th><td class="field-body"><tt class="literal"><span class="pre"><a href="./empty.html" class="identifier">empty</a>&lt;s&gt;::value</span> <span class="pre">==</span> <span class="pre">false</span></tt>.</td>
  78. </tr>
  79. <tr class="field"><th class="field-name">Semantics:</th><td class="field-body">Equivalent to <tt class="literal"><span class="pre"><a href="./erase.html" class="identifier">erase</a>&lt;s,<a href="./begin.html" class="identifier">begin</a>&lt;s&gt;::type&gt;::type;</span></tt>.</td>
  80. </tr>
  81. <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;r&gt;::value</span> <span class="pre">==</span> <span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s&gt;::value</span> <span class="pre">-</span> <span class="pre">1</span></tt>.</td>
  82. </tr>
  83. </tbody>
  84. </table>
  85. </div>
  86. <div class="section" id="id333">
  87. <h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
  88. <p>Amortized constant time.</p>
  89. </div>
  90. <div class="section" id="id334">
  91. <h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
  92. <pre class="literal-block">
  93. typedef <a href="./vector.html" class="identifier">vector</a>&lt;long&gt;::type types1;
  94. typedef <a href="./vector.html" class="identifier">vector</a>&lt;int,long&gt;::type types2;
  95. typedef <a href="./vector.html" class="identifier">vector</a>&lt;char,int,long&gt;::type types3;
  96. typedef <a href="./pop-front.html" class="identifier">pop_front</a>&lt;types1&gt;::type result1;
  97. typedef <a href="./pop-front.html" class="identifier">pop_front</a>&lt;types2&gt;::type result2;
  98. typedef <a href="./pop-front.html" class="identifier">pop_front</a>&lt;types3&gt;::type result3;
  99. <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./size.html" class="identifier">size</a>&lt;result1&gt;::value, ==, 0 );
  100. <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./size.html" class="identifier">size</a>&lt;result2&gt;::value, ==, 1 );
  101. <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./size.html" class="identifier">size</a>&lt;result3&gt;::value, ==, 2 );
  102. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./front.html" class="identifier">front</a>&lt;result2&gt;::type, long &gt; ));
  103. <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./front.html" class="identifier">front</a>&lt;result3&gt;::type, int > ));
  104. </pre>
  105. </div>
  106. <div class="section" id="id335">
  107. <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
  108. <p><a class="reference internal" href="./front-extensible-sequence.html">Front Extensible Sequence</a>, <a class="reference internal" href="./erase.html">erase</a>, <a class="reference internal" href="./push-front.html">push_front</a>, <a class="reference internal" href="./front.html">front</a>, <a class="reference internal" href="./pop-back.html">pop_back</a></p>
  109. <!-- Sequences/Intrinsic Metafunctions//push_back -->
  110. </div>
  111. </div>
  112. <div class="footer-separator"></div>
  113. <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./pop-back.html" class="navigation-link">Prev</a>&nbsp;<a href="./push-back.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./pop-back.html" class="navigation-link">Back</a>&nbsp;<a href="./push-back.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./intrinsic-metafunctions.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>
  114. <td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div>
  115. Distributed under the Boost Software License, Version 1.0. (See accompanying
  116. 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>
  117. </html>