Boost.Range updated the return types of various algorithms to improve consistency. This is to address a specific request made during the formal review of Boost.RangeEx.

[SVN r61211]
This commit is contained in:
Neil Groves
2010-04-11 22:05:02 +00:00
parent cab01e8ba3
commit 350a1f8bfc
108 changed files with 937 additions and 605 deletions

View File

@ -3,18 +3,20 @@
[heading Prototype]
``
template<
class Container,
class SinglePassRange
>
void erase(Container& target,
iterator_range<typename Container::iterator> to_erase);
template<class Container>
Container& erase(
Container& target,
iterator_range<typename Container::iterator> to_erase);
``
[heading Description]
`erase` the iterator range `to_erase` from the container `target`.
`remove_erase` performs the frequently used combination equivalent to `target.erase(std::remove(target.begin(), target.end(), value), target.end());`
`remove_erase_if` performs the frequently used combination equivalent to `target.erase(std::remove_if(target.begin(), target.end(), pred), target.end());`
[heading Definition]
Defined in the header file `boost/range/algorithm_ext/erase.hpp`

View File

@ -7,9 +7,9 @@ template<
class Container,
class SinglePassRange
>
void insert(Container& target,
typename Container::iterator before,
const SinglePassRange& from);
Container& insert(Container& target,
typename Container::iterator before,
const SinglePassRange& from);
``
[heading Description]

View File

@ -3,8 +3,8 @@
[heading Prototype]
``
template<class SinglePassRange, class Value>
iota(SinglePassRange& rng, Value x);
template<class ForwardRange, class Value>
ForwardRange& iota(ForwardRange& rng, Value x);
``
[heading Description]
@ -18,7 +18,7 @@ Defined in the header file `boost/range/algorithm_ext/iota.hpp`
[heading Requirements]
# `SinglePassRange` is a model of the __single_pass_range__ Concept.
# `ForwardRange` is a model of the __forward_range__ Concept.
# `Value` is a model of the `Incrementable` Concept.
[heading Complexity]

View File

@ -7,8 +7,8 @@ template<
class Container,
class SinglePassRange
>
void push_back(Container& target,
const SinglePassRange& from);
Container& push_back(Container& target,
const SinglePassRange& from);
``
[heading Description]

View File

@ -7,8 +7,8 @@ template<
class Container,
class SinglePassRange
>
void push_front(Container& target,
const SinglePassRange& from);
Container& push_front(Container& target,
const SinglePassRange& from);
``
[heading Description]

View File

@ -3,17 +3,14 @@
[heading Prototype]
``
template<
class Container,
class T
>
void remove_erase(Container& target,
const T& val);
template<class Container, class Value>
Container& remove_erase(Container& target,
const Value& value);
``
[heading Description]
`remove_erase` actually eliminates the elements equal to `val` from the container. This
`remove_erase` actually eliminates the elements equal to `value` from the container. This
is in contrast to the `remove` algorithm which merely rearranges elements.
[heading Definition]

View File

@ -3,12 +3,9 @@
[heading Prototype]
``
template<
class Container,
class Pred
>
void remove_erase(Container& target,
Pred pred);
template<class Container, class Pred>
Container& remove_erase_if(Container& target,
Pred pred);
``
[heading Description]