Category: algorithms | Component type: function |
template <class ForwardIterator, class T> ForwardIterator remove(ForwardIterator first, ForwardIterator last, const T& value);
vector<int> V; V.push_back(3); V.push_back(1); V.push_back(4); V.push_back(1); V.push_back(5); V.push_back(9); copy(V.begin(), V.end(), ostream_iterator<int>(cout, " ")); // The output is "3 1 4 1 5 9". vector<int>::iterator new_end = remove(V.begin(), V.end(), 1); copy(V.begin(), new_end, ostream_iterator<int>(cout, " ")); // The output is "3 4 5 9".
[1] The meaning of "removal" is somewhat subtle. Remove does not destroy any iterators, and does not change the distance between first and last. (There's no way that it could do anything of the sort.) So, for example, if V is a vector, remove(V.begin(), V.end(), 0) does not change V.size(): V will contain just as many elements as it did before. Remove returns an iterator that points to the end of the resulting range after elements have been removed from it; it follows that the elements after that iterator are of no interest, and may be discarded. If you are removing elements from a Sequence, you may simply erase them. That is, a reasonable way of removing elements from a Sequence is S.erase(remove(S.begin(), S.end(), x), S.end()).