1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>remove</title> 5<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> 8<link rel="up" href="../mutating.html" title="Mutating algorithms"> 9<link rel="prev" href="random_shuffle.html" title="random_shuffle"> 10<link rel="next" href="remove_copy.html" title="remove_copy"> 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="random_shuffle.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.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="remove_copy.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.mutating.remove"></a><a class="link" href="remove.html" title="remove">remove</a> 28</h5></div></div></div> 29<h6> 30<a name="range.reference.algorithms.mutating.remove.h0"></a> 31 <span class="phrase"><a name="range.reference.algorithms.mutating.remove.prototype"></a></span><a class="link" href="remove.html#range.reference.algorithms.mutating.remove.prototype">Prototype</a> 32 </h6> 33<p> 34</p> 35<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 36 <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> 37 <span class="keyword">class</span> <span class="identifier">Value</span> 38 <span class="special">></span> 39<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> 40<span class="identifier">remove</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">);</span> 41 42<span class="keyword">template</span><span class="special"><</span> 43 <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> 44 <span class="keyword">class</span> <span class="identifier">Value</span> 45 <span class="special">></span> 46<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> 47<span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">);</span> 48 49<span class="keyword">template</span><span class="special"><</span> 50 <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> 51 <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> 52 <span class="keyword">class</span> <span class="identifier">Value</span> 53 <span class="special">></span> 54<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span><span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> 55<span class="identifier">remove</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">);</span> 56 57<span class="keyword">template</span><span class="special"><</span> 58 <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> 59 <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> 60 <span class="keyword">class</span> <span class="identifier">Value</span> 61 <span class="special">></span> 62<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">,</span><span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> 63<span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Value</span><span class="special">&</span> <span class="identifier">val</span><span class="special">);</span> 64</pre> 65<p> 66 </p> 67<h6> 68<a name="range.reference.algorithms.mutating.remove.h1"></a> 69 <span class="phrase"><a name="range.reference.algorithms.mutating.remove.description"></a></span><a class="link" href="remove.html#range.reference.algorithms.mutating.remove.description">Description</a> 70 </h6> 71<p> 72 <code class="computeroutput"><span class="identifier">remove</span></code> removes from 73 <code class="computeroutput"><span class="identifier">rng</span></code> all of the elements 74 <code class="computeroutput"><span class="identifier">x</span></code> for which <code class="computeroutput"><span class="identifier">x</span> <span class="special">==</span> <span class="identifier">val</span></code> is <code class="computeroutput"><span class="keyword">true</span></code>. 75 The versions of <code class="computeroutput"><span class="identifier">remove</span></code> 76 that return an iterator, return an iterator <code class="computeroutput"><span class="identifier">new_last</span></code> 77 such that the range <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">new_last</span><span class="special">)</span></code> contains no elements equal to <code class="computeroutput"><span class="identifier">val</span></code>. The <code class="computeroutput"><span class="identifier">range_return</span></code> 78 versions of <code class="computeroutput"><span class="identifier">remove</span></code> defines 79 <code class="computeroutput"><span class="identifier">found</span></code> as the new last 80 element. The iterators in the range <code class="computeroutput"><span class="special">[</span><span class="identifier">new_last</span><span class="special">,</span> 81 <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> 82 are dereferenceable, but the elements are unspecified. 83 </p> 84<h6> 85<a name="range.reference.algorithms.mutating.remove.h2"></a> 86 <span class="phrase"><a name="range.reference.algorithms.mutating.remove.definition"></a></span><a class="link" href="remove.html#range.reference.algorithms.mutating.remove.definition">Definition</a> 87 </h6> 88<p> 89 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</span><span class="special">/</span><span class="identifier">remove</span><span class="special">.</span><span class="identifier">hpp</span></code> 90 </p> 91<h6> 92<a name="range.reference.algorithms.mutating.remove.h3"></a> 93 <span class="phrase"><a name="range.reference.algorithms.mutating.remove.requirements"></a></span><a class="link" href="remove.html#range.reference.algorithms.mutating.remove.requirements">Requirements</a> 94 </h6> 95<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 96<li class="listitem"> 97 <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a 98 model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward 99 Range</a> Concept. 100 </li> 101<li class="listitem"> 102 <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable. 103 </li> 104<li class="listitem"> 105 <code class="computeroutput"><span class="identifier">Value</span></code> is a model 106 of the <code class="computeroutput"><span class="identifier">EqualityComparableConcept</span></code>. 107 </li> 108<li class="listitem"> 109 Objects of type <code class="computeroutput"><span class="identifier">Value</span></code> 110 can be compared for equality with objects of <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s 111 value type. 112 </li> 113</ul></div> 114<h6> 115<a name="range.reference.algorithms.mutating.remove.h4"></a> 116 <span class="phrase"><a name="range.reference.algorithms.mutating.remove.complexity"></a></span><a class="link" href="remove.html#range.reference.algorithms.mutating.remove.complexity">Complexity</a> 117 </h6> 118<p> 119 Linear. <code class="computeroutput"><span class="identifier">remove</span></code> performs 120 exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> 121 comparisons for equality. 122 </p> 123</div> 124<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 125<td align="left"></td> 126<td align="right"><div class="copyright-footer">Copyright © 2003-2010 Thorsten Ottosen, 127 Neil Groves<p> 128 Distributed under the Boost Software License, Version 1.0. (See accompanying 129 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>) 130 </p> 131</div></td> 132</tr></table> 133<hr> 134<div class="spirit-nav"> 135<a accesskey="p" href="random_shuffle.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.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="remove_copy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 136</div> 137</body> 138</html> 139
