std::atomic_flag::test(3)

💖 std::atomic_flag::test(3) 💖

okay so hii bestie, welcome to this page from the C++ Standard Libary manual — it's literally about std::atomic_flag::test, and we're gonna make it make sense. no cap. 🫶

🌸 NAME 🌸

std::atomic_flag::test — std::atomic_flag::test

✨ Synopsis ✨

Here's the exact signature glow-up, bestie — keep the (1), (2), (since C++20), const volatile, const, and noexcept exactly where they are:

          bool test( std::memory_order order =
                         std::memory_order_seq_cst ) const volatile
       (1) (since C++20)
          noexcept;
          bool test( std::memory_order order =
       (2) (since C++20)
                         std::memory_order_seq_cst ) const noexcept;

So yeah: it atomically reads the value of the *this and returns the value. That's the whole vibe. ⭐

⚠️ warning bestie: if order is one of std::memory_order_release and std::memory_order_acq_rel, the behavior is undefined. not a drill. 💀

💅 Parameters 💅

• order — the memory synchronization ordering

🎀 Return value 🎀

The value atomically read. periodt. 💖

🦋 Example 🦋

This section is incomplete. Reason: no example.

(not me being sad about the missing example 😭)

👑 See also 👑

• atomic_flag_test — (C++20)
• atomic_flag_test_explicit — atomically returns the value of the flag (C++20) (function)

the (C++20) tags and the (function) tag are all preserved above — iykyk 💅

🏷️ Category 🏷️

• Todo no example

signed off from http://cppreference.com, date/version 2024.06.10 — bye bestie, go read those atomics! 💜✨