std::forward_list::front(3)

💖 NAME 💖

okay bestie, this manual page is std::forward_list::front(3) — the function itself is std::forward_list::front, and it lives in the C++ Standard Libary (that's how the header spells it, no cap). The NAME section is basically std::forward_list::front — std::forward_list::front; yes, it repeats itself, and honestly? iconic. 🦋

✨ Synopsis ✨

Here's the signature lineup, copied exactly:

reference front();             (1) (since C++11)
const_reference front() const; (2) (since C++11)

So it returns a reference to the first element in the container. 💅

🚨 Warning, bestie: calling front on an empty container causes undefined behavior. That is not a vibe. The page straight-up says it, fr fr. 😭

🎀 Parameters 🎀

• (none) — no arguments, no extra drama. She takes nothing. 💖

🌸 Return value 🌸

Reference to the first element. That's it. That's the whole return value. ✨

💫 Complexity 💫

Constant. Fast queen behavior, no cap. 👑

🧚 Notes 🧚

For a container c, the expression c.front() is equivalent to *c.begin(). iykyk. 🫶

🌈 Example 🌈

The following code uses front to display the first element of a std::forward_list<char>:

       // Run this code

        #include <forward_list>
        #include <iostream>

        int main()
        {
            std::forward_list<char> letters{'a', 'b', 'c', 'd', 'e', 'f'};

            if (!letters.empty())
                std::cout << "The first character is '" << letters.front() <<
       "'.\n";
        }

⭐ Output ⭐

The first character is 'a'.

🦋 See also 🦋

• push_front — inserts an element to the beginning (public member function)
• pop_front — removes the first element (public member function)

xoxo, bestie 💜 — source/version: http://cppreference.com, date: 2024.06.10. Footer info delivered with a bow, because we're cute like that. 🎀