A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://en.cppreference.com/w/cpp/algorithm/../ranges/../algorithm/is_heap.html below:

std::is_heap - cppreference.com

template< class RandomIt >
bool is_heap( RandomIt first, RandomIt last );

(1) (since C++11)
(constexpr since C++20) template< class ExecutionPolicy, class RandomIt >

bool is_heap( ExecutionPolicy&& policy,

              RandomIt first, RandomIt last );
(2) (since C++17)

template< class RandomIt, class Compare >
bool is_heap( RandomIt first, RandomIt last, Compare comp );

(3) (since C++11)
(constexpr since C++20) template< class ExecutionPolicy, class RandomIt, class Compare >

bool is_heap( ExecutionPolicy&& policy,

              RandomIt first, RandomIt last, Compare comp );
(4) (since C++17)

Checks whether [firstlast) is a heap.

1)

The heap property to be checked is with respect to

operator<(until C++20)std::less{}(since C++20)

.

3) The heap property to be checked is with respect to comp.

2,4) Same as (1,3), but executed according to policy.

These overloads participate in overload resolution only if all following conditions are satisfied:

[edit] Parameters first, last - the pair of iterators defining the range of elements to be checked policy - the execution policy to use 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 C++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. [edit] Return value

true if the range is a heap with respect to the corresponding comparator, false otherwise.

[edit] Complexity

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

1,2) \(\scriptsize O(N)\)O(N)

comparisons using

operator<(until C++20)std::less{}(since C++20)

.

3,4) \(\scriptsize O(N)\)O(N) applications of the comparison function comp.

[edit] Exceptions

The overloads with a template parameter named ExecutionPolicy report errors as follows:

[edit] Example
#include <algorithm>
#include <bit>
#include <iostream>
#include <vector>
 
int main()
{
    std::vector<int> v{3, 1, 4, 1, 5, 9, 2, 6, 5, 3, 5, 8, 9, 7, 9};
 
    std::cout << "initially, v:\n";
    for (const auto& i : v)
        std::cout << i << ' ';
    std::cout << '\n';
 
    if (!std::is_heap(v.begin(), v.end()))
    {
        std::cout << "making heap...\n";
        std::make_heap(v.begin(), v.end());
    }
 
    std::cout << "after make_heap, v:\n";
    for (auto t{1U}; const auto& i : v)
        std::cout << i << (std::has_single_bit(++t) ? " | " : " ");
    std::cout << '\n';
}

Output:

initially, v:
3 1 4 1 5 9 2 6 5 3 5 8 9 7 9
making heap...
after make_heap, v:
9 | 6 9 | 5 5 9 7 | 1 1 3 5 8 3 4 2 |
[edit] See also finds the largest subrange that is a max heap
(function template) [edit] creates a max heap out of a range of elements
(function template) [edit] adds an element to a max heap
(function template) [edit] removes the largest element from a max heap
(function template) [edit] turns a max heap into a range of elements sorted in ascending order
(function template) [edit] checks if the given range is a max heap
(algorithm function object)[edit]

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4