Namensräume
Varianten
Aktionen

std::to_underlying

Von cppreference.com
< cpp‎ | utility
 
 
Dienstprogramm-Bibliotheken
Sprachunterstützung
Typunterstützung (Basistypen, RTTI)
Bibliotheks-Feature-Test-Makros (C++20)
Programm-Dienstprogramme
Variadische Funktionen
Coroutine-Unterstützung (C++20)
Vertragsunterstützung (C++26)
Drei-Wege-Vergleich
(C++20)
(C++20)(C++20)(C++20)  
(C++20)(C++20)(C++20)

Allgemeine Hilfsmittel
Relationale Operatoren (in C++20 veraltet)
Ganzzahl-Vergleichsfunktionen
(C++20)(C++20)(C++20)  
(C++20)
Swap und Typ-Operationen
(C++14)
(C++11)
to_underlying
(C++23)
(C++11)
(C++11)
(C++17)
Gemeinsame Vokabulartypen
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++23)



 
Definiert in der Header-Datei <utility>
template< class Enum >
constexpr std::underlying_type_t<Enum> to_underlying( Enum e ) noexcept;
(seit C++23)

Konvertiert eine Aufzählung in ihren zugrunde liegenden Typ. Entspricht return static_cast<std::underlying_type_t<Enum>>(e);.

Inhalt

[edit] Parameter

e - Aufzählungswert, der konvertiert werden soll

[edit] Rückgabewert

Der ganzzahlige Wert des zugrunde liegenden Typs von Enum, konvertiert von e.

[edit] Hinweise

std::to_underlying kann verwendet werden, um die Konvertierung einer Aufzählung in einen anderen ganzzahligen Typ als ihren zugrunde liegenden Typ zu vermeiden.

Feature-Test-Makro Wert Std Feature
__cpp_lib_to_underlying 202102L (C++23) std::to_underlying

[edit] Beispiel

#include <cstdint>
#include <iomanip>
#include <iostream>
#include <type_traits>
#include <utility>
 
enum class E1 : char { e };
static_assert(std::is_same_v<char, decltype(std::to_underlying(E1::e))>);
 
enum struct E2 : long { e };
static_assert(std::is_same_v<long, decltype(std::to_underlying(E2::e))>);
 
enum E3 : unsigned { e };
static_assert(std::is_same_v<unsigned, decltype(std::to_underlying(e))>);
 
int main()
{
    enum class ColorMask : std::uint32_t
    {
        red = 0xFF, green = (red << 8), blue = (green << 8), alpha = (blue << 8)
    };
 
    std::cout << std::hex << std::uppercase << std::setfill('0')
              << std::setw(8) << std::to_underlying(ColorMask::red) << '\n'
              << std::setw(8) << std::to_underlying(ColorMask::green) << '\n'
              << std::setw(8) << std::to_underlying(ColorMask::blue) << '\n'
              << std::setw(8) << std::to_underlying(ColorMask::alpha) << '\n';
 
//  std::underlying_type_t<ColorMask> x = ColorMask::alpha; // Error: no known conversion
    [[maybe_unused]]
    std::underlying_type_t<ColorMask> y = std::to_underlying(ColorMask::alpha); // OK
}

Ausgabe

000000FF
0000FF00
00FF0000
FF000000

[edit] Siehe auch

erhält den zugrundeliegenden ganzzahligen Typ für einen gegebenen Aufzählungstyp
(Klassenvorlage) [bearbeiten]
(C++11)
prüft, ob ein Typ ein Aufzählungstyp ist
(Klassenvorlage) [bearbeiten]
prüft, ob ein Typ ein namensgebender Aufzählungstyp ist
(Klassenvorlage) [bearbeiten]