Пространства имён
Варианты
Действия

std::to_underlying

Материал из cppreference.com
< cpp‎ | utility
 
 
Библиотека утилит
Языковая поддержка
Поддержка типов (базовые типы, RTTI)
Макросы тестирования функциональности библиотеки (C++20)    
Управление динамической памятью
Программные утилиты
Поддержка сопрограмм (C++20)
Вариативные функции
Трёхстороннее сравнение (C++20)
(C++20)
(C++20)(C++20)(C++20)(C++20)(C++20)(C++20)
Общие утилиты
Дата и время
Функциональные объекты
Библиотека форматирования (C++20)
(C++11)
Операторы отношения (устарело в C++20)
Целочисленные функции сравнения
(C++20)(C++20)(C++20)    
(C++20)
Операции обмена и типа
(C++14)
(C++11)
to_underlying
(C++23)
(C++11)
(C++11)
(C++17)
Общие лексические типы
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++23)
Элементарные преобразования строк
(C++17)
(C++17)
 
Определено в заголовочном файле <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

[править] Смотрите также

получает базовый целочисленный тип для данного типа перечисления
(шаблон класса) [править]
(C++11)
проверяет, является ли тип типом перечисления
(шаблон класса) [править]
проверяет, является ли тип типом перечисления с ограниченной областью видимости
(шаблон класса) [править]