mirror of
https://github.com/boostorg/range.git
synced 2025-07-31 05:17:24 +02:00
Boost.RangeEx merged into Boost.Range
[SVN r60897]
This commit is contained in:
51
doc/reference/algorithm/make_heap.qbk
Normal file
51
doc/reference/algorithm/make_heap.qbk
Normal file
@ -0,0 +1,51 @@
|
||||
[section:make_heap make_heap]
|
||||
|
||||
[heading Prototype]
|
||||
|
||||
``
|
||||
template<class RandomAccessRange>
|
||||
void make_heap(RandomAccessRange& rng);
|
||||
|
||||
template<class RandomAccessRange>
|
||||
void make_heap(const RandomAccessRange& rng);
|
||||
|
||||
template<class RandomAccessRange, class Compare>
|
||||
void make_heap(RandomAccessRange& rng, Compare pred);
|
||||
|
||||
template<class RandomAccessRange, class Compare>
|
||||
void make_heap(const RandomAccessRange& rng, Compare pred);
|
||||
``
|
||||
|
||||
[heading Description]
|
||||
|
||||
`make_heap` turns `rng` into a heap.
|
||||
|
||||
The ordering relationship is determined by using `operator<` in the non-predicate versions, and by evaluating `pred` in the predicate versions.
|
||||
|
||||
[heading Definition]
|
||||
|
||||
Defined in the header file `boost/range/algorithm/heap_algorithm.hpp`
|
||||
|
||||
[heading Requirements]
|
||||
|
||||
[*For the non-predicate versions:]
|
||||
|
||||
* `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 of objects of type `RandomAccessRange`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements.
|
||||
|
||||
[*For the predicate versions:]
|
||||
|
||||
* `RandomAccessRange` is a model of the __random_access_range__ Concept.
|
||||
* `RandomAccessRange` is mutable.
|
||||
* `Compare` is a model of the `StrictWeakOrderingConcept`.
|
||||
* `RandomAccessRange`'s value type is convertible to both of `Compare`'s argument types.
|
||||
|
||||
[heading Complexity]
|
||||
|
||||
Linear. At most `3 * distance(rng)` comparisons.
|
||||
|
||||
[endsect]
|
||||
|
||||
|
Reference in New Issue
Block a user