1[/ 2 Copyright 2010 Neil Groves 3 Distributed under the Boost Software License, Version 1.0. 4 (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 5/] 6[section:push_heap push_heap] 7 8[heading Prototype] 9 10`` 11template<class RandomAccessRange> 12RandomAccessRange& push_heap(RandomAccessRange& rng); 13 14template<class RandomAccessRange> 15const RandomAccessRange& push_heap(const RandomAccessRange& rng); 16 17template<class RandomAccessRange, class Compare> 18RandomAccessRange& push_heap(RandomAccessRange& rng, Compare pred); 19 20template<class RandomAccessRange, class Compare> 21const RandomAccessRange& push_heap(const RandomAccessRange& rng, Compare pred); 22`` 23 24[heading Description] 25 26`push_heap` adds an element to a heap. It is assumed that `begin(rng)`, `prior(end(rng))` is already a heap and that the element to be added is `*prior(end(rng))`. 27 28The ordering relationship is determined by using `operator<` in the non-predicate versions, and by evaluating `pred` in the predicate versions. 29 30[heading Definition] 31 32Defined in the header file `boost/range/algorithm/heap_algorithm.hpp` 33 34[heading Requirements] 35 36[*For the non-predicate versions:] 37 38* `RandomAccessRange` is a model of the __random_access_range__ Concept. 39* `RandomAccessRange` is mutable. 40* `RandomAccessRange`'s value type is a model of the `LessThanComparableConcept`. 41* The ordering of objects of type `RandomAccessRange`'s value type is a [*/strict weak ordering/], as defined in the `LessThanComparableConcept` requirements. 42 43[*For the predicate versions:] 44 45* `RandomAccessRange` is a model of the __random_access_range__ Concept. 46* `RandomAccessRange` is mutable. 47* `Compare` is a model of the `StrictWeakOrderingConcept`. 48* `RandomAccessRange`'s value type is convertible to both of `Compare`'s argument types. 49 50[heading Precondition:] 51 52* `!empty(rng)` 53* `[begin(rng), prior(end(rng)))` is a heap. 54 55[heading Complexity] 56 57Logarithmic. At most `log(distance(rng))` comparisons. 58 59[endsect] 60 61 62