std::default_sentinel_t(3cxx)

std::default_sentinel_t3cxx

Usage

#include <iterator>

Detailed Description

A sentinel type that can be used to check for the end of a range.

For some iterator types the past-the-end sentinel value is independent of the underlying sequence, and a default sentinel can be used with them. For example, a std::counted_iterator keeps a count of how many elements remain, and so checking for the past-the-end value only requires checking if that count has reached zero. A past-the-end std::istream_iterator is equal to the default-constructed value, which can be easily checked.

Comparing iterators of these types to std::default_sentinel is a convenient way to check if the end has been reached.

Since

C++20

Author

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

From libstdc++-12-doc 12.4.0-5 in Debian 13 (Trixie). Also shipped by libstdc++-13-doc, libstdc++-14-doc. Parsed by carta from the page's man source.