5. fetch_max

最終更新日時:
が更新

履歴 編集

function
<atomic>

std::atomic_ref::fetch_max(C++26)

constexpr T
  fetch_max(difference_type operand,
            memory_order order = memory_order_seq_cst
            ) const noexcept;                         // (1) C++26

概要

最大値を設定・取得する。

この関数は、現在の値とoperandの大きい方を求め、その値で現在の値を置き換える。戻り値は変更前の値である。

テンプレートパラメータ制約

  • (1) : std::atomic_ref<T*>の場合、型Tがオブジェクト型であること。型Tがvoid*や関数ポインタであってはならない

効果

orderで指定されたメモリオーダーにしたがって、std::max()アルゴリズムのように現在の値とoperandの最大値を求めて、その値で現在の値をアトミックに置き換える

戻り値

変更前の値が返される

例外

投げない

備考

  • この関数は、atomic_refクラスの整数型、浮動小数点数型、ポインタに対する特殊化で定義される
  • 浮動小数点数型
    • std::fmaximum_num()関数と同様の動作をするが、以下の点で異なる：
      • 両方のパラメータがNaNである場合、現在の値は未規定のNaN値に置き換えられる
      • 一方のパラメータだけがNaNである場合、現在の値はもう一方のパラメータ、または未規定のNaN値に置き換えられるが、どちらに置き換えられるかは未規定
      • パラメータが異なる符号のゼロである場合、現在の値がどちらに置き換えられるかは未規定
        • 処理系への推奨としては、負のゼロを正のゼロより小さいものとして扱うべきである
  • ポインタ型
    • ポインタが異なる完全型オブジェクトを指している場合、<演算子による比較は狭義の弱順序を確立しない

例

#include <iostream>
#include <atomic>

int main()
{
  int x = 2;
  int ret = std::atomic_ref{x}.fetch_max(3);

  std::cout << ret << std::endl;
  std::cout << x << std::endl;
}

出力

2
3

バージョン

言語

  • C++26

処理系

参照