std::flat_set::end,(3)

🌸 NAME — std::flat_set::end from the C++ Standard Libary manual 🌸

okay so bestie, welcome to std::flat_set::end, 💖 The NAME line is literally std::flat_set::end, — std::flat_set::end, (trailing comma included, we respect the chaos). This is the C++ Standard Library page for it, and yes the original header spells the manual C++ Standard Libary — iconic typo, no cap.

🎀 Synopsis 🎀

Three overloads, all since C++23:

iterator end() noexcept;              (1) (since C++23)
const_iterator end() const noexcept;  (2) (since C++23)
const_iterator cend() const noexcept; (3) (since C++23)

It returns an iterator to the element following the last element of the flat_set. That element is a placeholder, bestie — attempting to access it results in undefined behavior, so do not touch it 😭.

There’s also a diagram placeholder in the original here: range-begin-end.svg 🖼️.

🌈 Parameters 🌈

(none) — literally zero parameters. The void is serving. ✨

💖 Return value 💖

Iterator to the element following the last element. That’s it, that’s the tea ☕.

⚡ Complexity ⚡

Constant. Not linear, not spicy, just constant. periodt. 💅

🧠 Notes 🧠

Because both iterator and const_iterator are constant iterators (and may in fact be the same type), it is not possible to mutate the elements of the container through an iterator returned by any of these member functions.

So no sneaky editing through end() or cend() — the vibes are read-only, fr fr. 🫶

🍓 Example 🍓

// Run this code — literally go run it:

#include <algorithm>
#include <flat_set>
#include <iostream>

int main()
{
    std::flat_set<int> set{3, 1, 4, 1, 5, 9, 2, 6, 5};
    std::for_each(set.cbegin(), set.cend(), [](int x)
    {
        std::cout << x << ' ';
    });
    std::cout << '\n';
}

🌟 Output 🌟

1 2 3 4 5 6 9

👀 See also 👀

• begin — returns an iterator to the beginning
• cbegin — (public member function)
• end
• cend — returns an iterator to the end of a container or array
• (C++11) — (function template)
• (C++14)

xoxo, your Unix bestie 💅 — source: http://cppreference.com, version/date: 2024.06.10, page: std::flat_set::end,(3) 🫶