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

関連項目

指定された列挙型の基盤となる整数型を取得する
(クラステンプレート)
(C++11)
型が列挙型かどうかをチェックする
(クラステンプレート)
型がスコープ付き列挙型かどうかをチェックする
(クラステンプレート)