std::div_sat

Defined in header `<numeric>`
template< class T > constexpr T div_sat( T x, T y ) noexcept;		(с C++26)

Вычисляет насыщающее деление x / y. Если T — тип целого со знаком, x — наименьшее (наиболее отрицательное) значение T, а y == -1, возвращает наибольшее значение T; в противном случае возвращает x / y.

y не должно быть 0, в противном случае поведение не определено.

Этот перегруз участвует в разрешении перегрузки только если T является целым типом, то есть: signed char, short, int, long, long long, расширенный тип целого со знаком или беззнаковый аналог таких типов. В частности, T не должно быть (возможно, с квалификаторами cv) bool, char, wchar_t, char8_t, char16_t и char32_t, так как эти типы не предназначены для арифметики.

Параметры

x, y

целочисленные значения

Значение результата

Насыщенное x / y.

Исключения

Не выбрасывает исключений.

Примечания

В отличие от встроенных арифметических операторов над целыми числами, целочисленное продвижение не применяется к аргументам x и y.

Если переданы два аргумента разных типов, вызов не проходит компиляцию, т.е. поведение относительно вывода шаблонных аргументов такое же, как для std::min или std::max.

Большинство современных архитектур процессоров имеют эффективную поддержку насыщающей арифметики для векторов SIMD, включая SSE2 для x86 и NEON для ARM.

Макроинструкция проверки наличия функции	Значение	Стандарт	Функция
`__cpp_lib_saturation_arithmetic`	202311L	(C++26)	Насыщающая арифметика

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

См. libstdc++ (gcc).

Пример

Предварительный просмотр можно сделать на Compiler Explorer.

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

См. также

add_sat (C++26)	операция насыщающего сложения двух целых чисел (шаблон функции)
sub_sat (C++26)	операция насыщающего вычитания двух целых чисел (шаблон функции)
mul_sat (C++26)	операция насыщающего умножения двух целых чисел (шаблон функции)
saturate_cast (C++26)	возвращает целочисленное значение, ограниченное диапазоном другого целочисленного типа (шаблон функции)
clamp (C++17)	ограничивает значение между парой граничных значений (шаблон функции)
in_range (C++20)	проверяет, находится ли целочисленное значение в диапазоне заданного целочисленного типа (шаблон функции)
min [статический]	возвращает наименьшее конечное значение заданного типа (публичная статическая функция-член `std::numeric_limits<T>`)
max [статический]	возвращает наибольшее конечное значение заданного типа (публичная статическая функция-член `std::numeric_limits<T>`)

Внешние ссылки

1.	A branch-free implementation of saturation arithmetic — Locklessinc.com, 2012

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/numeric/div_sat