Namespaces
Variants

std:: to_underlying

From cppreference.net
Utilities library
Определено в заголовочном файле <utility>
template < class Enum >
constexpr std:: underlying_type_t < Enum > to_underlying ( Enum e ) noexcept ;
(начиная с C++23)

Преобразует перечисление в его базовый тип. Эквивалентно return static_cast < std:: underlying_type_t < Enum >> ( e ) ; .

Содержание

Параметры

e - перечисляемое значение для преобразования

Возвращаемое значение

Целочисленное значение базового типа Enum , преобразованное из e .

Примечания

std::to_underlying может использоваться для предотвращения преобразования перечисления в целочисленный тип, отличный от его базового типа.

Макрос тестирования возможностей Значение Стандарт Возможность
__cpp_lib_to_underlying 202102L (C++23) std::to_underlying

Пример

#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; // Ошибка: неизвестное преобразование
    [[maybe_unused]]
    std::underlying_type_t<ColorMask> y = std::to_underlying(ColorMask::alpha); // OK
}

Вывод:

000000FF
0000FF00
00FF0000
FF000000

Смотрите также

получает базовый целочисленный тип для заданного типа перечисления
(class template)
(C++11)
проверяет, является ли тип типом перечисления
(class template)
проверяет, является ли тип типом ограниченного перечисления
(class template)