std::to_underlying

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

工具库

语言支持 类型支持（基本类型、 RTTI） 库功能特性测试宏 (C++20) 动态内存管理 程序工具 协程支持 (C++20) 变参数函数 is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) 三路比较 (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20) is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

通用工具 日期和时间 函数对象 格式化库 (C++20) bitset hash (C++11) 关系运算符 (C++20 中弃用) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= 整数比较函数 cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20) cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) swap 与类型运算 swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) 常用词汇类型 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) 初等字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (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>
 
namespace cxx {
#if defined(__cpp_lib_to_underlying)
    using std::to_underlying;
#else
    template <class Enum>
    constexpr std::underlying_type_t<Enum>
    to_underlying(Enum e) noexcept {
        return static_cast<std::underlying_type_t<Enum>>(e);
    }
#endif
}
 
int main()
{
    enum class E1 : char { e };
    static_assert(std::is_same_v<char, decltype(cxx::to_underlying(E1::e))>);
    enum struct E2 : long { e };
    static_assert(std::is_same_v<long, decltype(cxx::to_underlying(E2::e))>);
    enum E3 : unsigned { e };
    static_assert(std::is_same_v<unsigned, decltype(cxx::to_underlying(e))>);
 
    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) << cxx::to_underlying(ColorMask::red) << '\n'
        << std::setw(8) << cxx::to_underlying(ColorMask::green) << '\n'
        << std::setw(8) << cxx::to_underlying(ColorMask::blue) << '\n'
        << std::setw(8) << cxx::to_underlying(ColorMask::alpha) << '\n';
 
//  std::underlying_type_t<ColorMask> x = ColorMask::alpha; // 错误：无已知转换
    [[maybe_unused]]
    std::underlying_type_t<ColorMask> y = cxx::to_underlying(ColorMask::alpha); // OK
}

输出：

000000FF
0000FF00
00FF0000
FF000000

参阅

underlying_type (C++11)	获取给定枚举类型的底层整数类型 (类模板)
is_enum (C++11)	检查类型是否是枚举类型 (类模板)
is_scoped_enum (C++23)	检查类型是否为有作用域枚举类型 (类模板)