std::atomic_fetch_xor, std::atomic_fetch_xor_explicit

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Atomic operations library

Types

atomic (C++11)

atomic_is_lock_free (C++11)

Functions

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 flags

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)

Initialization

atomic_init (C++11)

ATOMIC_VAR_INIT (C++11)

ATOMIC_FLAG_INIT (C++11)

Memory ordering

memory_order (C++11)

kill_dependency (C++11)

atomic_thread_fence (C++11)

atomic_signal_fence (C++11)

 

Defined in header <atomic>
	(1)	(since C++11)
template< class Integral > Integral atomic_fetch_xor( std::atomic<Integral>* obj, Integral arg );
template< class Integral > Integral atomic_fetch_xor( volatile std::atomic<Integral>* obj, Integral arg );
			(2)	(since C++11)
template< class Integral > Integral atomic_fetch_xor_explicit( std::atomic<Integral>* obj, Integral arg,                                     std::memory_order order );
template< class Integral > Integral atomic_fetch_xor_explicit( volatile std::atomic<Integral>* obj, Integral arg,                                     std::memory_order order );

Atomically replaces the value pointed by obj with the result of bitwise XOR between the old value of obj and arg. Returns the value obj held previously.

The operation is performed as if the following is executed:

1) obj->fetch_xor(arg)

2) obj->fetch_xor(arg, order)

Parameters

obj	-	pointer to the atomic object to modify
arg	-	the value to bitwise XOR to the value stored in the atomic object
order	-	the memory sycnhronization ordering for this operation: all values are permitted.

Return value

The value immediately preceding the effects of this function in the modification order of *obj.

Exceptions

noexcept specification:  

noexcept

  

Possible implementation

template< class T > typename std::enable_if<std::is_integral<T>::value && !std::is_same<T, bool>::value, T>::type atomic_fetch_xor( std::atomic<T>* obj, T arg ); { return obj->fetch_xor(arg); }

See also

fetch_xor	atomically performs bitwise XOR between the argument and the value of the atomic object and obtains the value held previously (public member function of std::atomic)
atomic_fetch_oratomic_fetch_or_explicit (C++11)(C++11)	replaces the atomic object with the result of logical OR with a non-atomic argument and obtains the previous value of the atomic (function template)
atomic_fetch_andatomic_fetch_and_explicit (C++11)(C++11)	replaces the atomic object with the result of logical AND with a non-atomic argument and obtains the previous value of the atomic (function template)
C documentation for atomic_fetch_xor, atomic_fetch_xor_explicit