STD::ARRAY(3cxx)

💅 NAME 💅

std::array< _Tp, _Nm > — a standard container for storing a fixed size sequence of elements 💖

okay so real quick, this page lives in the 3cxx manual section, and it's literally the whole glow-up of "array but make it a real container." she's fixed size, she's stack-friendly, she's that girl. ✨

---

🎀 SYNOPSIS 🎀

#include <array>

🦋 Public Types

• const_iterator — typedef const value_type * const_iterator
• const_pointer — typedef const value_type * const_pointer
• const_reference — typedef const value_type & const_reference
• const_reverse_iterator — typedef std::reverse_iterator< const_iterator > const_reverse_iterator
• difference_type — typedef std::ptrdiff_t difference_type
• iterator — typedef value_type * iterator
• pointer — typedef value_type * pointer
• reference — typedef value_type & reference
• reverse_iterator — typedef std::reverse_iterator< iterator > reverse_iterator
• size_type — typedef std::size_t size_type
• value_type — typedef _Tp value_type

ngl that's a whole lot of typedefs but they're all just aliases doing their little jobs 🫶

🌸 Public Member Functions

• constexpr reference at(size_type __n) — bounds-checked access, and she will throw if you get messy 🙈
• constexpr const_reference at(size_type __n) const — same energy, const edition
• constexpr const_reference back() const noexcept — last element, no exceptions, bestie gets what she asks for
• constexpr reference back() noexcept — last element, mutable version
• constexpr const_iterator begin() const noexcept — start of the const parade
• constexpr iterator begin() noexcept — start of the party
• constexpr const_iterator cbegin() const noexcept — const iterator, but committed to the bit
• constexpr const_iterator cend() const noexcept — const end, same commitment
• constexpr const_reverse_iterator crbegin() const noexcept — const reverse start, queen of backwards
• constexpr const_reverse_iterator crend() const noexcept — const reverse end
• constexpr const_pointer data() const noexcept — raw pointer to the const elements 😌
• constexpr pointer data() noexcept — raw pointer to the elements
• constexpr bool empty() const noexcept — is she empty? (spoiler: for _Nm == 0 yes, otherwise no)
• constexpr const_iterator end() const noexcept — end of the const parade
• constexpr iterator end() noexcept — end of the party
• constexpr void fill(const value_type &__u) — copy __u into every single slot, she's nothing if not thorough 💅
• constexpr const_reference front() const noexcept — first element, const
• constexpr reference front() noexcept — first element, mutable
• constexpr size_type max_size() const noexcept — biggest size she could be
• constexpr const_reference operator[](size_type __n) const noexcept — unchecked index, const. no vibe check, no bounds check, you're on your own fr fr
• constexpr reference operator[](size_type __n) noexcept — unchecked index, mutable
• constexpr const_reverse_iterator rbegin() const noexcept — reverse start, const
• constexpr reverse_iterator rbegin() noexcept — reverse start
• constexpr const_reverse_iterator rend() const noexcept — reverse end, const
• constexpr reverse_iterator rend() noexcept — reverse end
• constexpr size_type size() const noexcept — how many elements, periodt
• constexpr void swap(array &__other) noexcept(__array_traits< _Tp, _Nm >::_Is_nothrow_swappable::value) — swap contents with __other, and the noexcept-ness is conditional on __array_traits< _Tp, _Nm >::_Is_nothrow_swappable::value 😭 yes that's the actual signature

lowkey important: operator[] is noexcept and does not bounds-check. at() is the one that checks. don't mix them up bestie, i'm begging 🫶

⭐ Public Attributes

• _M_elems — of type __array_traits< _Tp, _Nm >::_Type, i.e. the actual elements sitting right there in the struct. she's not hiding them behind a heap allocation, she's transparent like that 💀

---

💜 Detailed Description 💜

template<typename _Tp, std::size_t _Nm>
struct std::array< _Tp, _Nm >

"A standard container for storing a fixed size sequence of elements.

Meets the requirements of a container, a reversible container, and a sequence. 👑

Sets support random access iterators. 🔥

🧚 Template Parameters

• _Tp_ — Type of element. Required to be a complete type. (yes, required. she's picky about her guests.)
• _Nm_ — Number of elements.

---

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code.

---

and that's the whole page bestie, no notes 🎀 so before you close the tab: this one's from libstdc++, the page is std::array< _Tp, _Nm >(3cxx), and the credit line up top is Doxygen doing its auto-generated thing from the source code. mwah 💖✨🦋