Namespaces
Variants
Views
Actions

std::atomic::fetch_add

From cppreference.com
< cpp‎ | atomic‎ | atomic
Revision as of 12:03, 23 September 2013 by P12 (Talk | contribs)

 
 
 
 
(1) (since C++11)
(member only of atomic<Integral> template specialization)
T fetch_add( T arg,
             memory_order = std::memory_order_seq_cst );
T fetch_add( T arg,
             memory_order = std::memory_order_seq_cst ) volatile;
(2) (since C++11)
(member only of atomic<Integral> template specialization)
T* fetch_add( std::ptrdiff_t arg,
              memory_order = std::memory_order_seq_cst );
T* fetch_add( std::ptrdiff_t arg,
              memory_order = std::memory_order_seq_cst ) volatile;

Atomically replaces the current value with the result of arithmetic addition of the value and arg. The operation is read-modify-write operation. Memory is affected according to the value of memory_order.

For signed Integral types, arithmetic is defined to use two’s complement representation. There are no undefined results. For T* types, the result may be an undefined address, but the operations otherwise have no undefined behavior.

Contents

Parameters

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

Return value

The value of the atomic variable before the call.

Exceptions

noexcept specification:  
noexcept
  

See also

adds a non-atomic value to an atomic object and obtains the previous value of the atomic
(function template) [edit]