STD::ATOMIC(3cxx)

💅 std::atomic< _Tp >(3cxx) — atomic-teen dream 💅

okay so bestie, welcome to the std::atomic< _Tp > page from libstdc++, manual section (3cxx). it’s literally the generic atomic type + primary class template, and it’s giving main character energy fr fr. 🫶✨

🌸 NAME 🌸

std::atomic< _Tp > — the generic atomic type, primary class template. periodt. 💖

✨ SYNOPSIS ✨

start with this include, bestie:

#include <atomic>

🎀 Public Types 🎀

• using value_type = _Tp — the public type alias, exactly as written. no cap. 💅

💖 Public Member Functions 💖

• constexpr atomic (_Tp __i) noexcept — constructor taking _Tp __i, and it’s constexpr + noexcept. cute. ✨
• atomic (const atomic &)=delete — this constructor overload is =delete, so it’s a hard no. 🚫
• bool compare_exchange_strong (_Tp &__e, _Tp __i, memory_order __m=memory_order_seq_cst) noexcept — the strong compare-exchange overload with memory_order __m=memory_order_seq_cst, noexcept. 💅
• bool compare_exchange_strong (_Tp &__e, _Tp __i, memory_order __m=memory_order_seq_cst) volatile noexcept — same strong overload, but volatile, same default memory_order __m=memory_order_seq_cst, noexcept. 🌀
• bool compare_exchange_strong (_Tp &__e, _Tp __i, memory_order __s, memory_order __f) noexcept — strong overload with memory_order __s, memory_order __f, noexcept. ⭐
• bool compare_exchange_strong (_Tp &__e, _Tp __i, memory_order __s, memory_order __f) volatile noexcept — same strong overload but volatile, with memory_order __s, memory_order __f, noexcept. 💫
• bool compare_exchange_weak (_Tp &__e, _Tp __i, memory_order __m=memory_order_seq_cst) noexcept — the weak compare-exchange overload with memory_order __m=memory_order_seq_cst, noexcept. 🍓
• bool compare_exchange_weak (_Tp &__e, _Tp __i, memory_order __m=memory_order_seq_cst) volatile noexcept — same weak overload, but volatile, same default memory_order __m=memory_order_seq_cst, noexcept. 🧚
• bool compare_exchange_weak (_Tp &__e, _Tp __i, memory_order __s, memory_order __f) noexcept — weak overload with memory_order __s, memory_order __f, noexcept. 🌸
• bool compare_exchange_weak (_Tp &__e, _Tp __i, memory_order __s, memory_order __f) volatile noexcept — same weak overload but volatile, with memory_order __s, memory_order __f, noexcept. 🦋
• _Tp exchange (_Tp __i, memory_order __m=memory_order_seq_cst) noexcept — exchange with _Tp __i, default memory_order __m=memory_order_seq_cst, noexcept. 🔥
• _Tp exchange (_Tp __i, memory_order __m=memory_order_seq_cst) volatile noexcept — same exchange but volatile, default memory_order __m=memory_order_seq_cst, noexcept. 💜
• bool is_lock_free () const noexcept — is_lock_free(), const, noexcept. 👑
• bool is_lock_free () const volatile noexcept — same is_lock_free() but const volatile, noexcept. 🌈
• _Tp load (memory_order __m=memory_order_seq_cst) const noexcept — load with default memory_order __m=memory_order_seq_cst, const, noexcept. ⭐
• _Tp load (memory_order __m=memory_order_seq_cst) const volatile noexcept — same load but const volatile, default memory_order __m=memory_order_seq_cst, noexcept. 💫
• operator _Tp () const noexcept — conversion operator to _Tp, const, noexcept. 🎀
• operator _Tp () const volatile noexcept — same conversion operator but const volatile, noexcept. 🌀
• _Tp operator= (_Tp __i) noexcept — assignment from _Tp __i, noexcept. 💖
• _Tp operator= (_Tp __i) volatile noexcept — same assignment from _Tp __i but volatile, noexcept. ✨
• atomic & operator= (const atomic &) volatile=delete — assignment from const atomic & is volatile=delete. 🚫
• atomic & operator= (const atomic &)=delete — assignment from const atomic & is =delete. 🚫
• void store (_Tp __i, memory_order __m=memory_order_seq_cst) noexcept — store with _Tp __i, default memory_order __m=memory_order_seq_cst, noexcept. 🌸
• void store (_Tp __i, memory_order __m=memory_order_seq_cst) volatile noexcept — same store but volatile, default memory_order __m=memory_order_seq_cst, noexcept. 🦋

🦋 Detailed Description 🦋

here’s the raw template snippet, exactly as the page gives it:

template<typename _Tp>
    struct std::atomic< _Tp >"Generic atomic type, primary class template.

in human terms: it’s the generic atomic type, and it’s the primary class template. slay. 💅

🌈 Template Parameters 🌈

• _Tp — type to be made atomic, must be trivially copyable. that’s the rule, bestie. 🫶

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code. so yeah, Doxygen auto-generated this for libstdc++ straight from the source — robot author moment. 🤖✨

---

okay that’s the whole page, bestie 💖 source/version: libstdc++; manual page: std::atomic< _Tp >(3cxx); date in the footer: not printed, so no cute date to give you. bye, slay, and may your atomics be iconic 🎀🦋