summaryrefslogtreecommitdiff
path: root/libs/range/doc/reference/algorithm_ext/remove_erase_if.qbk
diff options
context:
space:
mode:
Diffstat (limited to 'libs/range/doc/reference/algorithm_ext/remove_erase_if.qbk')
-rw-r--r--libs/range/doc/reference/algorithm_ext/remove_erase_if.qbk34
1 files changed, 34 insertions, 0 deletions
diff --git a/libs/range/doc/reference/algorithm_ext/remove_erase_if.qbk b/libs/range/doc/reference/algorithm_ext/remove_erase_if.qbk
new file mode 100644
index 0000000000..5eab446697
--- /dev/null
+++ b/libs/range/doc/reference/algorithm_ext/remove_erase_if.qbk
@@ -0,0 +1,34 @@
+[/
+ Copyright 2010 Neil Groves
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+/]
+[section:remove_erase_if remove_erase_if]
+
+[heading Prototype]
+
+``
+template<class Container, class Pred>
+Container& remove_erase_if(Container& target,
+ Pred pred);
+``
+
+[heading Description]
+
+`remove_erase_if` removes the elements `x` that satisfy `pred(x)` from the container.
+This is in contrast to the `erase` algorithm which merely rearranges elements.
+
+[heading Definition]
+
+Defined in the header file `boost/range/algorithm_ext/erase.hpp`
+
+[heading Requirements]
+
+# `Container` supports erase of an iterator range.
+# `Pred` is a model of the `Predicate` Concept.
+
+[heading Complexity]
+
+Linear. Proportional to `distance(target)`s.
+
+[endsect]