std::saturate_cast
From cppreference.com
C++
Feature test macros (C++20)
Concepts library (C++20)
Metaprogramming library (C++11)
Ranges library (C++20)
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Numerics library
Interpolations
Generic numeric operations
C-style checked integer arithmetic
Mathematical special functions (C++17)
Mathematical constants (C++20)
Basic linear algebra algorithms (C++26)
Data-parallel types (SIMD) (C++26)
Floating-point environment (C++11)
Bit manipulation (C++20)
Saturation arithmetic (C++26)
(C++17)
(C++17)
(C++20)
(C++20)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++26)
Defined in header
<numeric>
template< class T, class U >
constexpr T saturate_cast( U x ) noexcept;
(since C++26)
constexpr T saturate_cast( U x ) noexcept;
Converts the value x to a value of type T, clamping x between the minimum and maximum values of type T.
The program is ill-formed if either T or U is not a signed or unsigned integer type (including standard integer type and extended integer type).
[edit] Parameters
x
-
an integer value
[edit] Return value
- x, if x is representable as a value of type
T. Otherwise, - either the largest or smallest representable value of type
T, whichever is closer to the value of x.
[edit] Notes
| Feature-test macro | Value | Std | Feature |
|---|---|---|---|
__cpp_lib_saturation_arithmetic |
202311L |
(C++26) | Saturation arithmetic |
[edit] Possible implementation
See libstdc++ (GCC).
[edit] Example
Can be previewed on Compiler Explorer.
Run this code
#include <cstdint> #include <limits> #include <numeric> int main() { constexpr std::int16_t x1{696}; constexpr std::int8_t x2 = std::saturate_cast<std::int8_t >(x1); static_assert(x2 == std::numeric_limits <std::int8_t >::max()); constexpr std::uint8_t x3 = std::saturate_cast<std::uint8_t >(x1); static_assert(x3 == std::numeric_limits <std::uint8_t >::max()); constexpr std::int16_t y1{-696}; constexpr std::int8_t y2 = std::saturate_cast<std::int8_t >(y1); static_assert(y2 == std::numeric_limits <std::int8_t >::min()); constexpr std::uint8_t y3 = std::saturate_cast<std::uint8_t >(y1); static_assert(y3 == 0); }
[edit] See also
(C++20)
(function template) [edit]