| Defined in header <algorithm>
|
||
template< class T > constexpr const T& clamp( const T& v, const T& lo, const T& hi ); |
(1) | (since C++17) |
template< class T, class Compare > constexpr const T& clamp( const T& v, const T& lo, const T& hi, Compare comp ); |
(2) | (since C++17) |
If the value of v is within [lo, hi], returns v; otherwise returns the nearest boundary.
comp to compare the values.If lo is greater than hi, the behavior is undefined.
- ↑ If
NaNis avoided,Tcan be a floating-point type.
Parameters
| v | - | the value to clamp |
| lo, hi | - | the boundaries to clamp v to
|
| comp | - | comparison function object (i.e. an object that satisfies the requirements of Compare) which returns true if the first argument is less than the second.The signature of the comparison function should be equivalent to the following: bool cmp(const Type1& a, const Type2& b); While the signature does not need to have |
Return value
Reference to lo if v is less than lo, reference to hi if hi is less than v, otherwise reference to v.
Complexity
comp.Possible implementation
| clamp (1) |
|---|
|
| clamp (2) |
|
Notes
Capturing the result ofstd::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 is danglingIf v compares equivalent to either bound, returns a reference to v, not the bound.
| Feature-test macro | Value | Std | Feature |
|---|---|---|---|
__cpp_lib_clamp |
201603L |
(C++17) | std::clamp
|
Example
#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 255See also
| returns the smaller of the given values (function template) | |
| returns the greater of the given values (function template) | |
| (C++20) |
checks if an integer value is in the range of a given integer type (function template) |
| (C++20) |
clamps a value between a pair of boundary values (algorithm function object) |
Content from this page on cppreference.com, licensed under CC-BY-SA 3.0 and GFDL. Modified: restyled, site navigation removed, code windows added. Offline snapshot of 9 February 2025.