mirror of
https://github.com/boostorg/range.git
synced 2025-07-29 12:27:42 +02:00
Boost.RangeEx merged into Boost.Range
[SVN r60897]
This commit is contained in:
53
doc/reference/algorithm/sort.qbk
Normal file
53
doc/reference/algorithm/sort.qbk
Normal file
@ -0,0 +1,53 @@
|
||||
[section:sort Range Algorithm - sort]
|
||||
|
||||
[heading Prototype]
|
||||
|
||||
``
|
||||
template<class RandomAccessRange>
|
||||
RandomAccessRange& sort(RandomAccessRange& rng);
|
||||
|
||||
template<class RandomAccessRange>
|
||||
const RandomAccessRange& sort(const RandomAccessRange& rng);
|
||||
|
||||
template<class RandomAccessRange, class BinaryPredicate>
|
||||
RandomAccessRange& sort(RandomAccessRange& rng, BinaryPredicate pred);
|
||||
|
||||
template<class RandomAccessRange, class BinaryPredicate>
|
||||
const RandomAccessRange& sort(const RandomAccessRange& rng, BinaryPredicate pred);
|
||||
``
|
||||
|
||||
[heading Description]
|
||||
|
||||
`sort` sorts the elements in `rng` into ascending order. `sort` is not guaranteed to be stable. Returns the sorted range.
|
||||
|
||||
For versions of the `sort` function without a predicate, ascending order is defined by `operator<()` such that for all adjacent elements `[x,y]`, `y < x == false`.
|
||||
|
||||
For versions of the `sort` function with a predicate, ascending order is defined by `pred` such that for all adjacent elements `[x,y]`, `pred(y, x) == false`.
|
||||
|
||||
[heading Definition]
|
||||
|
||||
Defined in the header file `boost/range/algorithm/sort.hpp`
|
||||
|
||||
[heading Requirements]
|
||||
|
||||
[*For versions of sort without a predicate:]
|
||||
|
||||
* `RandomAccessRange` is a model of the __random_access_range__ Concept.
|
||||
* `RandomAccessRange` is mutable.
|
||||
* `RandomAccessRange`'s value type is a model of the `LessThanComparableConcept`.
|
||||
* The ordering relation on `RandomAccessRange`'s value type is a [*strict weak ordering], as defined in the `LessThanComparableConcept` requirements.
|
||||
|
||||
[*For versions of sort with a predicate]
|
||||
|
||||
* `RandomAccessRange` is a model of the __random_access_range__ Concept.
|
||||
* `RandomAccessRange` is mutable.
|
||||
* `BinaryPredicate` is a model of the `StrictWeakOrderingConcept`.
|
||||
* `RandomAccessRange`'s value type is convertible to both of `BinaryPredicate`'s argument types.
|
||||
|
||||
[heading Complexity]
|
||||
|
||||
`O(N log(N))` comparisons (both average and worst-case), where `N` is `distance(rng)`.
|
||||
|
||||
[endsect]
|
||||
|
||||
|
Reference in New Issue
Block a user