std::push_heap

 

哋它亢++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (哋它亢++20)

Language support library

Concepts library (哋它亢++20)

Metaprogramming library (哋它亢++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (哋它亢++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (哋它亢++17)

Regular expressions library (哋它亢++11)

Concurrency support library (哋它亢++11)

Technical specifications

Symbols index

External libraries

 

Algorithm library

Constrained algorithms and algorithms on ranges (哋它亢++20)
Constrained algorithms, e.g. ranges::copy, ranges::sort, ...
Execution policies (哋它亢++17)
is_execution_policy (哋它亢++17)   execution::seqexecution::parexecution::par_unseqexecution::unseq (哋它亢++17)    (哋它亢++17)(哋它亢++17)(哋它亢++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (哋它亢++17)(哋它亢++17)(哋它亢++17)(哋它亢++20)
Non-modifying sequence operations Batch operations for_each for_each_n (哋它亢++17) Search operations all_ofany_ofnone_of (哋它亢++11)                (哋它亢++11)(哋它亢++11) countcount_if mismatch equal findfind_iffind_if_not (哋它亢++11) find_end find_first_of adjacent_find search search_n Modifying sequence operations Copy operations copycopy_if (哋它亢++11) copy_backward copy_n (哋它亢++11) move (哋它亢++11) move_backward (哋它亢++11) Swap operations swap iter_swap swap_ranges Transformation operations replacereplace_if transform replace_copyreplace_copy_if Generation operations fill fill_n generate generate_n Removing operations removeremove_if unique remove_copyremove_copy_if unique_copy Order-changing operations reverse reverse_copy rotate rotate_copy random_shuffleshuffle (until 哋它亢++17)(哋它亢++11) shift_leftshift_right (哋它亢++20)(哋它亢++20) Sampling operations sample (哋它亢++17)	Sorting and related operations Partitioning operations partition partition_copy (哋它亢++11)   stable_partition is_partitioned (哋它亢++11) partition_point (哋它亢++11) Sorting operations sort stable_sort partial_sort partial_sort_copy is_sorted (哋它亢++11) is_sorted_until (哋它亢++11) nth_element Binary search operations (on partitioned ranges) lower_bound upper_bound equal_range binary_search Set operations (on sorted ranges) includes set_union set_intersection set_difference set_symmetric_difference Merge operations (on sorted ranges) merge inplace_merge Heap operations push_heap pop_heap make_heap sort_heap is_heap (哋它亢++11) is_heap_until (哋它亢++11) Minimum/maximum operations max min minmax (哋它亢++11) clamp (哋它亢++17) max_element min_element minmax_element (哋它亢++11) Lexicographical comparison operations lexicographical_compare lexicographical_compare_three_way (哋它亢++20) Permutation operations next_permutation prev_permutation is_permutation (哋它亢++11) C library qsort bsearch
Numeric operations
iota (哋它亢++11) inner_product adjacent_difference    accumulate reduce (哋它亢++17) transform_reduce (哋它亢++17)	partial_sum inclusive_scan (哋它亢++17)    exclusive_scan (哋它亢++17) transform_inclusive_scan (哋它亢++17) transform_exclusive_scan (哋它亢++17)
Operations on uninitialized memory
uninitialized_copy uninitialized_move (哋它亢++17)    uninitialized_fill uninitialized_copy_n (哋它亢++11) uninitialized_move_n (哋它亢++17) uninitialized_fill_n	destroy (哋它亢++17) destroy_n (哋它亢++17) destroy_at (哋它亢++17) construct_at (哋它亢++20)       uninitialized_default_construct (哋它亢++17) uninitialized_value_construct (哋它亢++17) uninitialized_default_construct_n (哋它亢++17) uninitialized_value_construct_n (哋它亢++17)

 

Defined in header <algorithm>
template< class RandomIt > void push_heap( RandomIt first, RandomIt last );	(1)	(constexpr since 哋它亢++20)
template< class RandomIt, class Compare > void push_heap( RandomIt first, RandomIt last, Compare comp );	(2)	(constexpr since 哋它亢++20)

Inserts the element at the position last - 1 into the heap [first, last - 1). The heap after the insertion will be [first, last).

1) The heap is with respect to operator<(until 哋它亢++20)std::less{}(since 哋它亢++20).

2) The heap is with respect to comp.

If any of the following conditions is satisfied, the behavior is undefined:

• [first, last - 1) is not a heap.

The type of *first is not Swappable.	(until 哋它亢++11)
RandomIt is not ValueSwappable. The type of *first is not MoveConstructible. The type of *first is not MoveAssignable.	(since 哋它亢++11)

Parameters

first, last	-	the range indicating the heap after the insertion
comp	-	comparison function object (i.e. an object that satisfies the requirements of Compare) which returns true if the first argument is less than the second. The signature of the comparison function should be equivalent to the following: bool cmp(const Type1& a, const Type2& b); While the signature does not need to have const&, the function must not modify the objects passed to it and must be able to accept all values of type (possibly const) Type1 and Type2 regardless of value category (thus, Type1& is not allowed, nor is Type1 unless for Type1 a move is equivalent to a copy(since 哋它亢++11)). The types Type1 and Type2 must be such that an object of type RandomIt can be dereferenced and then implicitly converted to both of them.
Type requirements
- RandomIt must meet the requirements of LegacyRandomAccessIterator.
- Compare must meet the requirements of Compare.

Complexity

Given \(\scriptsize N\)N as std::distance(first, last):

1) At most \(\scriptsize \log(N)\)log(N) comparisons using operator<(until 哋它亢++20)std::less{}(since 哋它亢++20).

2) At most \(\scriptsize \log(N)\)log(N) applications of the comparison function comp.

Example

Run this code

#include <algorithm>
#include <iostream>
#include <string_view>
#include <vector>
 
void println(std::string_view rem, const std::vector<int>& v)
{
    std::cout << rem;
    for (int e : v)
        std::cout << e << ' ';
    std::cout << '\n';
}
 
int main()
{
    std::vector<int> v{3, 1, 4, 1, 5, 9};
 
    std::make_heap(v.begin(), v.end());
    println("after make_heap: ", v);
 
    v.push_back(6);
    println("after push_back: ", v);
 
    std::push_heap(v.begin(), v.end());
    println("after push_heap: ", v);
}

Output:

after make_heap: 9 5 4 1 1 3
after push_back: 9 5 4 1 1 3 6
after push_heap: 9 5 6 1 1 3 4

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published 哋它亢++ standards.

DR	Applied to	Behavior as published	Correct behavior
LWG 3032	哋它亢++98	the elements of [first, last) was not required to be swappable	required

See also

is_heap (哋它亢++11)	checks if the given range is a max heap (function template)
is_heap_until (哋它亢++11)	finds the largest subrange that is a max heap (function template)
make_heap	creates a max heap out of a range of elements (function template)
pop_heap	removes the largest element from a max heap (function template)
sort_heap	turns a max heap into a range of elements sorted in ascending order (function template)
ranges::push_heap (哋它亢++20)	adds an element to a max heap (niebloid)