std::ranges::enumerate_view<V>::end

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Execution support library (C++26)

Technical specifications

Symbols index

External libraries

 

Ranges library

Range access begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata empty

Range conversions std::from_range_t std::from_range (C++23)(C++23)     to (C++23)

Dangling iterator handling dangling borrowed_iterator_t borrowed_subrange_t

Range primitives
range_size_trange_difference_trange_value_t elements_of (C++23)	iterator_tconst_iterator_tsentinel_tconst_sentinel_t (C++23)(C++23)	range_reference_trange_const_reference_trange_rvalue_reference_trange_common_reference_t (C++23)

Range concepts
range borrowed_range    sized_range	common_range view viewable_range	input_range output_range forward_range	bidirectional_range    random_access_range contiguous_range	constant_range (C++23)

Views
view_interface	subrange

Range factories
empty_viewviews::empty	single_viewviews::single	basic_istream_viewviews::istream	iota_viewviews::iota	repeat_viewviews::repeat (C++23)(C++23)

Range adaptors
views::all_tviews::all ref_view owning_view as_rvalue_viewviews::as_rvalue (C++23)(C++23)   filter_viewviews::filter transform_viewviews::transform take_viewviews::take take_while_viewviews::take_while concat_viewviews::concat (C++26)(C++26)	drop_viewviews::drop drop_while_viewviews::drop_while join_viewviews::join join_with_viewviews::join_with (C++23)(C++23)   lazy_split_viewviews::lazy_split split_viewviews::split views::counted common_viewviews::common	reverse_viewviews::reverse as_const_viewviews::as_const (C++23)(C++23) elements_viewviews::elements keys_viewviews::keys values_viewviews::values enumerate_viewviews::enumerate (C++23)(C++23) zip_viewviews::zip (C++23)(C++23) zip_transform_viewviews::zip_transform (C++23)(C++23)	adjacent_viewviews::adjacent (C++23)(C++23) views::pairwise (C++23) adjacent_transform_viewviews::adjacent_transform (C++23)(C++23) views::pairwise_transform (C++23) chunk_viewviews::chunk (C++23)(C++23) slide_viewviews::slide (C++23)(C++23) chunk_by_viewviews::chunk_by (C++23)(C++23) stride_viewviews::stride (C++23)(C++23) cartesian_product_viewviews::cartesian_product (C++23)(C++23)

Range generators std::generator (C++23)

Range adaptor closure objects range_adaptor_closure (C++23)

Range adaptor objects

Helper items
copyable-box movable-box (until C++23)  (C++23)	simple-view non-propagating-cache

 

std::ranges::enumerate_view

Member functions

enumerate_view::enumerate_view

enumerate_view::base

enumerate_view::begin

enumerate_view::end

enumerate_view::size

Deduction guides

Nested classes

Iterator

enumerate_view::iterator::iterator

enumerate_view::iterator::base

enumerate_view::iterator::index

enumerate_view::iterator::operator*

enumerate_view::iterator::operator[]

enumerate_view::iterator::operator++ enumerate_view::iterator::operator++(int) enumerate_view::iterator::operator-- enumerate_view::iterator::operator--(int) enumerate_view::iterator::operator+= enumerate_view::iterator::operator-=

operator==(enumerate_view::iterator) operator<=>(enumerate_view::iterator)

operator+(enumerate_view::iterator) operator-(enumerate_view::iterator)

iter_move(enumerate_view::iterator)

Sentinel

enumerate_view::sentinel::sentinel

enumerate_view::sentinel::base

operator==(enumerate_view::iterator,enumerate_view::sentinel)

operator-(enumerate_view::iterator,enumerate_view::sentinel)

 

constexpr auto end() requires (!__simple_view<V>);	(1)	(since C++23)
constexpr auto end() const requires /*range-with-movable-references*/<const V>;	(2)	(since C++23)

Returns an iterator or a sentinel that compares equal to the end iterator of the enumerate_view.

Let base_ denote the underlying view.

1) Equivalent to:

if constexpr (ranges::forward_range<V> and 
              ranges::common_range<V>  and 
              ranges::sized_range<V>)
    return /*iterator*/<false>(ranges::end(base_), ranges::distance(base_));
else
    return /*sentinel*/<false>(ranges::end(base_));

2) Equivalent to:

if constexpr (ranges::forward_range<const V> and 
              ranges::common_range<const V>  and 
              ranges::sized_range<const V>)
    return /*iterator*/<true>(ranges::end(base_), ranges::distance(base_));
else
    return /*sentinel*/<true>(ranges::end(base_));

Parameters

(none)

Return value

An iterator or a sentinel representing the end of the enumerate_view, as described above.

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR	Applied to	Behavior as published	Correct behavior
LWG 3919	C++23	ranges::distance may invoke UB for sized common non-forward underlying ranges	sentinel type is returned for such ranges

See also

begin	returns an iterator to the beginning (public member function)
ranges::end (C++20)	returns a sentinel indicating the end of a range (customization point object)