123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199 |
- <?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: erase</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="./end.html" class="navigation-link">Prev</a> <a href="./erase-key.html" class="navigation-link">Next</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./end.html" class="navigation-link">Back</a> <a href="./erase-key.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="./erase.html" class="navigation-link">erase</a></td>
- </tr></table><div class="header-separator"></div>
- <div class="section" id="erase">
- <h1><a class="toc-backref" href="./intrinsic-metafunctions.html#id1432">erase</a></h1>
- <div class="section" id="id238">
- <h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
- <pre class="literal-block">
- template<
- typename Sequence
- , typename First
- , typename Last = <em>unspecified</em>
- >
- struct <a href="./erase.html" class="identifier">erase</a>
- {
- typedef <em>unspecified</em> type;
- };
- </pre>
- </div>
- <div class="section" id="id239">
- <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
- <p><tt class="literal"><span class="pre"><a href="./erase.html" class="identifier">erase</a></span></tt> performs a removal of one or more adjacent elements in the sequence
- starting from an arbitrary position.</p>
- </div>
- <div class="section" id="id240">
- <h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
- <pre class="literal-block">
- #include <<a href="../../../../boost/mpl/erase.hpp" class="header">boost/mpl/erase.hpp</a>>
- </pre>
- </div>
- <div class="section" id="id241">
- <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="id242">
- <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="./extensible-sequence.html">Extensible Sequence</a> or
- <a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a></td>
- <td>A sequence to erase from.</td>
- </tr>
- <tr><td><tt class="literal"><span class="pre">First</span></tt></td>
- <td><a class="reference internal" href="./forward-iterator.html">Forward Iterator</a></td>
- <td>An iterator to the beginning of the range to
- be erased.</td>
- </tr>
- <tr><td><tt class="literal"><span class="pre">Last</span></tt></td>
- <td><a class="reference internal" href="./forward-iterator.html">Forward Iterator</a></td>
- <td>An iterator past-the-end of the range to be
- erased.</td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="section" id="id243">
- <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
- <div class="expression-semantics compound">
- <p class="compound-first">For any <a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a> <tt class="literal"><span class="pre">s</span></tt>, and iterators <tt class="literal"><span class="pre">pos</span></tt>, <tt class="literal"><span class="pre">first</span></tt> and <tt class="literal"><span class="pre">last</span></tt> into <tt class="literal"><span class="pre">s</span></tt>:</p>
- <pre class="compound-middle literal-block">
- typedef <a href="./erase.html" class="identifier">erase</a><s,first,last>::type r;
- </pre>
- <table class="compound-middle 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"><p class="first"><a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a>.</p>
- </td>
- </tr>
- <tr class="field"><th class="field-name">Precondition:</th><td class="field-body"><p class="first"><tt class="literal"><span class="pre">[first,last)</span></tt> is a valid range in <tt class="literal"><span class="pre">s</span></tt>.</p>
- </td>
- </tr>
- <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first"><tt class="literal"><span class="pre">r</span></tt> is a new sequence, <a class="reference internal" href="./terminology.html#concept-identical">concept-identical</a> to <tt class="literal"><span class="pre">s</span></tt>, of the following elements:
- [<tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a><s>::type</span></tt>, <tt class="literal"><span class="pre">pos</span></tt>), [<tt class="literal"><span class="pre">last</span></tt>, <tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a><s>::type</span></tt>).</p>
- </td>
- </tr>
- <tr class="field"><th class="field-name">Postcondition:</th><td class="field-body"><p class="first">The relative order of the elements in <tt class="literal"><span class="pre">r</span></tt> is the same as in <tt class="literal"><span class="pre">s</span></tt>;</p>
- <pre class="last literal-block">
- <a href="./size.html" class="identifier">size</a><r>::value == <a href="./size.html" class="identifier">size</a><s>::value - <a href="./distance.html" class="identifier">distance</a><first,last>::value
- </pre>
- </td>
- </tr>
- </tbody>
- </table>
- <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
- <pre class="compound-middle literal-block">
- typedef <a href="./erase.html" class="identifier">erase</a><s,pos>::type r;
- </pre>
- <table class="compound-last 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"><p class="first"><a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a>.</p>
- </td>
- </tr>
- <tr class="field"><th class="field-name">Precondition:</th><td class="field-body"><p class="first"><tt class="literal"><span class="pre">pos</span></tt> is a dereferenceable iterator in <tt class="literal"><span class="pre">s</span></tt>.</p>
- </td>
- </tr>
- <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
- <pre class="last literal-block">
- typedef <a href="./erase.html" class="identifier">erase</a>< s,pos,<a href="./next.html" class="identifier">next</a><pos>::type >::type r;
- </pre>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="expression-semantics compound">
- <p class="compound-first">For any <a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a> <tt class="literal"><span class="pre">s</span></tt>, and iterator <tt class="literal"><span class="pre">pos</span></tt> into <tt class="literal"><span class="pre">s</span></tt>:</p>
- <pre class="compound-middle literal-block">
- typedef <a href="./erase.html" class="identifier">erase</a><s,pos>::type r;
- </pre>
- <table class="compound-last 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="./extensible-sequence.html">Extensible Sequence</a>.</td>
- </tr>
- <tr class="field"><th class="field-name">Precondition:</th><td class="field-body"><tt class="literal"><span class="pre">pos</span></tt> is a dereferenceable iterator to <tt class="literal"><span class="pre">s</span></tt>.</td>
- </tr>
- <tr class="field"><th class="field-name">Semantics:</th><td class="field-body">Erases the element at a specific position <tt class="literal"><span class="pre">pos</span></tt>; equivalent to
- <tt class="literal"><span class="pre"><a href="./erase-key.html" class="identifier">erase_key</a><s,</span> <span class="pre"><a href="./deref.html" class="identifier">deref</a><pos>::type</span> <span class="pre">>::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>
- <div class="section" id="id244">
- <h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
- <table border="1" class="docutils table">
- <colgroup>
- <col width="45%" />
- <col width="55%" />
- </colgroup>
- <thead valign="bottom">
- <tr><th class="head">Sequence archetype</th>
- <th class="head">Complexity (the range form)</th>
- </tr>
- </thead>
- <tbody valign="top">
- <tr><td><a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a></td>
- <td>Amortized constant time.</td>
- </tr>
- <tr><td><a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a></td>
- <td>Quadratic in the worst case, linear at best.</td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="section" id="id245">
- <h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
- <pre class="literal-block">
- typedef <a href="./vector-c.html" class="identifier">vector_c</a><int,1,0,5,1,7,5,0,5> values;
- typedef <a href="./find.html" class="identifier">find</a>< values, <a href="./integral-c.html" class="identifier">integral_c</a><int,7> >::type pos;
- typedef <a href="./erase.html" class="identifier">erase</a><values,pos>::type result;
- <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./size.html" class="identifier">size</a><result>::value, ==, 7 );
- typedef <a href="./find.html" class="identifier">find</a><result, <a href="./integral-c.html" class="identifier">integral_c</a><int,7> >::type iter;
- <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same< iter, <a href="./end.html" class="identifier">end</a><result>::type > ));
- </pre>
- </div>
- <div class="section" id="id246">
- <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
- <p><a class="reference internal" href="./extensible-sequence.html">Extensible Sequence</a>, <a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a>, <a class="reference internal" href="./erase-key.html">erase_key</a>, <a class="reference internal" href="./pop-front.html">pop_front</a>, <a class="reference internal" href="./pop-back.html">pop_back</a>, <a class="reference internal" href="./insert.html">insert</a></p>
- <!-- Sequences/Intrinsic Metafunctions//erase_key -->
- </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="./end.html" class="navigation-link">Prev</a> <a href="./erase-key.html" class="navigation-link">Next</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./end.html" class="navigation-link">Back</a> <a href="./erase-key.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>
|