std::atomic_fetch_and, std::atomic_fetch_and_explicit

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Execution support library (C++26)

Technical specifications

Symbols index

External libraries

 

Atomic operations library

Types

atomic (C++11)

atomic_ref (C++20)

Functions

atomic_storeatomic_store_explicit (C++11)(C++11)

atomic_loadatomic_load_explicit (C++11)(C++11)

atomic_exchangeatomic_exchange_explicit (C++11)(C++11)

atomic_compare_exchange_weakatomic_compare_exchange_weak_explicitatomic_compare_exchange_strongatomic_compare_exchange_strong_explicit (C++11)(C++11)(C++11)(C++11)

atomic_fetch_addatomic_fetch_add_explicit (C++11)(C++11)

atomic_fetch_subatomic_fetch_sub_explicit (C++11)(C++11)

atomic_fetch_andatomic_fetch_and_explicit (C++11)(C++11)

atomic_fetch_oratomic_fetch_or_explicit (C++11)(C++11)

atomic_fetch_xoratomic_fetch_xor_explicit (C++11)(C++11)

atomic_is_lock_free (C++11)

atomic_waitatomic_wait_explicit (C++20)(C++20)

atomic_notify_one (C++20)

atomic_notify_all (C++20)

Atomic flags

atomic_flag (C++11)

atomic_flag_test_and_setatomic_flag_test_and_set_explicit (C++11)(C++11)

atomic_flag_clearatomic_flag_clear_explicit (C++11)(C++11)

atomic_flag_testatomic_flag_test_explicit (C++20)(C++20)

atomic_flag_waitatomic_flag_wait_explicit (C++20)(C++20)

atomic_flag_notify_one (C++20)

atomic_flag_notify_all (C++20)

Initialization

atomic_init (C++11)(deprecated in C++20)

ATOMIC_VAR_INIT (C++11)(deprecated in C++20)

ATOMIC_FLAG_INIT (C++11)(deprecated in C++20)

Memory ordering

memory_order (C++11)

kill_dependency (C++11)

atomic_thread_fence (C++11)

atomic_signal_fence (C++11)

 

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

<td>

Defined in header <atomic>

</td>

<td></td> <td></td> </tr> <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)

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 sycnhronization 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); }

See also

Template:cpp/atomic/atomic/dcl list fetch andTemplate:cpp/atomic/dcl list atomic fetch orTemplate:cpp/atomic/dcl list atomic fetch xor