CKTIS / C++
std::to_underlying — převod výčtu na jeho základní typ
std::to_underlying z hlavičky <utility> převádí hodnotu výčtu na její přesný základní typ. Funkce dostupná od C++23 je constexpr a noexcept; nevynucuje typ int ani nekontroluje, zda hodnota odpovídá pojmenovanému enumerátoru.
Verze: C++23; repository compiler flag, production runtime not attested
Syntaxe
#include <utility>
template<class T>
constexpr std::underlying_type_t<T> std::to_underlying(T value) noexcept;std::to_underlying(value) z hlavičky <utility> vrací číselnou reprezentaci hodnoty výčtu. Její návratový typ je std::underlying_type_t<T>, kde T je typ argumentu. Funguje s enum i enum class; nejde o obecnou funkci pro převod libovolných argumentů na celá čísla.
Výsledek je definován jako static_cast<std::underlying_type_t<T>>(value). Na rozdíl od static_cast<int>(value) zachovává funkce přesný základní typ včetně jeho znaménkovosti, místo aby vynucovala int. To se hodí při předávání číselné reprezentace výčtu do jiného rozhraní.
Funkce je constexpr, takže se může účastnit vyhodnocování konstant, a noexcept, takže nevyvolává výjimky. Nekontroluje, zda předaná hodnota odpovídá pojmenovanému enumerátoru. Neprovádí ani opačný převod z čísla na výčet.
V příkladu má Status explicitní základní typ unsigned int. Aserce ověřují návratový typ, hodnotu 7u a vlastnost noexcept; program vypíše 7. Podporu C++23 musí poskytovat kompilátor i standardní knihovna. Samotný příznak kompilátoru v repozitáři nepotvrzuje fungování v produkčním běhovém prostředí.
Příklady
#include <iostream>
#include <type_traits>
#include <utility>
enum class Status : unsigned int {
ready = 7,
done = 9
};
static_assert(std::is_same_v<
decltype(std::to_underlying(Status::ready)), unsigned int>);
static_assert(std::to_underlying(Status::ready) == 7u);
static_assert(noexcept(std::to_underlying(Status::ready)));
int main() {
std::cout << std::to_underlying(Status::ready) << '\n';
}
Výsledek
7
Zobrazený kód a uvedený výsledek byly ověřeny v izolovaném prostředí metodou zaznamenanou v dokladu o ověření této přesné verze.