std::add_sat

template< class T >
constexpr T add_sat( T x, T y ) noexcept;

Вычисляет насыщающее сложение x + y. Данная операция (в отличие от встроенных арифметических операций над целыми числами) ведет себя так, как будто она является математической операцией с бесконечным диапазоном. Пусть q обозначает результат такой операции. Возвращает:

• q, если q представимо как значение типа T. В противном случае,
• наибольшее или наименьшее значение типа T, которое ближе всего к q.

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

Параметры

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

Насыщающее x + y.

Исключение

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

Примечания

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

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

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

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

См. libstdc++ (gcc).

Пример

#include <climits>
#include <limits>
#include <numeric>
 
static_assert(CHAR_BIT == 8);
static_assert(UCHAR_MAX == 255);
 
int main()
{
    constexpr int a = std::add_sat(3, 4); // no saturation occurs, T = int
    static_assert(a == 7);
 
    constexpr unsigned char b = std::add_sat<unsigned char>(UCHAR_MAX, 4); // saturated
    static_assert(b == UCHAR_MAX);
 
    constexpr unsigned char c = std::add_sat(UCHAR_MAX, 4); // not saturated, T = int
        // add_sat(int, int) returns int tmp == 259,
        // then assignment truncates 259 % 256 == 3
    static_assert(c == 3);
 
//  unsigned char d = std::add_sat(252, c); // Error: inconsistent deductions for T
 
    constexpr unsigned char e = std::add_sat<unsigned char>(251, a); // saturated
    static_assert(e == UCHAR_MAX);
        // 251 is of type T = unsigned char, `a` is converted to unsigned char value;
        // might yield an int -> unsigned char conversion warning for `a`
 
    constexpr signed char f = std::add_sat<signed char>(-123, -3); // not saturated
    static_assert(f == -126);
 
    constexpr signed char g = std::add_sat<signed char>(-123, -13); // saturated
    static_assert(g == std::numeric_limits<signed char>::min()); // g == -128
}

См. также

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