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

CKTIS / C++

std::clamp: limitar um valor a um intervalo

std::clamp devolve o limite inferior, superior ou o próprio valor para que o resultado pertença ao intervalo ordenado.

Versão: C++23

Sintaxe

template<class T>
constexpr const T& clamp(const T& value, const T& low, const T& high);

template<class T, class Compare>
constexpr const T& clamp(const T& value, const T& low, const T& high, Compare comp);

std::clamp(v, lo, hi, comp), de <algorithm>, testa primeiro comp(v, lo) e devolve referência a lo, depois testa comp(hi, v) e devolve referência a hi, e caso contrário devolve referência a v. Em C++23, a sobrecarga sem comparador usa std::less{}. Executa no máximo duas comparações.

A pré-condição exige que hi não preceda lo. Violar esta pré-condição causa comportamento indefinido; a função não troca automaticamente os limites. O comparador tem de dar ordem coerente; NaN em ponto flutuante quebra as suposições habituais.

O resultado é const T&. Copiá-lo imediatamente é seguro, mas guardar a referência pode deixá-la pendente se v, lo ou hi era temporário. Se v for equivalente aos dois limites, ambas as comparações são falsas e o resultado refere v. A função não modifica argumentos.

Exemplos

#include <algorithm>
#include <iostream>

int main() {
    const int bounded = std::clamp(12, 0, 10);
    std::cout << bounded << '\n';
}

Resultado

10

std::clamp → 10

Fontes