Namespaces
Variants
Views
Actions

std::atomic_ref<T>::fetch_sub

From cppreference.com
< cpp‎ | atomic‎ | atomic ref
 
 
Concurrency support library
Threads
(C++11)
(C++20)
(C++20)
this_thread namespace
(C++11)
(C++11)
(C++11)
Mutual exclusion
(C++11)
(C++11)  
Generic lock management
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
(C++11)
(C++11)
Condition variables
(C++11)
Semaphores
Latches and Barriers
(C++20)
(C++20)
Futures
(C++11)
(C++11)
(C++11)
(C++11)
Safe Reclamation
(C++26)
(C++26)
Hazard Pointers

Atomic types
(C++11)
(C++20)
Initialization of atomic types
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
Memory ordering
Free functions for atomic operations
Free functions for atomic flags
 
 
member only of atomic_ref<Integral> and atomic_ref<Floating> template specializations
T fetch_sub( T arg,
             std::memory_order order = std::memory_order_seq_cst ) const noexcept;
(1) (since C++20)
member only of atomic_ref<T*> template specialization
T* fetch_sub( std::ptrdiff_t arg,
              std::memory_order order = std::memory_order_seq_cst ) const noexcept;
(2) (since C++20)

Atomically replaces the current value of the referenced object with the result of arithmetic subtraction of the value and arg. This operation is a read-modify-write operation. Memory is affected according to the value of order.

For signed integral types, arithmetic is defined to use two’s complement representation. There are no undefined results.

For floating-point types, the floating-point environment in effect may be different from the calling thread's floating-point environment. The operation need not be conform to the corresponding std::numeric_limits traits but is encouraged to do so. If the result is not a representable value for its type, the result is unspecified but the operation otherwise has no undefined behavior.

For T* types, the result may be an undefined address, but the operation otherwise has no undefined behavior. The program is ill-formed if T is not an object type.

[edit] Parameters

arg - the other argument of arithmetic subtraction
order - memory order constraints to enforce

[edit] Return value

The value of the referenced object, immediately preceding the effects of this function.

[edit] Example