| <?xml version="1.0" encoding="utf-8" ?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| <meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" /> |
| <title>The MPL Reference Manual: pop_front</title> |
| <link rel="stylesheet" href="../style.css" type="text/css" /> |
| </head> |
| <body class="docframe refmanual"> |
| <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> <a href="./push-back.html" class="navigation-link">Next</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./pop-back.html" class="navigation-link">Back</a> <a href="./push-back.html" class="navigation-link">Along</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./intrinsic-metafunctions.html" class="navigation-link">Up</a> <a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td> |
| <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> |
| </tr></table><div class="header-separator"></div> |
| <div class="section" id="pop-front"> |
| <h1><a class="toc-backref" href="./intrinsic-metafunctions.html#id1442">pop_front</a></h1> |
| <div class="section" id="id327"> |
| <h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3> |
| <pre class="literal-block"> |
| template< |
| typename Sequence |
| > |
| struct <a href="./pop-front.html" class="identifier">pop_front</a> |
| { |
| typedef <em>unspecified</em> type; |
| }; |
| </pre> |
| </div> |
| <div class="section" id="id328"> |
| <h3><a class="subsection-title" href="#description" name="description">Description</a></h3> |
| <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> |
| complexity.</p> |
| </div> |
| <div class="section" id="id329"> |
| <h3><a class="subsection-title" href="#header" name="header">Header</a></h3> |
| <pre class="literal-block"> |
| #include <<a href="../../../../boost/mpl/pop_front.hpp" class="header">boost/mpl/pop_front.hpp</a>> |
| </pre> |
| </div> |
| <div class="section" id="id330"> |
| <h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3> |
| <p><a class="reference internal" href="./tag-dispatched-metafunction.html">Tag Dispatched Metafunction</a></p> |
| </div> |
| <div class="section" id="id331"> |
| <h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3> |
| <table border="1" class="docutils table"> |
| <colgroup> |
| <col width="15%" /> |
| <col width="36%" /> |
| <col width="48%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr><th class="head">Parameter</th> |
| <th class="head">Requirement</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr><td><tt class="literal"><span class="pre">Sequence</span></tt></td> |
| <td><a class="reference internal" href="./front-extensible-sequence.html">Front Extensible Sequence</a></td> |
| <td>A sequence to erase the first element from.</td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="id332"> |
| <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3> |
| <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> |
| <pre class="literal-block"> |
| typedef <a href="./pop-front.html" class="identifier">pop_front</a><s>::type r; |
| </pre> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <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> |
| </tr> |
| <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><s>::value</span> <span class="pre">==</span> <span class="pre">false</span></tt>.</td> |
| </tr> |
| <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><s,<a href="./begin.html" class="identifier">begin</a><s>::type>::type;</span></tt>.</td> |
| </tr> |
| <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><r>::value</span> <span class="pre">==</span> <span class="pre"><a href="./size.html" class="identifier">size</a><s>::value</span> <span class="pre">-</span> <span class="pre">1</span></tt>.</td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="id333"> |
| <h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3> |
| <p>Amortized constant time.</p> |
| </div> |
| <div class="section" id="id334"> |
| <h3><a class="subsection-title" href="#example" name="example">Example</a></h3> |
| <pre class="literal-block"> |
| typedef <a href="./vector.html" class="identifier">vector</a><long>::type types1; |
| typedef <a href="./vector.html" class="identifier">vector</a><int,long>::type types2; |
| typedef <a href="./vector.html" class="identifier">vector</a><char,int,long>::type types3; |
| |
| typedef <a href="./pop-front.html" class="identifier">pop_front</a><types1>::type result1; |
| typedef <a href="./pop-front.html" class="identifier">pop_front</a><types2>::type result2; |
| typedef <a href="./pop-front.html" class="identifier">pop_front</a><types3>::type result3; |
| |
| <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./size.html" class="identifier">size</a><result1>::value, ==, 0 ); |
| <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./size.html" class="identifier">size</a><result2>::value, ==, 1 ); |
| <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./size.html" class="identifier">size</a><result3>::value, ==, 2 ); |
| |
| <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< <a href="./front.html" class="identifier">front</a><result2>::type, long > )); |
| <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< <a href="./front.html" class="identifier">front</a><result3>::type, int > )); |
| </pre> |
| </div> |
| <div class="section" id="id335"> |
| <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3> |
| <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> |
| <!-- Sequences/Intrinsic Metafunctions//push_back --> |
| </div> |
| </div> |
| |
| <div class="footer-separator"></div> |
| <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> <a href="./push-back.html" class="navigation-link">Next</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./pop-back.html" class="navigation-link">Back</a> <a href="./push-back.html" class="navigation-link">Along</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./intrinsic-metafunctions.html" class="navigation-link">Up</a> <a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td> |
| <td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| 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> |
| </html> |
