operator==,!=(std::unordered_set)

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Execution support library (C++26)

Technical specifications

Symbols index

External libraries

 

Containers library

Sequence

array (C++11)

vector

vector<bool>

inplace_vector (C++26)

deque

forward_list (C++11)

list

Associative

set

multiset

map

multimap

Unordered associative

unordered_set (C++11)

unordered_multiset (C++11)

unordered_map (C++11)

unordered_multimap (C++11)

Adaptors

stack

queue

priority_queue

flat_set (C++23)

flat_multiset (C++23)

flat_map (C++23)

flat_multimap (C++23)

Views

span (C++20)

mdspan (C++23)

Tables

Iterator invalidation

Member function table

Non-member function table

 

std::unordered_set

Member types
Member functions
unordered_set::unordered_set unordered_set::~unordered_set unordered_set::operator= unordered_set::get_allocator Iterators unordered_set::beginunordered_set::cbegin unordered_set::endunordered_set::cend Capacity unordered_set::size unordered_set::max_size unordered_set::empty Modifiers unordered_set::clear unordered_set::erase unordered_set::swap unordered_set::extract (C++17) unordered_set::merge (C++17) unordered_set::insert unordered_set::insert_range (C++23)   unordered_set::emplace unordered_set::emplace_hint	Lookup unordered_set::count unordered_set::find unordered_set::contains (C++20) unordered_set::equal_range Bucket interface unordered_set::begin(size_type)unordered_set::cbegin(size_type) unordered_set::end(size_type)unordered_set::cend(size_type) unordered_set::bucket_count unordered_set::max_bucket_count unordered_set::bucket_size unordered_set::bucket Hash policy unordered_set::load_factor unordered_set::max_load_factor unordered_set::rehash unordered_set::reserve Observers unordered_set::hash_function unordered_set::key_eq
Non-member functions
operator==operator!= (until C++20)	std::swap(std::unordered_set) erase_if(std::unordered_set) (C++20)
Deduction guides (C++17)

 

template< class Key, class Hash, class KeyEqual, class Alloc > bool operator==( const std::unordered_set<Key, Hash, KeyEqual, Alloc>& lhs,                  const std::unordered_set<Key, Hash, KeyEqual, Alloc>& rhs );	(1)
template< class Key, class Hash, class KeyEqual, class Alloc > bool operator!=( const std::unordered_set<Key, Hash, KeyEqual, Alloc>& lhs,                  const std::unordered_set<Key, Hash, KeyEqual, Alloc>& rhs );	(2)	(until C++20)

Compares the contents of two unordered containers.

The contents of two unordered containers lhs and rhs are equal if the following conditions hold:

• lhs.size() == rhs.size().
• each group of equivalent elements [lhs_eq1, lhs_eq2) obtained from lhs.equal_range(lhs_eq1) has a corresponding group of equivalent elements in the other container [rhs_eq1, rhs_eq2) obtained from rhs.equal_range(rhs_eq1), that has the following properties:

• std::distance(lhs_eq1, lhs_eq2) == std::distance(rhs_eq1, rhs_eq2).
• std::is_permutation(lhs_eq1, lhs_eq2, rhs_eq1) == true.

The behavior is undefined if Key is not EqualityComparable.

The behavior is also undefined if hash_function() and key_eq() do(until C++20)key_eq() does(since C++20) not have the same behavior on lhs and rhs or if operator== for Key is not a refinement of the partition into equivalent-key groups introduced by key_eq() (that is, if two elements that compare equal using operator== fall into different partitions).

The != operator is synthesized from operator==.

(since C++20)

Parameters

lhs, rhs

-

unordered containers to compare

Return value

1) true if the contents of the containers are equal, false otherwise.

2) true if the contents of the containers are not equal, false otherwise.

Complexity

Proportional to N calls to operator== on value_type, calls to the predicate returned by key_eq, and calls to the hasher returned by hash_function, in the average case, proportional to N² in the worst case where N is the size of the container.