Namespaces
Variants
Views
Actions

std::atomic_fetch_and, std::atomic_fetch_and_explicit

From cppreference.com
< cpp‎ | atomic
Revision as of 17:31, 2 November 2012 by P12bot (Talk | contribs)

Template:ddcl list begin <tr class="t-dsc-header">

<td>
Defined in header <atomic>
</td>

<td></td> <td></td> <tr class="t-dcl ">

<td >
template< class Integral >
Integral atomic_fetch_and( std::atomic<Integral>* obj, Integral arg );
</td>

<td > (1) </td> <td > (since C++11) </td> </tr> <tr class="t-dcl ">

<td >
template< class Integral >
Integral atomic_fetch_and( volatile std::atomic<Integral>* obj, Integral arg );
</td>

<td > (2) </td> <td > (since C++11) </td> </tr> <tr class="t-dcl ">

<td >
template< class Integral >

Integral atomic_fetch_and_explicit( std::atomic<Integral>* obj, Integral arg,

                                    std::memory_order order);
</td>

<td > (3) </td> <td > (since C++11) </td> </tr> <tr class="t-dcl ">

<td >
template< class Integral >

Integral atomic_fetch_and_explicit( volatile std::atomic<Integral>* obj, Integral arg,

                                    std::memory_order order);
</td>

<td > (4) </td> <td > (since C++11) </td> </tr> Template:ddcl list end

1-2) Atomically replaces the value pointed by arg with the result of bitwise AND between the old value of obj and arg, and returns the value obj held previously, as if by obj->fetch_and(arg)

3-4) Atomically replaces the value pointed by arg with the result of bitwise AND between the old value of obj and arg, and returns the value obj held previously, as if by obj->fetch_and(arg, order)

Contents

Parameters

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

Return value

The value held previously by the atomic object pointed to by 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_and(std::atomic<T>* obj, T arg);
{
    return obj->fetch_and(arg);
}

Example

See also

Template:cpp/atomic/atomic/dcl list fetch andTemplate:cpp/atomic/dcl list atomic fetch orTemplate:cpp/atomic/dcl list atomic fetch xor
C documentation for atomic_fetch_and, atomic_fetch_and_explicit