std::atomic_fetch_sub, std::atomic_fetch_sub_explicit

 

C++

言語

標準ライブラリヘッダ

フリースタンディング処理系とホスト処理系

名前付き要件

言語サポートライブラリ

コンセプトライブラリ(C++20)

診断ライブラリ

ユーティリティライブラリ

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ(C++20)

アルゴリズムライブラリ

数値演算ライブラリ

ローカライゼーションライブラリ

入出力ライブラリ

ファイルシステムライブラリ(C++17)

正規表現ライブラリ(C++11)

アトミック操作ライブラリ(C++11)

スレッドサポートライブラリ(C++11)

技術仕様書

 

アトミック操作ライブラリ

型

atomic (C++11)

atomic_ref (C++20)

関数

atomic_storeatomic_store_explicit (C++11)(C++11)

atomic_loadatomic_load_explicit (C++11)(C++11)

atomic_exchangeatomic_exchange_explicit (C++11)(C++11)

atomic_compare_exchange_weakatomic_compare_exchange_weak_explicitatomic_compare_exchange_strongatomic_compare_exchange_strong_explicit (C++11)(C++11)(C++11)(C++11)

atomic_fetch_addatomic_fetch_add_explicit (C++11)(C++11)

atomic_fetch_subatomic_fetch_sub_explicit (C++11)(C++11)

atomic_fetch_andatomic_fetch_and_explicit (C++11)(C++11)

atomic_fetch_oratomic_fetch_or_explicit (C++11)(C++11)

atomic_fetch_xoratomic_fetch_xor_explicit (C++11)(C++11)

atomic_is_lock_free (C++11)

atomic_waitatomic_wait_explicit (C++20)(C++20)

atomic_notify_one (C++20)

atomic_notify_all (C++20)

アトミックフラグ

atomic_flag (C++11)

atomic_flag_test_and_setatomic_flag_test_and_set_explicit (C++11)(C++11)

atomic_flag_clearatomic_flag_clear_explicit (C++11)(C++11)

atomic_flag_testatomic_flag_test_explicit (C++20)(C++20)

atomic_flag_waitatomic_flag_wait_explicit (C++20)(C++20)

atomic_flag_notify_one (C++20)

atomic_flag_notify_all (C++20)

初期化

atomic_init (C++11)(C++20で非推奨)

ATOMIC_VAR_INIT (C++11)(C++20で非推奨)

ATOMIC_FLAG_INIT (C++11)(C++20で非推奨)

メモリ順序

memory_order (C++11)

kill_dependency (C++11)

atomic_thread_fence (C++11)

atomic_signal_fence (C++11)

 

ヘッダ <atomic> で定義
	(1)
template<class T > T atomic_fetch_sub(std::atomic<T>* obj,                     typenamestd::atomic<T>::difference_type arg )noexcept;
template<class T > T atomic_fetch_sub(volatilestd::atomic<T>* obj,                     typenamestd::atomic<T>::difference_type arg )noexcept;
		(2)
template<class T > T atomic_fetch_sub_explicit(std::atomic<T>* obj,                              typenamestd::atomic<T>::difference_type arg,                              std::memory_order order )noexcept;
template<class T > T atomic_fetch_sub_explicit(volatilestd::atomic<T>* obj,                              typenamestd::atomic<T>::difference_type arg,                              std::memory_order order )noexcept;

アトミック減算を行います。 obj の指す値から arg をアトミックに減算し、 obj がそれまで保持していた値を返します。 この操作は以下のコードが実行されたかのように行われます。

1)obj->fetch_sub(arg)

2)obj->fetch_sub(arg, order)

引数

obj	-	変更するアトミック変数を指すポインタ
arg	-	アトミック変数に格納されている値から減算する値
order	-	この操作に対するメモリ同期順序付け。 すべての値を指定できます。

戻り値

*obj の変更順序における、この関数の効果の直前の値。

実装例

template<class T > T atomic_fetch_sub(std::atomic<T>* obj, typenamestd::atomic<T>::difference_type arg )noexcept{return obj->fetch_sub(arg);}

例

インデックス付きコンテナを複数のスレッドで並行的に処理するために fetch_sub を使用します。

Run this code

#include <string>#include <thread>#include <vector>#include <iostream>#include <atomic>#include <numeric>   constint N =50;std::atomic<int> cnt;std::vector<int> data(N);   void reader(int id){for(;;){int idx = atomic_fetch_sub_explicit(&cnt, 1, std::memory_order_relaxed);if(idx >=0){std::cout<<"reader "<<std::to_string(id)<<" processed item "<<std::to_string(data[idx])<<'\n';}else{std::cout<<"reader "<<std::to_string(id)<<" done\n";break;}}}   int main(){std::iota(data.begin(), data.end(), 1); cnt = data.size()-1;   std::vector<std::thread> v;for(int n =0; n <5;++n){ v.emplace_back(reader, n);}for(auto& t : v){ t.join();}}

出力:

reader 2 processed item 50 reader 1 processed item 44 reader 4 processed item 46 <....> reader 0 done reader 4 done reader 3 done

欠陥報告

以下の動作変更欠陥報告は以前に発行された C++ 標準に遡って適用されました。

DR	適用先	発行時の動作	正しい動作
P0558R1	C++11	exact type match required because T is deduced from multiple arguments	T is deduced from the atomic argument only

関連項目

fetch_sub	アトミックオブジェクトに格納されている値から引数の値をアトミックに減算し、以前保持されていた値を取得します (std::atomic<T>のパブリックメンバ関数)
atomic_fetch_addatomic_fetch_add_explicit (C++11)(C++11)	アトミックオブジェクトに非アトミック値を加算し、そのアトミックの以前の値を取得します (関数テンプレート)
atomic_fetch_sub, atomic_fetch_sub_explicit の C言語リファレンス