WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / C++

std::to_underlying – eine Aufzählung in ihren zugrunde liegenden Typ umwandeln

std::to_underlying aus <utility> wandelt einen Aufzählungswert in seinen exakten zugrunde liegenden Typ um. Seit C++23 verfügbar, ist die Funktion constexpr und noexcept; sie erzwingt weder int noch prüft sie, ob der Wert einem benannten Enumerator entspricht.

Version: C++23; repository compiler flag, production runtime not attested

Syntax

#include <utility>

template<class T>
constexpr std::underlying_type_t<T> std::to_underlying(T value) noexcept;

std::to_underlying(value) aus <utility> gibt die numerische Darstellung eines Aufzählungswerts zurück. Der Rückgabetyp ist std::underlying_type_t<T>, wobei T der Typ des Arguments ist. Die Funktion funktioniert sowohl mit enum als auch mit enum class; sie ist keine allgemeine Funktion, um beliebige Argumente in Ganzzahlen umzuwandeln.

Das Ergebnis ist als static_cast<std::underlying_type_t<T>>(value) definiert. Anders als static_cast<int>(value) bewahrt die Funktion den exakten zugrunde liegenden Typ einschließlich seiner Vorzeichenbehaftung, statt int zu erzwingen. Das ist nützlich, wenn die numerische Darstellung einer Aufzählung an eine andere Schnittstelle übergeben wird.

Die Funktion ist constexpr und kann daher an Konstantenauswertungen teilnehmen. Sie ist außerdem noexcept und löst keine Ausnahmen aus. Sie prüft nicht, ob der übergebene Wert einem benannten Enumerator entspricht. Eine Umwandlung in die Gegenrichtung, von einer Zahl zu einer Aufzählung, führt sie ebenfalls nicht aus.

Im Beispiel hat Status den expliziten zugrunde liegenden Typ unsigned int. Die Assertions prüfen den Rückgabetyp, den Wert 7u und die noexcept-Eigenschaft; das Programm gibt 7 aus. C++23-Unterstützung ist sowohl im Compiler als auch in der Standardbibliothek erforderlich. Ein Compiler-Flag im Repository allein belegt nicht, dass die Funktion in einer Produktionslaufzeitumgebung verfügbar ist.

Beispiele

#include <iostream>
#include <type_traits>
#include <utility>

enum class Status : unsigned int {
    ready = 7,
    done = 9
};

static_assert(std::is_same_v<
    decltype(std::to_underlying(Status::ready)), unsigned int>);
static_assert(std::to_underlying(Status::ready) == 7u);
static_assert(noexcept(std::to_underlying(Status::ready)));

int main() {
    std::cout << std::to_underlying(Status::ready) << '\n';
}

Ergebnis

7

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen