std::div_sat - cppreference.com (original) (raw)

| | | | | --------------------------------------------------------------- | | ------------- | | template< class T > constexpr T div_sat( T x, T y ) noexcept; | | (since C++26) |

Computes the saturating division x / y. If T is a signed integer type, x is the smallest (most negative) value of T, and y == -1, returns the greatest value of T; otherwise, returns x / y.

y must not be ​0​, otherwise the behavior is undefined. The function call is not a core constant expression if undefined behavior happens.

This overload participates in overload resolution only if T is an integer type, that is: signed char, short, int, long, long long, an extended signed integer type, or an unsigned version of such types. In particular, T must not be (possibly cv-qualified) bool, char, wchar_t, char8_t, char16_t, and char32_t, as these types are not intended for arithmetic.

Contents

• 1 Parameters
• 2 Return value
• 3 Notes
• 4 Possible implementation
• 5 Example
• 6 See also
• 7 External links

[edit] Parameters

[edit] Return value

Saturated x / y.

[edit] Notes

Unlike the built-in arithmetic operators on integers, the integral promotion does not apply to the x and y arguments.

If two arguments of different type are passed, the call fails to compile, i.e. the behavior relative to template argument deduction is the same as for std::min or std::max.

Most modern hardware architectures have efficient support for saturation arithmetic on SIMD vectors, including SSE2 for x86 and NEON for ARM.

[edit] Possible implementation

[edit] Example

Can be previewed on Compiler Explorer.

#include #include   static_assert ("" && (std::div_sat(6, 3) == 2) // not saturated && (std::div_sat(INT_MIN, -1) == INT_MAX) // saturated && (std::div_sat(6, 3) == 2) // not saturated );   int main() {}

[edit] See also

[edit] External links