atomic_fetch_sub.md

atomic_fetch_sub

• atomic[meta header]
• std[meta namespace]
• function template[meta id-type]
• cpp11[meta cpp]

namespace std {
  template <class T>
  T atomic_fetch_sub(
      volatile atomic<T>* object,
      T operand) noexcept;                                   // (1) C++11

  template <class T>
  T atomic_fetch_sub(
      volatile atomic<T>* object,
      typename atomic<T>::difference_type operand) noexcept; // (1) C++17

  template <class T>
  T atomic_fetch_sub(
      atomic<T>* object,
      T operand) noexcept;                                   // (2) C++11

  template <class T>
  T atomic_fetch_sub(
      atomic<T>* object,
      typename atomic<T>::difference_type operand) noexcept; // (2) C++17
}

• atomic[link /reference/atomic/atomic.md]

概要

アトミックに減算を行う

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

• (1), (2) :
  • C++17 : 型Tがオブジェクト型であること。型Tがvoid*や関数ポインタであってはならない
• (1) :
  • C++20 : atomic<T>::is_always_lock_freeがtrueであること

効果

memory_order_seq_cstのメモリオーダーにしたがって、現在の値にoperandを減算した値でアトミックに置き換える

戻り値

変更前の値が返される

例外

投げない

備考

符号付き整数型に対しては、2の補数表現による演算が行われ、未定義動作はない。アドレス型に関しては結果として未定義アドレスになる場合があるが、それ以外の未定義動作はない。

例

#include <iostream>
#include <atomic>

int main()
{
  std::atomic<int> x(3);

  int before = std::atomic_fetch_sub(&x, 2);

  std::cout << before << std::endl;
  std::cout << x.load() << std::endl;
}

• std::atomic_fetch_sub[color ff0000]
• x.load()[link /reference/atomic/atomic/load.md]

出力

3
1

バージョン

言語

• C++11

処理系

• Clang: ??
• GCC: 4.7.0
• ICC: ??
• Visual C++: 2012, 2013

関連項目

• C++20 ほとんどのvolatileを非推奨化

参照

• P0558R1 Resolving atomic<T> named base class inconsistencies
• P1831R1 Deprecating volatile: library
  • C++20での、volatile版への制約追加