std::atomic...s_lock_free(3)

💖 NAME 💖

okay so this is the manual page for std::atomic_ref::is_always_lock_free — and yes, that name shows up twice in the original, so we're keeping both, periodt:

• std::atomic_ref::is_always_lock_free — the name, bestie ✨
• std::atomic_ref::is_always_lock_free — yep, again, iconic repetition 💅

The manual page title/manual name folded in near the top is std::atomic...s_lock_free(3), from the C++ Standard Libary — that spelling is literally in the original, no cap 🫶.

✨ Synopsis ✨

Here's the declaration, exactly as it shows up:

static constexpr bool is_always_lock_free =
(since C++20)
/*implementation-defined*/;

So it's a static constexpr bool called is_always_lock_free, and it's been around (since C++20). The value is /*implementation-defined*/, meaning the implementation decides it — don't come for me, that's the lore 🌸.

It equals true if the operations on this atomic_ref type are always lock-free, and it equals false if they are never lock-free or sometimes lock-free. 🦋

The value of this constant is consistent with the result of the member function is_lock_free. iykyk 😌

👀 See also 👀

• is_lock_free — checks if the atomic_ref object is lock-free (public member function) 💖

Bestie, that's the whole page! Source is http://cppreference.com, version/date is 2024.06.10, and the manual name is std::atomic...s_lock_free(3). Mwah 💋✨