Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C++

std::clamp: ograniczenie wartości do przedziału

std::clamp zwraca dolną granicę, górną granicę albo samą wartość tak, aby wynik należał do uporządkowanego przedziału.

Wersja: C++23

Składnia

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) z <algorithm> najpierw sprawdza comp(v, lo) i zwraca referencję do lo, potem sprawdza comp(hi, v) i zwraca referencję do hi, a w przeciwnym razie zwraca referencję do v. Przeciążenie bez komparatora w C++23 używa std::less{}. Wykonywane są najwyżej dwa porównania.

Warunkiem wstępnym jest, aby hi nie poprzedzało lo według komparatora. Naruszenie tego warunku powoduje niezdefiniowane zachowanie; funkcja nie zamienia granic automatycznie. Komparator musi tworzyć spójny porządek; dla liczb zmiennoprzecinkowych wartości NaN psują zwykłe założenia porządku.

Wynik ma typ const T&. Skopiowanie go od razu jest bezpieczne, ale zachowanie referencji może prowadzić do wiszenia, jeśli v, lo lub hi były obiektami tymczasowymi. Gdy v jest równoważne obu granicom, oba porównania są fałszywe i wynik odnosi się do v. Funkcja nie modyfikuje argumentów.

Przykłady

#include <algorithm>
#include <iostream>

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

Wynik

10

std::clamp → 10

Źródła