std::array:...ay::crbegin(3)

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

πŸ’– NAME πŸ’–

okay so this page is from the C++ Standard Libary manual β€” yes, β€œLibary,” we are respecting the source, bestie πŸ’… β€” and the page title is std::array:...ay::crbegin(3). The name entry is literally:

std::array::rbegin,std::array::crbegin - std::array::rbegin,std::array::crbegin

✨ Synopsis ✨

reverse_iterator rbegin() noexcept;              (1) (since C++11)
                                                       (constexpr since C++17)

const_reverse_iterator rbegin() const noexcept;  (2) (since C++11)
                                                       (constexpr since C++17)

const_reverse_iterator crbegin() const noexcept; (3) (since C++11)
                                                       (constexpr since C++17)

Returns a reverse iterator to the first element of the reversed array. It corresponds to the last element of the non-reversed array. If the array is empty, the returned iterator is equal to rend().

Also, the original page drops in a diagram called range-rbegin-rend.svg right here β€” iconic little visual, no cap πŸ¦‹.


πŸŽ€ Parameters πŸŽ€

(none) β€” no parameters. Zero. Nada. Not even one, bestie 🫢.


πŸ’… Return value πŸ’…

Reverse iterator to the first element.


πŸ”₯ Complexity πŸ”₯

Constant.


πŸ‘‘ Notes πŸ‘‘

The underlying iterator of the returned reverse iterator is the end iterator. Hence the returned iterator is invalidated if and when the end iterator is invalidated.

lowkey important caveat, bestie: that invalidation detail is not a vibe, it’s a fact πŸ’€

🌈 Example 🌈

// Run this code

#include <algorithm>
#include <array>
#include <iostream>
#include <string>
#include <string_view>

int main()
{
    constexpr std::array<std::string_view, 8> data = {"▁","β–‚","β–ƒ","β–„","β–…","β–†","β–‡","β–ˆ"};

    std::array<std::string, std::size(data)> arr;

    std::copy(data.cbegin(), data.cend(), arr.begin());
    //             ^              ^           ^

    auto print = [](const std::string_view s) { std::cout << s << ' '; };

    print("Print 'arr' in direct order using [cbegin, cend):\t");
    std::for_each(arr.cbegin(), arr.cend(), print);
    //                ^             ^
    print("\n\nPrint 'arr' in reverse order using [crbegin, crend):\t");
    std::for_each(arr.crbegin(), arr.crend(), print);
    //                ^^             ^^
    print("\n");
}

🌸 Output 🌸

Print 'arr' in direct order using [cbegin, cend):        ▁ β–‚ β–ƒ β–„ β–… β–† β–‡ β–ˆ

Print 'arr' in reverse order using [crbegin, crend):     β–ˆ β–‡ β–† β–… β–„ β–ƒ β–‚ ▁

πŸ¦‹ See also πŸ¦‹

  • rend β€” returns a reverse iterator to the end
  • crend β€” (public member function)
  • rbegin β€” returns a reverse iterator to the beginning of a container or array
  • crbegin β€” (function template)
  • (C++14)

okay bye bestie! πŸ’– source/version: http://cppreference.com Β· date: 2024.06.10 Β· page: std::array:...ay::crbegin(3) ✨

πŸ“¦ where this page comes from