std::atomic_ref<T>::compare_exchange_weak, std::atomic_ref<T>::compare_exchange_strong

 

C++

コンパイラサポート

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

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

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

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

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

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

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

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

並行性サポートライブラリ

スレッド thread (C++11) jthread (C++20) hardware_destructive_interference_sizehardware_constructive_interference_size (C++17)(C++17) this_thread 名前空間 get_id (C++11) yield (C++11) sleep_for (C++11) sleep_until (C++11) 協調的なキャンセル stop_token (C++20) inplace_stop_token (C++26) never_stop_token (C++26) stop_source (C++20) inplace_stop_source (C++26)   stop_callback (C++20) inplace_stop_callback (C++26) stop_callback_for_t (C++26) stoppable_token (C++26) unstoppable_token (C++26) stoppable-source (C++26) stoppable-callback-for (C++26)   排他制御 mutex (C++11) recursive_mutex (C++11) shared_mutex (C++17) timed_mutex (C++11) recursive_timed_mutex (C++11) shared_timed_mutex (C++14) 汎用ロック管理 lock (C++11) lock_guard (C++11) scoped_lock (C++17) unique_lock (C++11) shared_lock (C++14) once_flag (C++11) call_once (C++11) try_lock (C++11) defer_locktry_to_lockadopt_lockdefer_lock_ttry_to_lock_tadopt_lock_t (C++11)(C++11)(C++11)(C++11)(C++11)(C++11) 条件変数 condition_variable (C++11) condition_variable_any (C++11) notify_all_at_thread_exit (C++11) cv_status (C++11) セマフォ counting_semaphorebinary_semaphore (C++20)(C++20) ラッチとバリア latch (C++20) barrier (C++20) future promise (C++11) future (C++11) shared_future (C++11) packaged_task (C++11) async (C++11) launch (C++11) future_status (C++11) future_error (C++11) future_category (C++11) future_errc (C++11) 安全なメモリ解放 (Safe Reclamation) rcu_obj_base (C++26) rcu_domain (C++26) rcu_default_domain (C++26) rcu_synchronize (C++26) rcu_barrier (C++26) rcu_retire (C++26) ハザードポインタ hazard_pointer_obj_base (C++26) hazard_pointer (C++26) make_hazard_pointer (C++26)

アトミック型 atomic (C++11) atomic_ref (C++20) atomic_flag (C++11) アトミック型の初期化 atomic_init (C++11)(C++20で非推奨) ATOMIC_VAR_INIT (C++11)(C++20で非推奨) ATOMIC_FLAG_INIT (C++11) メモリオーダー memory_order (C++11) kill_dependency (C++11)(C++26で非推奨) atomic_thread_fence (C++11) atomic_signal_fence (C++11) アトミック操作のためのフリー関数 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_fetch_maxatomic_fetch_max_explicit (C++26)(C++26) atomic_fetch_minatomic_fetch_min_explicit (C++26)(C++26) 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_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)

 

std::atomic_ref

メンバ関数

atomic_ref::atomic_ref

atomic_ref::operator=

atomic_ref::is_lock_free

atomic_ref::store

atomic_ref::load

atomic_ref::operator value_type

atomic_ref::exchange

atomic_ref::compare_exchange_strongatomic_ref::compare_exchange_weak

atomic_ref::wait

atomic_ref::notify_one

atomic_ref::notify_all

atomic_ref::address (C++26)

算術型のための操作 (boolとオブジェクトへのポインタを除く)

atomic_ref::fetch_add

atomic_ref::fetch_sub

atomic_ref::operator+=atomic_ref::operator-=

整数型のための操作 (boolとオブジェクトへのポインタを除く)

atomic_ref::fetch_max (C++26)

atomic_ref::fetch_min (C++26)

atomic_ref::operator++atomic_ref::operator++(int)atomic_ref::operator--atomic_ref::operator--(int)

整数型のための操作 (boolを除く)

atomic_ref::fetch_and

atomic_ref::fetch_or

atomic_ref::fetch_xor

atomic_ref::operator&=atomic_ref::operator|=atomic_ref::operator^=

定数

atomic_ref::is_always_lock_free

atomic_ref::required_alignment

 

bool compare_exchange_weak     ( value_type& expected, value_type desired,       std::memory_order success,       std::memory_order failure ) const noexcept;	(1)	(C++26 以降 constexpr)
bool compare_exchange_weak     ( value_type& expected, value_type desired,       std::memory_order order =           std::memory_order_seq_cst ) const noexcept;	(2)	(C++26 以降 constexpr)
bool compare_exchange_strong     ( value_type& expected, value_type desired,       std::memory_order success,       std::memory_order failure ) const noexcept;	(3)	(C++26 以降 constexpr)
bool compare_exchange_strong     ( value_type& expected, value_type desired,       std::memory_order order =           std::memory_order_seq_cst ) const noexcept;	(4)	(C++26 以降 constexpr)

参照されているオブジェクトの値表現をexpectedの値表現と比較し、ビット列が等しい場合は、前者を参照されているオブジェクトにdesiredで置き換えます（読み取り・変更・書き込み操作を実行します）。そうでない場合は、参照されているオブジェクトに格納されている実際の値をexpectedにロードします（ロード操作を実行します）。

1,3) 読み取り・変更・書き込み操作とロード操作のメモリモデルは、それぞれsuccessとfailureです。

2,4) orderは、読み取り・変更・書き込み操作とロード操作の両方に使用されます。ただし、orderがstd::memory_order_acq_relまたはstd::memory_order_releaseの場合、ロード操作にはそれぞれstd::memory_order_acquireまたはstd::memory_order_relaxedが使用されます。

これらのオーバーロードは、std::is_const_v<T>がfalseである場合にのみ、オーバーロード解決に参加します。

もしfailureがstd::memory_order_relaxed、std::memory_order_consume、std::memory_order_acquire、またはstd::memory_order_seq_cstでない場合、動作は未定義となります。

パラメータ

expected	-	atomic_refオブジェクトが参照するオブジェクト内に期待される値への参照
desired	-	期待通りであった場合に、参照されているオブジェクトに格納される値
success	-	比較が成功した場合の読み取り-変更-書き込み操作のメモリ同期順序
failure	-	比較が失敗した場合の読み込み操作のメモリ同期順序
order	-	両方の操作のメモリ同期順序

戻り値

参照されているオブジェクトが正常に変更された場合はtrue、それ以外の場合はfalse。

注意

比較とコピーはビット単位（std::memcmpおよびstd::memcpyに類似）であり、コンストラクタ、代入演算子、または比較演算子は使用されません。

関数の弱い形式(1,2)は、偽陽性で失敗することが許容されています。つまり、それらが等しい場合でも、*this != expectedであるかのように動作します。compare-and-exchangeがループ内にある場合、弱いバージョンは一部のプラットフォームでより良いパフォーマンスを発揮します。

弱いcompare-and-exchangeがループを必要とし、強いものがそうしない場合、value_typeのオブジェクト表現にトラップビットが含まれている可能性がある場合、または同じ値に対して複数のオブジェクト表現を提供する（例：浮動小数点NaN）場合を除き、強いものが好ましいです。これらの場合、弱いcompare-and-exchangeは通常、安定したオブジェクト表現にすぐに収束するため機能します。

一部のメンバーの値表現には参加するが、他のメンバーの値表現には参加しないビットを持つ共用体の場合、比較交換は常に失敗する可能性があります。これは、アクティブなメンバーの値表現に参加しない場合、そのようなパディングビットには不定な値が含まれるためです。

オブジェクトの値表現に決して参加しないパディングビットは無視されます。

欠陥報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 3508 (P3323R1)	C++20	compare_exchange_weakおよびcompare_exchange_strong はconst Tにとっては無意味でした。	非 const T のみを受け入れるように制約されました。