remove_if.qbk 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. [/
  2. Copyright 2010 Neil Groves
  3. Distributed under the Boost Software License, Version 1.0.
  4. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  5. /]
  6. [section:remove_if remove_if]
  7. [heading Prototype]
  8. ``
  9. template<
  10. class ForwardRange,
  11. class UnaryPredicate
  12. >
  13. typename range_iterator<ForwardRange>::type
  14. remove_if(ForwardRange& rng, UnaryPredicate pred);
  15. template<
  16. class ForwardRange,
  17. class UnaryPredicate
  18. >
  19. typename range_iterator<const ForwardRange>::type
  20. remove_if(const ForwardRange& rng, UnaryPredicate pred);
  21. template<
  22. range_return_value re,
  23. class ForwardRange,
  24. class UnaryPredicate
  25. >
  26. typename range_return<ForwardRange,re>::type
  27. remove_if(ForwardRange& rng, UnaryPredicate pred);
  28. template<
  29. range_return_value re,
  30. class ForwardRange,
  31. class UnaryPredicate
  32. >
  33. typename range_return<const ForwardRange,re>::type
  34. remove_if(const ForwardRange& rng, UnaryPredicate pred);
  35. ``
  36. [heading Description]
  37. `remove_if` removes from `rng` all of the elements `x` for which `pred(x)` is `true`. The versions of `remove_if` that return an iterator, return an iterator `new_last` such that the range `[begin(rng), new_last)` contains no elements where `pred(x)` is `true`. The iterators in the range `[new_last, end(rng))` are dereferenceable, but the elements are unspecified.
  38. [heading Definition]
  39. Defined in the header file `boost/range/algorithm/remove_if.hpp`
  40. [heading Requirements]
  41. * `ForwardRange` is a model of the __forward_range__ Concept.
  42. * `ForwardRange` is mutable.
  43. * `UnaryPredicate` is a model of the `PredicateConcept`.
  44. * `ForwardRange`'s value type is convertible to `UnaryPredicate`'s argument type.
  45. [heading Complexity]
  46. Linear. `remove_if` performs exactly `distance(rng)` applications of `pred`.
  47. [endsect]