mirror of
https://github.com/boostorg/range.git
synced 2025-07-29 04:17:39 +02:00
Boost.Range documentation update iteration.
[SVN r61647]
This commit is contained in:
32
doc/reference/algorithm_ext/copy_n.qbk
Normal file
32
doc/reference/algorithm_ext/copy_n.qbk
Normal file
@ -0,0 +1,32 @@
|
||||
[section:copy_n copy_n]
|
||||
|
||||
[heading Prototype]
|
||||
|
||||
``
|
||||
template<class SinglePassRange, class Size, class OutputIterator>
|
||||
OutputIterator copy_n(const SinglePassRange& rng, Size n, OutputIterator out);
|
||||
``
|
||||
|
||||
[heading Description]
|
||||
|
||||
`copy_n` is provided to completely replicate the standard algorithm header,
|
||||
it is preferable to use Range Adaptors and the extension functions to achieve
|
||||
the same result with greater safety.
|
||||
|
||||
`copy_n` copies elements from `[boost::begin(rng), boost::begin(rng) + n)` to the range `[out, out + n)`
|
||||
|
||||
[heading Definition]
|
||||
|
||||
Defined in the header file `boost/range/algorithm_ext/copy_n.hpp`
|
||||
|
||||
[heading Requirements]
|
||||
|
||||
# `SinglePassRange` is a model of the __single_pass_range__ Concept.
|
||||
# `Size` is a model of the `Integer` Concept.
|
||||
# `OutputIterator` is a model of the `OutputIteratorConcept`.
|
||||
|
||||
[heading Complexity]
|
||||
|
||||
Linear. Exactly `n` elements are copied.
|
||||
|
||||
[endsect]
|
35
doc/reference/algorithm_ext/is_sorted.qbk
Normal file
35
doc/reference/algorithm_ext/is_sorted.qbk
Normal file
@ -0,0 +1,35 @@
|
||||
[section:is_sorted is_sorted]
|
||||
|
||||
[heading Prototype]
|
||||
|
||||
``
|
||||
template<class SinglePassRange>
|
||||
bool is_sorted(const SinglePassRange& rng);
|
||||
|
||||
template<class SinglePassRange, class BinaryPredicate>
|
||||
bool is_sorted(const SinglePassRange& rng, BinaryPredicate pred);
|
||||
``
|
||||
|
||||
[heading Description]
|
||||
|
||||
`is_sorted` determines if a range is sorted.
|
||||
For the non-predicate version the return value is `true` if and only if for
|
||||
each adjacent elements `[x,y]` the expression `x < y` is `true`.
|
||||
For the predicate version the return value is `true` is and only if for each
|
||||
adjacent elements `[x,y]` the expression `pred(x,y)` is `true`.
|
||||
|
||||
[heading Definition]
|
||||
|
||||
Defined in the header file `boost/range/algorithm_ext/is_sorted.hpp`
|
||||
|
||||
[heading Requirements]
|
||||
|
||||
# `SinglePassRange` is a model of the __single_pass_range__ Concept.
|
||||
# `BinaryPredicate` is a model of the `BinaryPredicate` Concept.
|
||||
# The value type of `SinglePassRange` is convertible to both argument types of `BinaryPredicate`.
|
||||
|
||||
[heading Complexity]
|
||||
|
||||
Linear. A maximum of `distance(rng)` comparisons are performed.
|
||||
|
||||
[endsect]
|
Reference in New Issue
Block a user