Namensräume
Varianten
Aktionen

std::unordered_set

Von cppreference.com
< cpp‎ | container
 
 
 
 
Definiert in Header <unordered_set>
template<

    class Key,
    class Hash = std::hash<Key>,
    class KeyEqual = std::equal_to<Key>,
    class Allocator = std::allocator<Key>

> class unordered_set;
(1) (seit C++11)
namespace pmr {

    template<
        class Key,
        class Hash = std::hash<Key>,
        class Pred = std::equal_to<Key>
    > using unordered_set = std::unordered_set<Key, Hash, Pred,
                                std::pmr::polymorphic_allocator<Key>>;

}
(2) (seit C++17)

std::unordered_set ist ein assoziativer Container, der eine Menge eindeutiger Objekte vom Typ Key enthält. Suchen, Einfügen und Entfernen haben eine durchschnittliche konstante Zeitkomplexität.

Intern sind die Elemente nicht in irgendeiner bestimmten Reihenfolge sortiert, sondern in Buckets organisiert. Welchen Bucket ein Element erhält, hängt vollständig vom Hash seines Wertes ab. Dies ermöglicht einen schnellen Zugriff auf einzelne Elemente, da nach der Berechnung eines Hashs dieser auf den exakten Bucket verweist, in den das Element platziert wurde.

Container-Elemente können nicht modifiziert werden (auch nicht durch nicht-const Iteratoren), da eine Modifikation den Hash eines Elements ändern und den Container beschädigen könnte.

std::unordered_set erfüllt die Anforderungen von Container, AllocatorAwareContainer, UnorderedAssociativeContainer.

Alle Memberfunktionen von std::unordered_set sind constexpr: Es ist möglich, std::unordered_set-Objekte während der Auswertung eines konstanten Ausdrucks zu erstellen und zu verwenden.

Jedoch können std::unordered_set-Objekte im Allgemeinen nicht constexpr sein, da jeder dynamisch zugewiesene Speicher im selben konstanten Ausdruck freigegeben werden muss.

(seit C++26)

Inhalt

[edit] Iterator-Ungültigkeit

Operationen Invalidiert
Alle schreibgeschützten Operationen, swap, std::swap Niemals
clear, rehash, reserve, operator= Immer
insert, emplace, emplace_hint Nur wenn Rehash ausgelöst wird
erase Nur für das gelöschte Element

[edit] Anmerkungen

  • Die Swap-Funktionen machen keine der Iteratoren innerhalb des Containers ungültig, machen aber den Iterator, der das Ende des Swap-Bereichs markiert, ungültig.
  • Referenzen und Zeiger auf im Container gespeicherte Daten werden nur durch das Löschen dieses Elements ungültig gemacht, auch wenn der entsprechende Iterator ungültig wird.
  • Nach der Move-Zuweisung des Containers, es sei denn, die Element-weise Move-Zuweisung wird durch inkompatible Allokatoren erzwungen, bleiben Referenzen, Zeiger und Iteratoren (außer dem Past-the-End-Iterator) des bewegten Containers gültig, verweisen aber auf Elemente, die sich nun in *this befinden.

[edit] Template-Parameter

[edit] Member-Typen

Typ Definition
key_type Key[edit]
value_type Key[edit]
size_type Vorzeichenloser Ganzzahltyp (normalerweise std::size_t)[edit]
difference_type Vorzeichenbehafteter Ganzzahltyp (normalerweise std::ptrdiff_t)[edit]
hasher Hash[edit]
key_equal KeyEqual[edit]
allocator_type Allocator[edit]
Referenz value_type&[edit]
const_reference const value_type&[edit]
Zeiger std::allocator_traits<Allocator>::pointer[edit]
const_pointer std::allocator_traits<Allocator>::const_pointer[edit]
iterator Konstante LegacyForwardIterator und ConstexprIterator(seit C++26) zu value_type[edit]
const_iterator LegacyForwardIterator und ConstexprIterator(seit C++26) zu const value_type[edit]
local_iterator Ein Iterator-Typ, dessen Kategorie, Wert, Differenz, Zeiger und
Referenztypen dieselben sind wie bei iterator. Dieser Iterator
kann verwendet werden, um durch einen einzelnen Bucket zu iterieren, aber nicht über Buckets hinweg[edit]
const_local_iterator Ein Iterator-Typ, dessen Kategorie, Wert, Differenz, Zeiger und
Referenztypen dieselben sind wie bei const_iterator. Dieser Iterator
kann verwendet werden, um durch einen einzelnen Bucket zu iterieren, aber nicht über Buckets hinweg[edit]
node_type (seit C++17) eine Spezialisierung von node handle, die einen Containerknoten repräsentiert[edit]
insert_return_type (seit C++17) Typ, der das Ergebnis des Einfügens eines node_type beschreibt, eine Spezialisierung von

template<class Iter, class NodeType>
struct /*unspecified*/
{
    Iter     position;
    bool     inserted;
    NodeType node;
};

instanziiert mit den Template-Argumenten iterator und node_type.[edit]

[edit] Memberfunktionen

konstruiert den unordered_set
(public member function) [edit]
destruiert den unordered_set
(public member function) [edit]
weist dem Container Werte zu
(public member function) [edit]
gibt den zugehörigen Allocator zurück
(public member function) [edit]
Iteratoren
gibt einen Iterator zum Anfang zurück
(public member function) [edit]
gibt einen Iterator zum Ende zurück
(public member function) [edit]
Kapazität
prüft, ob der Container leer ist
(public member function) [edit]
Gibt die Anzahl der Elemente zurück
(public member function) [edit]
Gibt die maximal mögliche Anzahl von Elementen zurück
(public member function) [edit]
Modifizierer
leert den Inhalt
(public member function) [edit]
fügt Elemente ein oder Knoten(seit C++17)
(public member function) [edit]
fügt einen Bereich von Elementen ein
(public member function) [edit]
konstruiert Elemente direkt (in-place)
(public member function) [edit]
konstruiert Elemente "in place" unter Verwendung eines Hinweises
(public member function) [edit]
entfernt Elemente
(public member function) [edit]
tauscht die Inhalte
(public member function) [edit]
(C++17)
extrahiert Knoten aus dem Container
(public member function) [edit]
(C++17)
fügt Knoten aus einem anderen Container zusammen
(public member function) [edit]
Suche
gibt die Anzahl der Elemente zurück, die einem bestimmten Schlüssel entsprechen
(public member function) [edit]
sucht ein Element mit einem bestimmten Schlüssel
(public member function) [edit]
(C++20)
prüft, ob der Container ein Element mit einem bestimmten Schlüssel enthält
(public member function) [edit]
gibt den Bereich von Elementen zurück, die einem bestimmten Schlüssel entsprechen
(public member function) [edit]
Bucket-Schnittstelle
gibt einen Iterator zum Anfang des angegebenen Buckets zurück
(public member function) [edit]
gibt einen Iterator zum Ende des angegebenen Buckets zurück
(public member function) [edit]
gibt die Anzahl der Buckets zurück
(public member function) [edit]
gibt die maximale Anzahl von Buckets zurück
(public member function) [edit]
gibt die Anzahl der Elemente in einem bestimmten Bucket zurück
(public member function) [edit]
gibt den Bucket für einen bestimmten Schlüssel zurück
(public member function) [edit]
Hash-Politik
gibt die durchschnittliche Anzahl von Elementen pro Bucket zurück
(public member function) [edit]
verwaltet die maximale durchschnittliche Anzahl von Elementen pro Bucket
(public member function) [edit]
reserviert mindestens die angegebene Anzahl von Buckets und generiert die Hashtabelle neu
(public member function) [edit]
reserviert Speicher für mindestens die angegebene Anzahl von Elementen und generiert die Hashtabelle neu
(public member function) [edit]
Observer
gibt die zum Hashen der Schlüssel verwendete Funktion zurück
(public member function) [edit]
gibt die zum Vergleichen von Schlüsseln auf Gleichheit verwendete Funktion zurück
(public member function) [edit]

[edit] Nicht-Member-Funktionen

(C++11)(C++11)(entfernt in C++20)
vergleicht die Werte im unordered_set
(function template) [edit]
spezialisiert den Algorithmus std::swap
(function template) [edit]
entfernt alle Elemente, die bestimmte Kriterien erfüllen
(function template) [edit]

Deduction Guides

(seit C++17)

[edit] Anmerkungen

Die Member-Typen iterator und const_iterator können Aliase für denselben Typ sein. Das bedeutet, dass die Definition eines Paares von Funktionsüberladungen, die die beiden Typen als Parametertypen verwenden, die Ein-Definitionen-Regel (ODR) verletzen kann. Da iterator in const_iterator konvertierbar ist, funktioniert stattdessen eine einzelne Funktion mit einem const_iterator als Parametertyp.

Feature-Test-Makro Wert Std Feature
__cpp_lib_containers_ranges 202202L (C++23) Bereichskonstruktion und -einfügung für Container
__cpp_lib_constexpr_containers 202502L (C++26) constexpr std::unordered_set

[edit] Beispiel

#include <iostream>
#include <unordered_set>
 
void print(const auto& set)
{
    for (const auto& elem : set)
        std::cout << elem << ' ';
    std::cout << '\n';
}
 
int main()
{
    std::unordered_set<int> mySet{2, 7, 1, 8, 2, 8}; // creates a set of ints
    print(mySet);
 
    mySet.insert(5); // puts an element 5 in the set
    print(mySet);
 
    if (auto iter = mySet.find(5); iter != mySet.end())
        mySet.erase(iter); // removes an element pointed to by iter
    print(mySet);
 
    mySet.erase(7); // removes an element 7
    print(mySet);
}

Mögliche Ausgabe

8 1 7 2
5 8 1 7 2
8 1 7 2
8 1 2

[edit] Fehlerberichte

Die folgenden Verhaltensändernden Fehlerberichte wurden rückwirkend auf zuvor veröffentlichte C++-Standards angewendet.

DR angewendet auf Verhalten wie veröffentlicht Korrigiertes Verhalten
LWG 2050 C++11 die Definitionen von reference, const_reference, pointer
und const_pointer basierten auf allocator_type
basierend auf value_type und
std::allocator_traits

[edit] Siehe auch

Sammlung von Schlüsseln, gehasht nach Schlüsseln
(Klassenvorlage) [edit]
Sammlung eindeutiger Schlüssel, sortiert nach Schlüsseln
(Klassenvorlage) [edit]
(C++23)
passt einen Container an, um eine Sammlung eindeutiger Schlüssel, sortiert nach Schlüsseln, bereitzustellen
(Klassenvorlage) [edit]