std::atomic::fetch_xor(3)

🌸 std::atomic::fetch_xor(3) 🌸

okay so bestie, this is the C++ Standard Libary manual page for std::atomic::fetch_xor — yes, that’s how the manual name is spelled in the header, no cap 🙈. It’s giving atomic bit-flipping main character energy ✨.

💖 NAME 💖

std::atomic::fetch_xor — literally std::atomic::fetch_xor, periodt 💅.

🦋 Synopsis 🦋

okay so this one is a member only of atomic<Integral > specializations:

T fetch_xor( T arg, std::memory_order order =
       (1) (since C++11)
                                  std::memory_order_seq_cst ) noexcept;
T fetch_xor( T arg, std::memory_order order =
                                  std::memory_order_seq_cst ) volatile
       (2) (since C++11)
          noexcept;

Atomically replaces the current value with the result of bitwise XOR of the value and arg 💥. The operation is a read-modify-write operation, and memory is affected according to the value of order.

deprecated alert, bestie: since C++20, it is deprecated if std::atomic<T>::is_always_lock_free is false and overload (2) participates in overload resolution. So if that condition hits, it’s deprecated — not cute, but true 😭.

💅 Parameters 💅

• arg — the other argument of bitwise XOR.
• order — memory order constraints to enforce.

🎀 Return value 🎀

It returns the value immediately preceding the effects of this function in the modification order of *this 🫶.

👑 See also 👑

• atomic_fetch_xor — replaces the atomic object with the result of bitwise XOR.
• atomic_fetch_xor_explicit — with a non-atomic argument and obtains the previous value of the atomic.
• (C++11), (C++11), (function template) — the version and function-template tags from the original See also table, all present and accounted for 💅.

mwah 💋 — source: http://cppreference.com, version/date: 2024.06.10.