Namespaces
Variants

std::clamp

С ru.cppreference.net
 
 
Библиотека алгоритмов
Ограниченные алгоритмы и алгоритмы для диапазонов (C++20)
Ограниченные алгоритмы, например ranges::copy, ranges::sort, ...
Операции над последовательностями без изменения    
Пакетные операции
(C++17)
Операции поиска
Операции изменения последовательностей
Операции копирования
(C++11)
(C++11)
Операции обмена
Операции преобразования
Операции генерации
Операции удаления
Операции изменения порядка
(до C++17)(C++11)
(C++20)(C++20)
Операции выборки
(C++17)

Операции сортировки и смежные
Операции разделения
(C++11)    

Операции сортировки
Операции двоичного поиска
(на разделённых диапазонах)
Операции над множествами (на отсортированных диапазонах)
Операции слияния (на отсортированных диапазонах)
Операции с кучей
Операции минимума/максимума
(C++11)
(C++17)
Операции лексикографического сравнения
Операции перестановок


Политики выполнения (C++17)
(только для пояснения*)(C++26)

Численные операции
(C++11)
(C++17)
(C++17)    

Специализированные <memory> алгоритмы

Специализированные <random> алгоритмы
Библиотека C









 
Определён в заголовке <algorithm>
template< class T >
constexpr const T& clamp( const T& v, const T& lo, const T& hi );
(1) (начиная с C++17)
template< class T, class Compare >
constexpr const T& clamp( const T& v, const T& lo, const T& hi,
                          Compare comp );
(2) (начиная с C++17)

Если значение v находится в пределах [lo, hi], возвращает v; в противном случае возвращает ближайшую границу.

1) Использует operator<(до C++20)std::less{}(начиная с C++20) для сравнения значений.
Если T не является LessThanComparable, поведение не определено.[1]
2) Использует функцию сравнения comp для сравнения значений.

Если lo больше hi, поведение не определено.

  1. ↑ Если избежать NaN, T может быть типом с плавающей запятой.

Параметры

v - значение для ограничения
lo, hi - границы для ограничения v до
comp - объект функции сравнения (т.е. объект, удовлетворяющий требованиям Compare), который возвращает true, если первый аргумент меньше второго.

Сигнатура функции сравнения должна быть эквивалентна следующей:

bool cmp(const Type1& a, const Type2& b);

Хотя сигнатура не обязательно должна содержать const&, функция не должна изменять переданные ей объекты и должна быть в состоянии принимать все значения типа (возможно, const) Type1 и Type2 независимо от категории значения (таким образом, Type1& не допускается, как и Type1, если только для Type1 перемещение не эквивалентно копированию(начиная с C++11)).
Типы Type1 и Type2 должны быть такими, чтобы объект типа T мог быть неявно преобразован в оба из них.

Возвращаемое значение

Ссылка на lo, если v меньше lo, ссылка на hi, если hi меньше v, в противном случае ссылка на v.

Сложность

1) Не более двух сравнений с использованием operator<(до C++20)std::less{}(начиная с C++20).
2) Не более двух применений функции сравнения comp.

Возможная реализация

clamp (1)
template<class T>
constexpr const T& clamp(const T& v, const T& lo, const T& hi)
{
    return clamp(v, lo, hi, less{});
}
clamp (2)
template<class T, class Compare>
constexpr const T& clamp(const T& v, const T& lo, const T& hi, Compare comp)
{
    return comp(v, lo) ? lo : comp(hi, v) ? hi : v;
}

Примечания

Захват результата std::clamp по ссылке приводит к висячей ссылке, если один из параметров является временным объектом и этот параметр возвращается:

int n = -1;
const int& r = std::clamp(n, 0, 255); // r is dangling

Если v эквивалентно одной из границ, возвращается ссылка на v, а не на границу.

Макрос проверки возможности Значение Стандарт Особенность
__cpp_lib_clamp 201603L (C++17) std::clamp

Пример

#include <algorithm>
#include <cstdint>
#include <iomanip>
#include <iostream>

int main()
{
    std::cout << "[raw] "
                 "[" << INT8_MIN << ',' << INT8_MAX << "] "
                 "[0," << UINT8_MAX << "]\n";

    for (const int v : {-129, -128, -1, 0, 42, 127, 128, 255, 256})
        std::cout << std::setw(4) << v
                  << std::setw(11) << std::clamp(v, INT8_MIN, INT8_MAX)
                  << std::setw(8) << std::clamp(v, 0, UINT8_MAX) << '\n';
}

Вывод:

[raw] [-128,127] [0,255]
-129       -128       0
-128       -128       0
  -1         -1       0
   0          0       0
  42         42      42
 127        127     127
 128        127     128
 255        127     255
 256        127     255

См. также

возвращает меньшее из заданных значений
(шаблон функции & объект функции алгоритма)
возвращает большее из заданных значений
(шаблон функции & объект функции алгоритма)
(C++20)
проверяет, находится ли целое значение в диапазоне заданного целочисленного типа
(шаблон функции)
ограничивает значение между парой граничных значений
(объект функции алгоритма)