Namespaces
Variants

std::saturating_div

ja.cppreference.net より
 
 
 
 
ヘッダ <numeric>
template< class T >
constexpr T saturating_div( 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 引数には適用されません。

異なる型の2つの引数が渡された場合、呼び出しはコンパイルに失敗します。すなわち、テンプレート引数推論に関する動作は std::min または std::max と同じです。

最近のハードウェアアーキテクチャのほとんどは、SIMD ベクトル上の飽和演算を効率的にサポートしており、SSE2 (x86 向け) や NEON (ARM 向け) などがあります。

機能テスト マクロ 値 標準 機能
__cpp_lib_saturation_arithmetic 202311L (C++26) 飽和演算
202603L (C++26) 飽和演算関数の名称変更

実装例

namespace detail {
template<class T>
concept integer =
    std::is_integral_v<T> &&
    !std::is_same_v<std::remove_cv_t<T>, bool> &&
    !std::is_same_v<std::remove_cv_t<T>, char> &&
    !std::is_same_v<std::remove_cv_t<T>, char8_t> &&
    !std::is_same_v<std::remove_cv_t<T>, char16_t> &&
    !std::is_same_v<std::remove_cv_t<T>, char32_t> &&
    !std::is_same_v<std::remove_cv_t<T>, wchar_t>;
} // namespace detail

template<detail::integer T>
constexpr T saturating_div( T x, T y ) noexcept
{
    if constexpr (std::is_signed_v<T>)
        if (x == std::numeric_limits<T>::min() && y == -1)
            return std::numeric_limits<T>::max();
    return x / y;
}

例

Compiler Explorer でプレビューできます。

#include <climits>
#include <numeric>

static_assert
(""
    && (std::saturating_div<int>(6, 3) == 2) // not saturated
    && (std::saturating_div<int>(INT_MIN, -1) == INT_MAX) // saturated
    && (std::saturating_div<unsigned>(6, 3) == 2) // not saturated
);

int main() {}

関連項目

2つの整数に対する飽和加算演算
(関数テンプレート)
2つの整数に対する飽和減算演算
(関数テンプレート)
2つの整数に対する飽和乗算演算
(関数テンプレート)
別の整数型の範囲にクランプされた整数値を返す
(関数テンプレート)
(C++17)
値を一対の境界値の間にクランプする
(関数テンプレート & アルゴリズム関数オブジェクト)
(C++20)
整数値が指定の整数型の範囲内にあるかチェックする
(関数テンプレート)
[static]
指定された非浮動小数点型の最小の有限値、または指定された浮動小数点型の最小の正の正規化数を返す
(std::numeric_limits<T> のパブリック静的メンバ関数)
[static]
指定された型の最大の有限値を返す
(std::numeric_limits<T> のパブリック静的メンバ関数)

外部リンク

1.  分岐のない飽和演算の実装 — Locklessinc.com, 2012