std::priority_queue empty() method

od C++20

// (1) Const version only
bool empty() const;

// (2) Const version only
[[nodiscard]] bool empty() const

do C++20

// (1) Const version only
bool empty() const;

Checks if the container has no elements, i.e. whether c.empty().

Parameters

(none)

Return value

true if the container is empty, false otherwise.

Complexity

Constant - O(1).

Why [[nodiscard]]?

The [[nodiscard]] attribute is an attribute that invokes compiler warnings whenever a function has been called and it's result has been discarded.

The reason behind the nodiscard being applied only to the empty method is that it's likely that the programmer might confuse the adjective empty ( which would mean - is this container empty?) for the verb empty (which would mean - please empty this container for me.).

Exceptions

(none)

Example

Main.cpp

#include <algorithm>
#include <iostream>
#include <queue>
 
int main()
{
    std::cout << std::boolalpha;
 
    std::priority_queue<int> container;
 
    std::cout << "Initially, container.empty(): " << container.empty() << '\n';
 
    container.push(42);
    std::cout << "After adding elements, container.empty(): " << container.empty() << '\n';
}

Output

Initially, container.empty(): true
After adding elements, container.empty(): false