libs/range/doc/html/range/reference/algorithms/new/erase.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>erase</title>
   5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Range 2.0">
   8 <link rel="up" href="../new.html" title="New algorithms">
   9 <link rel="prev" href="copy_n.html" title="copy_n">
  10 <link rel="next" href="for_each.html" title="for_each">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="copy_n.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="for_each.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="range.reference.algorithms.new.erase"></a><a class="link" href="erase.html" title="erase">erase</a>
  28 </h5></div></div></div>
  29 <h6>
  30 <a name="range.reference.algorithms.new.erase.h0"></a>
  31             <span class="phrase"><a name="range.reference.algorithms.new.erase.prototype"></a></span><a class="link" href="erase.html#range.reference.algorithms.new.erase.prototype">Prototype</a>
  32           </h6>
  33 <p>
  34 </p>
  35 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">Container</span><span class="special">&gt;</span>
  36 <span class="identifier">Container</span><span class="special">&amp;</span> <span class="identifier">erase</span><span class="special">(</span>
  37     <span class="identifier">Container</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span>
  38     <span class="identifier">iterator_range</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Container</span><span class="special">::</span><span class="identifier">iterator</span><span class="special">&gt;</span> <span class="identifier">to_erase</span><span class="special">);</span>
  39 </pre>
  40 <p>
  41           </p>
  42 <h6>
  43 <a name="range.reference.algorithms.new.erase.h1"></a>
  44             <span class="phrase"><a name="range.reference.algorithms.new.erase.description"></a></span><a class="link" href="erase.html#range.reference.algorithms.new.erase.description">Description</a>
  45           </h6>
  46 <p>
  47             <code class="computeroutput"><span class="identifier">erase</span></code> the iterator range
  48             <code class="computeroutput"><span class="identifier">to_erase</span></code> from the container
  49             <code class="computeroutput"><span class="identifier">target</span></code>.
  50           </p>
  51 <p>
  52             <code class="computeroutput"><span class="identifier">remove_erase</span></code> performs
  53             the frequently used combination equivalent to <code class="computeroutput"><span class="identifier">target</span><span class="special">.</span><span class="identifier">erase</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">remove</span><span class="special">(</span><span class="identifier">target</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">target</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">value</span><span class="special">),</span> <span class="identifier">target</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span></code>
  54           </p>
  55 <p>
  56             <code class="computeroutput"><span class="identifier">remove_erase_if</span></code> performs
  57             the frequently used combination equivalent to <code class="computeroutput"><span class="identifier">target</span><span class="special">.</span><span class="identifier">erase</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">remove_if</span><span class="special">(</span><span class="identifier">target</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">target</span><span class="special">.</span><span class="identifier">end</span><span class="special">(),</span> <span class="identifier">pred</span><span class="special">),</span> <span class="identifier">target</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span></code>
  58           </p>
  59 <h6>
  60 <a name="range.reference.algorithms.new.erase.h2"></a>
  61             <span class="phrase"><a name="range.reference.algorithms.new.erase.definition"></a></span><a class="link" href="erase.html#range.reference.algorithms.new.erase.definition">Definition</a>
  62           </h6>
  63 <p>
  64             Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm_ext</span><span class="special">/</span><span class="identifier">erase</span><span class="special">.</span><span class="identifier">hpp</span></code>
  65           </p>
  66 <h6>
  67 <a name="range.reference.algorithms.new.erase.h3"></a>
  68             <span class="phrase"><a name="range.reference.algorithms.new.erase.requirements"></a></span><a class="link" href="erase.html#range.reference.algorithms.new.erase.requirements">Requirements</a>
  69           </h6>
  70 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  71                 <code class="computeroutput"><span class="identifier">Container</span></code> supports
  72                 erase of an iterator range.
  73               </li></ol></div>
  74 <h6>
  75 <a name="range.reference.algorithms.new.erase.h4"></a>
  76             <span class="phrase"><a name="range.reference.algorithms.new.erase.complexity"></a></span><a class="link" href="erase.html#range.reference.algorithms.new.erase.complexity">Complexity</a>
  77           </h6>
  78 <p>
  79             Linear. Proprotional to <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">to_erase</span><span class="special">)</span></code>.
  80           </p>
  81 </div>
  82 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  83 <td align="left"></td>
  84 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2010 Thorsten Ottosen,
  85       Neil Groves<p>
  86         Distributed under the Boost Software License, Version 1.0. (See accompanying
  87         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  88       </p>
  89 </div></td>
  90 </tr></table>
  91 <hr>
  92 <div class="spirit-nav">
  93 <a accesskey="p" href="copy_n.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../new.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="for_each.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  94 </div>
  95 </body>
  96 </html>