Namespaces
Variants

std:: clamp

From cppreference.net
C++
Algorithm library
Constrained algorithms and algorithms on ranges (C++20)
Constrained algorithms, e.g. ranges::copy , ranges::sort , ...
Execution policies (C++17)
Non-modifying sequence operations
Batch operations
(C++17)
Search operations
Modifying sequence operations
Copy operations
(C++11)
(C++11)
(C++11)
Swap operations
Transformation operations
Generation operations
Removing operations
Order-changing operations
(until C++17) (C++11)
(C++20) (C++20)
Sampling operations
(C++17)

Sorting and related operations
Partitioning operations
Sorting operations
Binary search operations
(on partitioned ranges)
Set operations (on sorted ranges)
Merge operations (on sorted ranges)
Heap operations
Minimum/maximum operations
(C++11)
clamp
(C++17)
Lexicographical comparison operations
(C++20)
Permutation operations
C library
Numeric operations
Operations on uninitialized memory
Определено в заголовочном файле <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;
}

Примечания

Capturing the result of std::clamp by reference produces a dangling reference if one of the parameters is a temporary and that parameter is returned: 
int n = -1;
const int& r = std::clamp(n, 0, 255); // r является висячей ссылкой

Если 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)
проверяет, находится ли целочисленное значение в диапазоне заданного целочисленного типа
(шаблон функции)
(C++20)
ограничивает значение между парой граничных значений
(функциональный объект алгоритма)