Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / C++

std::to_underlying — converter uma enumeração para o respetivo tipo subjacente

std::to_underlying, declarada em <utility>, converte um valor de enumeração para o seu tipo subjacente exato. Disponível desde C++23, é constexpr e noexcept; não força o tipo int nem verifica se o valor corresponde a um enumerador com nome.

Versão: C++23; repository compiler flag, production runtime not attested

Sintaxe

#include <utility>

template<class T>
constexpr std::underlying_type_t<T> std::to_underlying(T value) noexcept;

std::to_underlying(value), declarada em <utility>, devolve a representação numérica de um valor de enumeração. O tipo devolvido é std::underlying_type_t<T>, em que T é o tipo do argumento. Funciona tanto com enum como com enum class; não é uma função genérica para converter argumentos arbitrários em inteiros.

O resultado é definido como static_cast<std::underlying_type_t<T>>(value). Ao contrário de static_cast<int>(value), a função preserva o tipo subjacente exato, incluindo o facto de ter ou não sinal, em vez de forçar int. Isto é útil ao passar a representação numérica de uma enumeração para outra interface.

A função é constexpr, pelo que pode participar numa avaliação constante, e noexcept, pelo que não lança exceções. Não verifica se o valor fornecido corresponde a um enumerador com nome. Também não efetua a conversão inversa, de um número para uma enumeração.

No exemplo, Status tem o tipo subjacente explícito unsigned int. As asserções verificam o tipo devolvido, o valor 7u e a propriedade noexcept, enquanto o programa apresenta 7. É necessário que tanto o compilador como a biblioteca padrão suportem C++23; uma opção do compilador no repositório, por si só, não comprova o funcionamento num ambiente de execução de produção.

Exemplos

#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';
}

Resultado

7

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes