stable_partition.qbk 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  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:stable_partition stable_partition]
  7. [heading Prototype]
  8. ``
  9. template<class ForwardRange, class UnaryPredicate>
  10. typename range_iterator<ForwardRange>::type
  11. stable_partition(ForwardRange& rng, UnaryPredicate pred);
  12. template<class ForwardRange, class UnaryPredicate>
  13. typename range_iterator<const ForwardRange>::type
  14. stable_partition(const ForwardRange& rng, UnaryPredicate pred);
  15. template<
  16. range_return_value re,
  17. class ForwardRange,
  18. class UnaryPredicate
  19. >
  20. typename range_return<ForwardRange, re>::type
  21. stable_partition(ForwardRange& rng, UnaryPredicate pred);
  22. template<
  23. range_return_value re,
  24. class ForwardRange,
  25. class UnaryPredicate
  26. >
  27. typename range_return<const ForwardRange, re>::type
  28. stable_partition(const ForwardRange& rng, UnaryPredicate pred);
  29. ``
  30. [heading Description]
  31. `stable_partition` reorders the elements in the range `rng` base on the function object `pred`. Once this function has completed all of the elements that satisfy `pred` appear before all of the elements that fail to satisfy it. `stable_partition` differs from `partition` because it preserves relative order. It is stable.
  32. For the versions that return an iterator, the return value is the iterator to the first element that fails to satisfy `pred`.
  33. For versions that return a `range_return`, the `found` iterator is the iterator to the first element that fails to satisfy `pred`.
  34. [heading Definition]
  35. Defined in the header file `boost/range/algorithm/stable_partition.hpp`
  36. [heading Requirements]
  37. * `ForwardRange` is a model of the __forward_range__ Concept.
  38. * `ForwardRange` is mutable.
  39. * `UnaryPredicate` is a model of the `PredicateConcept`.
  40. [heading Complexity]
  41. Best case: `O(N)` where `N` is `distance(rng)`.
  42. Worst case: `N * log(N)` swaps, where `N` is `distance(rng)`.
  43. [endsect]