std::shared...owner_equal(3)

💖 std::shared_ptr::owner_equal 💖

okay so bestie, we're in the C++ Standard Libary manual (yes, that's the spelling on the page 👀), and this is the page for std::shared_ptr::owner_equal — the header does that truncated std::shared...owner_equal(3) thing, which is very mysterious of it. But lowkey this is just a slay little equality check. Let's get into it 💅

---

✨ NAME ✨

std::shared_ptr::owner_equal — std::shared_ptr::owner_equal

🌸 Synopsis 🌸

here's the whole synopsis exactly as it appears, markers and all — do not @ me about the line breaks 😭

template< class Y >
bool owner_equal( const std::shared_ptr<Y>& other ) const
(1) (since C++26)
noexcept;
template< class Y >
(2) (since C++26)
bool owner_equal( const std::weak_ptr<Y>& other ) const noexcept;

okay so what it actually does: it checks whether this shared_ptr and other share ownership, or whether they're both empty. The comparison is set up so two smart pointers compare equivalent only if they're both empty or both own the same object — even if the values of the pointers you get from get() are different (e.g. because they point at different subobjects within the same object). no cap 🫶

The member function owner_equal is an equivalence relation such that !owner_before(other) && !other.owner_before(*this) is true if and only if owner_equal(other) is true. iconic behavior honestly ✨

This ordering is used to make shared and weak pointers usable as keys in unordered associative containers, typically through std::owner_equal. yep, it's giving "container key main character energy" 👑

🫶 Parameters 🫶

• other — the std::shared_ptr or std::weak_ptr to be compared

🔥 Return value 🔥

true if *this and other share ownership or are both empty. Otherwise, returns false. simple as that, bestie 💅

🧠 Notes 🧠

the feature-test macro situation is:

• Feature-test macro: __cpp_lib_smart_ptr_owner_equality
• Value: 202306L
• Std: (C++26)
• Feature: Enabling the use of std::shared_ptr as keys in unordered associative containers

🌈 Example 🌈

This section is incomplete 😭

Reason: example

👑 See also 👑

• owner_equal (C++26) — provides mixed-type owner-based equal comparisons of shared and weak pointers (class)

🗂️ Category

• Todo with reason

---

mwah 💋 that's the whole page. source: http://cppreference.com · version/date: 2024.06.10 · footer title: std::shared...owner_equal(3). stay hydrated and may your pointers always share ownership correctly 🫶✨🌸