std::multiset::merge(3)

πŸ“¦ version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

🌸 NAME 🌸

std::multiset::merge β€” std::multiset::merge πŸ’…

Okay bestie, this is the std::multiset::merge(3) page from the C++ Standard Libary, and yes the NAME field is literally just the function name twice. Iconic behavior, no notes.


✨ Synopsis ✨

template< class C2 >                                      (1) (since C++17)
void merge( std::set<Key, C2, Allocator>& source );
template< class C2 >                                      (2) (since C++17)
void merge( std::set<Key, C2, Allocator>&& source );
template< class C2 >                                      (3) (since C++17)
void merge( std::multiset<Key, C2, Allocator>& source );
template< class C2 >                                      (4) (since C++17)
void merge( std::multiset<Key, C2, Allocator>&& source );

So the whole vibe is: it attempts to extract ("splice") each element in source and insert it into *this using the comparison object of *this. That's the main-character move.

No elements are copied or moved β€” only the internal pointers of the container nodes are repointed. All pointers and references to the transferred elements remain valid, but now refer into *this, not into source. Slay, but read that carefully.

🚨 The behavior is undefined if get_allocator() != source.get_allocator(). Like, literally do not test that vibe, bestie.

πŸ¦‹ Parameters πŸ¦‹

  • source β€” compatible container to transfer the nodes from.

πŸŽ€ Return value πŸŽ€

(none) β€” no return value, bestie. It's giving void energy.


πŸ’€ Exceptions πŸ’€

Does not throw unless comparison throws. That's the whole rule, no extra lore.


πŸ”₯ Complexity πŸ”₯

It's N * log(size() + N)), where N is source.size(). Yep, keep that extra ) exactly as written β€” we do not "fix" the math here, we preserve the artifact πŸ’….


🌈 Example 🌈

// Run this code

#include <iostream>
#include <set>

// print out a container
template<class Os, class K>
Os& operator<<(Os& os, const std::multiset<K>& v)
{
    os << '[' << v.size() << "] {";
    bool o{};
    for (const auto& e : v)
        os << (o ? ", " : (o = 1, " ")) << e;
    return os << " }\n";
}

int main()
{
    std::multiset<char>
        p{'C', 'B', 'B', 'A'},
        q{'E', 'D', 'E', 'C'};

    std::cout << "p: " << p << "q: " << q;

    p.merge(q);

    std::cout << "p.merge(q);\n" << "p: " << p << "q: " << q;
}

⭐ Output ⭐

p: [4] { A, B, B, C }
q: [4] { C, D, E, E }
p.merge(q);
p: [8] { A, B, B, C, C, D, E, E }
q: [0] { }

Look at q after the merge: q: [0] { } β€” empty. gone. transferred. iconic. ✨


πŸ‘‘ See also πŸ‘‘

  • extract β€” extracts nodes from the container. (C++17) (public member function)
  • insert β€” inserts elements or nodes. (since C++17) (public member function)

Source/version and date, bestie: http://cppreference.com, 2024.06.10, page std::multiset::merge(3). Bye queen, go merge responsibly πŸ«ΆπŸ’–πŸŽ€

πŸ“¦ where this page comes from