Namespaces
Variants
Views
Actions

std::atomic::fetch_sub

From cppreference.com
< cpp‎ | atomic‎ | atomic
Revision as of 21:47, 31 May 2013 by P12bot (Talk | contribs)

 
 
 
 
T fetch_sub( T arg,

             memory_order = std::memory_order_seq_cst );
T fetch_sub( T arg,

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

              memory_order = std::memory_order_seq_cst );
T* fetch_sub( std::ptrdiff_t arg,

              memory_order = std::memory_order_seq_cst ) volatile;
(member only of atomic<T*> template specialization)
(since C++11)

Atomically replaces the current value with the result of arithmetic subtraction 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 subtraction
memory_order - memory order constraints to enforce

Return value

The value of the atomic variable before the call.

Exceptions

noexcept specification:  
noexcept
  

See also

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