WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / C++

std::clamp: Wert auf ein Intervall begrenzen

std::clamp liefert Untergrenze, Obergrenze oder den Wert selbst, sodass das Ergebnis im geordneten Intervall liegt.

Version: C++23

Syntax

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) aus <algorithm> prüft zuerst comp(v, lo) und liefert eine Referenz auf lo, dann comp(hi, v) und eine Referenz auf hi, andernfalls eine Referenz auf v. Der Overload ohne Komparator verwendet in C++23 std::less{}. Es werden höchstens zwei Vergleiche ausgeführt.

Vorbedingung ist, dass hi nach dem Komparator nicht vor lo liegt. Eine Verletzung dieser Vorbedingung führt zu undefiniertem Verhalten; die Funktion vertauscht die Grenzen nicht automatisch. Der Komparator muss konsistent ordnen; NaN-Werte bei Fließkommazahlen brechen die üblichen Annahmen.

Das Ergebnis ist const T&. Sofortiges Kopieren ist sicher, eine gespeicherte Referenz kann bei temporärem v, lo oder hi hängen. Ist v zu beiden Grenzen äquivalent, sind beide Vergleiche falsch und das Ergebnis verweist auf v. Die Argumente werden nicht verändert.

Beispiele

#include <algorithm>
#include <iostream>

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

Ergebnis

10

std::clamp → 10

Quellen