Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/algorithm/ranges/sort heap"

From cppreference.com
< cpp‎ | algorithm‎ | ranges
(created a page for ranges::sort_heap + example)
 
m (- ranges::)
Line 9: Line 9:
 
requires std::sortable<I, Comp, Proj>
 
requires std::sortable<I, Comp, Proj>
 
constexpr I
 
constexpr I
ranges::sort_heap( I first, S last, Comp comp = {}, Proj proj = {} );
+
sort_heap( I first, S last, Comp comp = {}, Proj proj = {} );
 
}}
 
}}
 
{{dcl | num=2 | since=c++20 |1=
 
{{dcl | num=2 | since=c++20 |1=
Line 16: Line 16:
 
requires std::sortable<ranges::iterator_t<R>, Comp, Proj>
 
requires std::sortable<ranges::iterator_t<R>, Comp, Proj>
 
constexpr ranges::borrowed_iterator_t<R>
 
constexpr ranges::borrowed_iterator_t<R>
ranges::sort_heap( R&& r, Comp comp = {}, Proj proj = {} );
+
sort_heap( R&& r, Comp comp = {}, Proj proj = {} );
 
}}
 
}}
 
{{dcl end}}
 
{{dcl end}}

Revision as of 15:07, 8 July 2021

 
 
Algorithm library
Constrained algorithms and algorithms on ranges (C++20)
Constrained algorithms, e.g. ranges::copy, ranges::sort, ...
Execution policies (C++17)
Non-modifying sequence operations
Batch operations
(C++17)
Search operations
(C++11)                (C++11)(C++11)

Modifying sequence operations
Copy operations
(C++11)
(C++11)
Swap operations
Transformation operations
Generation operations
Removing operations
Order-changing operations
(until C++17)(C++11)
(C++20)(C++20)
Sampling operations
(C++17)

Sorting and related operations
Partitioning operations
Sorting operations
Binary search operations
(on partitioned ranges)
Set operations (on sorted ranges)
Merge operations (on sorted ranges)
Heap operations
Minimum/maximum operations
(C++11)
(C++17)
Lexicographical comparison operations
Permutation operations
C library
Numeric operations
Operations on uninitialized memory
 
Constrained algorithms
All names in this menu belong to namespace std::ranges
Non-modifying sequence operations
Modifying sequence operations
Partitioning operations
Sorting operations
Binary search operations (on sorted ranges)
       
       
Set operations (on sorted ranges)
Heap operations
         
sort_heap
Minimum/maximum operations
       
       
Permutation operations
Fold operations
Numeric operations
(C++23)            
Operations on uninitialized storage
Return types
 
Defined in header <algorithm>
Call signature
template< std::random_access_iterator I, std::sentinel_for<I> S,

          class Comp = ranges::less, class Proj = std::identity >
requires std::sortable<I, Comp, Proj>
constexpr I

sort_heap( I first, S last, Comp comp = {}, Proj proj = {} );
(1) (since C++20)
template< ranges::random_access_range R, class Comp = ranges::less,

          class Proj = std::identity >
requires std::sortable<ranges::iterator_t<R>, Comp, Proj>
constexpr ranges::borrowed_iterator_t<R>

sort_heap( R&& r, Comp comp = {}, Proj proj = {} );
(2) (since C++20)

Converts the max heap [first, last) into a sorted range in ascending order. The resulting range no longer has the heap property.

1) Elements are compared using the given binary comparison function comp and projection object proj.
2) Same as (1), but uses r as the range, as if using ranges::begin(r) as first and ranges::end(r) as last.

The function-like entities described on this page are niebloids, that is:

In practice, they may be implemented as function objects, or with special compiler extensions.

Contents

Parameters

first, last - the range of elements to sort
r - the range of elements to sort
pred - predicate to apply to the projected elements
proj - projection to apply to the elements.

Return value

An iterator equal to last.

Complexity

Given N = ranges::distance(first, last), at most 2×N×log(N) comparisons and 4×N×log(N) projections.

Notes

Possible implementation

struct sort_heap_fn {
    template< std::random_access_iterator I, std::sentinel_for<I> S,
              class Comp = ranges::less, class Proj = std::identity >
    requires std::sortable<I, Comp, Proj>
    constexpr I
    operator()( I first, S last, Comp comp = {}, Proj proj = {} ) const {
        auto ret {ranges::next(first, last)};
        for (; first != last; --last) {
            ranges::pop_heap(first, last, comp, proj);
        }
        return ret;
    }
 
    template< ranges::random_access_range R, class Comp = ranges::less,
              class Proj = std::identity >
    requires std::sortable<ranges::iterator_t<R>, Comp, Proj>
    constexpr ranges::borrowed_iterator_t<R>
    operator()( R&& r, Comp comp = {}, Proj proj = {} ) const {
        return (*this)(ranges::begin(r), ranges::end(r), std::move(comp), std::move(proj));
    }
};
 
inline constexpr sort_heap_fn sort_heap{};

Example

#include <algorithm>
#include <array>
#include <iostream>
 
void print(auto const& rem, auto const& v)
{
    std::cout << rem;
    for (const auto i : v)
        std::cout << i << ' ';
    std::cout << '\n';
}
 
int main()
{
    std::array v {3, 1, 4, 1, 5, 9};
    print("original array:  ", v);
 
    std::ranges::make_heap(v);
    print("after make_heap: ", v);
 
    std::ranges::sort_heap(v);
    print("after sort_heap: ", v);
}

Output:

original array:  3 1 4 1 5 9
after make_heap: 9 5 4 1 1 3
after sort_heap: 1 1 3 4 5 9

See also

checks if the given range is a max heap
(niebloid)[edit]
finds the largest subrange that is a max heap
(niebloid)[edit]
creates a max heap out of a range of elements
(niebloid)[edit]
removes the largest element from a max heap
(niebloid)[edit]
adds an element to a max heap
(niebloid)[edit]
turns a max heap into a range of elements sorted in ascending order
(function template) [edit]