Boost.Range minor documentation corrections and code comment fixes.

[SVN r61014]
This commit is contained in:
Neil Groves
2010-04-03 09:02:21 +00:00
parent 629ab6adbf
commit b4ae711d4e
91 changed files with 534 additions and 533 deletions

View File

@ -11,7 +11,7 @@ template<
OutputIterator merge(const SinglePassRange1& rng1,
const SinglePassRange2& rng2,
OutputIterator out);
template<
class SinglePassRange1,
class SinglePassRange2,
@ -68,8 +68,8 @@ Defined in the header file `boost/range/algorithm/merge.hpp`
[heading For the predicate version:]
* The elements of `rng1` is in ascending order. That is, for each adjacent element pair `[x,y]`, of `rng1`, `pred(y, x) == false`.
* The elements of `rng2` is in ascending order. That is, for each adjacent element pair `[x,y]`, of `rng2`, `pred(y, x) == false`.
* The elements of `rng1` are in ascending order. That is, for each adjacent element pair `[x,y]`, of `rng1`, `pred(y, x) == false`.
* The elements of `rng2` are in ascending order. That is, for each adjacent element pair `[x,y]`, of `rng2`, `pred(y, x) == false`.
* The ranges `rng1` and `[out, out + distance(rng1) + distance(rng2))` do not overlap.
* The ranges `rng2` and `[out, out + distance(rng1) + distance(rng2))` do not overlap.
* `[out, out + distance(rng1) + distance(rng2))` is a valid range.

View File

@ -30,7 +30,7 @@ stable_partition(const ForwardRange& rng, UnaryPredicate pred);
[heading Description]
`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 table.
`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.
For the versions that return an iterator, the return value is the iterator to the first element that fails to satisfy `pred`.