CKTIS / C++
std::to_underlying — een enumeratie omzetten naar het onderliggende type
std::to_underlying uit <utility> zet een enumeratiewaarde om naar het exacte onderliggende type. De functie is beschikbaar sinds C++23 en is constexpr en noexcept; ze dwingt geen int af en controleert niet of de waarde overeenkomt met een benoemde enumerator.
Versie: 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) uit <utility> geeft de numerieke weergave van een enumeratiewaarde terug. Het retourtype is std::underlying_type_t<T>, waarbij T het type van het argument is. De functie werkt met zowel enum als enum class; ze is geen algemene functie om willekeurige argumenten naar gehele getallen om te zetten.
Het resultaat is gedefinieerd als static_cast<std::underlying_type_t<T>>(value). Anders dan static_cast<int>(value) behoudt de functie het exacte onderliggende type, inclusief de signedness, in plaats van int af te dwingen. Dat is handig wanneer je de numerieke weergave van een enumeratie aan een andere interface doorgeeft.
De functie is constexpr en kan dus deelnemen aan constantevaluatie. Ze is ook noexcept en gooit geen uitzonderingen. Ze controleert niet of de opgegeven waarde overeenkomt met een benoemde enumerator. Ook voert ze niet de omgekeerde omzetting uit, van een getal naar een enumeratie.
In het voorbeeld heeft Status het expliciete onderliggende type unsigned int. De assertions controleren het retourtype, de waarde 7u en de eigenschap noexcept; het programma drukt 7 af. Zowel de compiler als de standaardbibliotheek moeten C++23 ondersteunen. Alleen een compileroptie in een repository bewijst niet dat de functie in een productieomgeving werkt.
Voorbeelden
#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';
}
Resultaat
7
De getoonde code en het opgegeven resultaat zijn in een geïsoleerde omgeving geverifieerd met de methode die in het verificatiebewijs voor exact deze versie is vastgelegd.