std::atomic_ref

From cppreference.com
< cpp‎ | atomic
 
C++
 
Concurrency support library
Threads
(C++11)
(C++20)
(C++17)(C++17)
this_thread namespace
(C++11)
(C++11)
(C++11)
(C++11)
Cooperative cancellation
Mutual exclusion
(C++11)
(C++11)
(C++17)
Generic lock management
(C++11)
(C++11)
(C++17)
(C++11)
(C++14)
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)(C++11)(C++11)(C++11)
Condition variables
(C++11)
(C++11)
(C++11)
(C++11)
Semaphores
(C++20)(C++20)
Latches and Barriers
(C++20)
(C++20)
Futures
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
Safe Reclamation
(C++26)
(C++26)
(C++26)
Hazard Pointers
(C++26)
(C++26)
(C++26)
Atomic types
(C++11)
atomic_ref
(C++20)
(C++11)
Initialization of atomic types
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
(C++11)
Memory ordering
(C++11)
(C++11)
(C++11)
(C++11)
Free functions for atomic operations
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++26)(C++26)
(C++26)(C++26)
(C++11)
(C++20)(C++20)
(C++20)
(C++20)
Free functions for atomic flags
(C++11)(C++11)
(C++11)(C++11)
(C++20)(C++20)
(C++20)(C++20)
(C++20)
(C++20)
 
std::atomic_ref
Member functions
Constants
Specialized member functions
Specialized for integral,
floating-point and pointer types
Specialized for integral and
pointer types only
(C++26)
(C++26)
Specialized for integral types only
 
Defined in header <atomic>
template< class T >
struct atomic_ref;
 (1) (since C++20)
template< class T >
struct atomic_ref<T*>;
 (2) (since C++20)

The std::atomic_ref class template applies atomic operations to the object it references. For the lifetime of the std::atomic_ref object, the object it references is considered an atomic object. If one thread writes to an atomic object while another thread reads from it, the behavior is well-defined (see memory model for details on data races). In addition, accesses to atomic objects may establish inter-thread synchronization and order non-atomic memory accesses as specified by std::memory_order.

The lifetime of an object must exceed the lifetime of all std::atomic_refs that references the object. While any std::atomic_ref instance referencing an object exists, the object must be exclusively accessed through these std::atomic_ref instances. No subobject of an object referenced by an std::atomic_ref object may be concurrently referenced by any other std::atomic_ref object.

Atomic operations applied to an object through an std::atomic_ref are atomic with respect to atomic operations applied through any other std::atomic_ref referencing the same object.

std::atomic_ref is CopyConstructible.

Like language references, constness is shallow for std::atomic_ref - it is possible to modify the referenced value through a const std::atomic_ref object.

Specializations

Primary template

The primary std::atomic_ref template may be instantiated with any TriviallyCopyable type T (including bool): 

struct Counters { int a; int b; }; // user-defined trivially-copyable type
alignas(std::atomic_ref<Counters>::required_alignment) Counters counter;
std::atomic_ref<Counters> cnt(counter); // specialization for the user-defined type

Partial specialization for pointer types

The standard library provides partial specializations of the std::atomic_ref template for all pointer types. In addition to the operations provided for all atomic types, these specializations additionally support atomic arithmetic operations appropriate to pointer types, such as fetch_add, fetch_sub.

Specializations for integral types

When instantiated with one of the following integral types, std::atomic_ref provides additional atomic operations appropriate to integral types such as fetch_add, fetch_sub, fetch_and, fetch_or, fetch_xor:

  • The character types char, char8_t, char16_t, char32_t, and wchar_t;
  • The standard signed integer types: signed char, short, int, long, and long long;
  • The standard unsigned integer types: unsigned char, unsigned short, unsigned int, unsigned long, and unsigned long long;
  • Any additional integral types needed by the typedefs in the header <cstdint>.

Signed integer arithmetic is defined to use two's complement; there are no undefined results.

Specializations for floating-point types

When instantiated with one of the cv-unqualified floating-point types (float, double, long double and cv-unqualified extended floating-point types(since C++23)), std::atomic_ref provides additional atomic operations appropriate to floating-point types such as fetch_add and fetch_sub.

No operations result in undefined behavior even if the result is not representable in the floating-point type. The floating-point environment in effect may be different from the calling thread's floating-point environment.

Member types

Member type Definition
value_type see below
difference_type value_type (only for atomic_ref<Integral> and atomic_ref<Floating> specializations)
std::ptrdiff_t (only for std::atomic_ref<T*> specializations)

For every std::atomic_ref<X> (whether or not specialized), std::atomic_ref<X>::value_type is X.

difference_type is not defined in the primary atomic_ref template.

Member functions

 constructs an atomic_ref object
(public member function)
stores a value into the object referenced by an atomic_ref object
(public member function)
checks if the atomic_ref object is lock-free
(public member function)
atomically replaces the value of the referenced object with a non-atomic argument
(public member function)
atomically obtains the value of the referenced object
(public member function)
loads a value from the referenced object
(public member function)
atomically replaces the value of the referenced object and obtains the value held previously
(public member function)
atomically compares the value of the referenced object with non-atomic argument and performs atomic exchange if equal or atomic load if not
(public member function)
blocks the thread until notified and the atomic value changes
(public member function)
notifies at least one thread waiting on the atomic object
(public member function)
notifies all threads blocked waiting on the atomic object
(public member function)

Constants

[static]
 indicates that the type is always lock-free
(public static member constant)
[static]
 indicates the required alignment of an object to be referenced by atomic_ref
(public static member constant)

Specialized member functions

Specialized for integral, floating-point and pointer types
atomically adds the argument to the value stored in the referenced object and obtains the value held previously
(public member function)
atomically subtracts the argument from the value stored in the referenced object and obtains the value held previously
(public member function)
atomically adds to or subtracts from the referenced value
(public member function)
Specialized for integral and pointer types only
(C++26)
 atomically performs std::max between the argument and the value of the referenced object and obtains the value held previously
(public member function)
(C++26)
 atomically performs std::min between the argument and the value of the referenced object and obtains the value held previously
(public member function)
atomically increments or decrements the referenced object by one
(public member function)
Specialized for integral types only
atomically performs bitwise AND between the argument and the value of the referenced object and obtains the value held previously
(public member function)
atomically performs bitwise OR between the argument and the value of the referenced object and obtains the value held previously
(public member function)
atomically performs bitwise XOR between the argument and the value of the referenced object and obtains the value held previously
(public member function)
atomically performs bitwise AND, OR, XOR with the referenced value
(public member function)

Notes

Feature-test macro Value Std Feature
__cpp_lib_atomic_ref 201806L (C++20) std::atomic_ref

See also

(C++11)
 atomic class template and specializations for bool, integral, floating-point,(since C++20) and pointer types
(class template)
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/atomic/atomic_ref&oldid=171401"