std::ranges...w::sentinel(3)

📦 version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

🎀 NAME 🎀

Okay so welcome to the std::ranges...w::sentinel(3) page from the C++ Standard Libary — yes, that's their spelling, not mine 💀. This page is literally about the adjacent_view sentinel, and the NAME entry is the same thing twice, iconic:

std::ranges::adjacent_view::sentinel — std::ranges::adjacent_view::sentinel

🦋 Synopsis 🦋

template< bool Const >  (exposition only*)
class /*sentinel*/;     (since C++23)

So bestie, this is the return type of adjacent_view::end when the underlying view is not a common_range. The type /*sentinel*/<true> is returned by the const-qualified overload, and the type /*sentinel*/<false> is returned by the non-const-qualified overload. Slay.

✨ Member types ✨

  • Member type: Base (private) — Definition: const V if Const is true, otherwise V. (exposition-only member type*)

🍓 Data members 🍓

  • Member object: end_ (private) — Definition: A sentinel obtained from (possibly const-qualified) V. (exposition-only member object*)

💅 Member functions 💅

  • constructor — constructs a sentinel (public member function).

🌈 Non-member functions 🌈

  • operator== — compares a sentinel with an iterator returned from adjacent_view::begin (C++23) (function).
  • operator- — computes the distance between a sentinel and an iterator returned from adjacent_view::begin (C++23) (function).

😭 Example 😭

  • This section is incomplete
  • Reason: no example

🔥 References 🔥

  • C++23 standard (ISO/IEC 14882:2023):
  • 26.7.25.4 Class template adjacent_view::sentinel [range.adjacent.sentinel]

🌸 See also 🌸

Category:

  • Todo no example

And that's the whole vibe! Source/version is http://cppreference.com, date 2024.06.10, page std::ranges...w::sentinel(3) — bye bestie, go slay some ranges 💖✨🫶

📦 where this page comes from