std::ranges::adjacent_view<V,N>::begin

 

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)

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
to (C++23)
Range primitives
range_size_trange_difference_trange_value_trange_reference_t	iterator_tconst_iterator_tsentinel_tconst_sentinel_t (C++23)(C++23)	range_const_reference_trange_rvalue_reference_trange_common_reference_t (C++23)	elements_of (C++23)
Dangling iterator handling
dangling	borrowed_iterator_t	borrowed_subrange_t
Range concepts
range borrowed_range sized_range constant_range (C++23)	common_range view viewable_range	input_range output_range forward_range	bidirectional_range random_access_range contiguous_range
Views
view_interface	subrange
Range factories
empty_viewviews::empty single_viewviews::single	iota_viewviews::iota repeat_viewviews::repeat (C++23)(C++23)	basic_istream_viewviews::istream
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	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 objects
Range adaptor closure objects
range_adaptor_closure (C++23)
Helper items
copyable-box movable-box (until C++23)(C++23)	simple-view non-propagating-cache

 

std::ranges::adjacent_view

Member functions

adjacent_view::adjacent_view (C++23)

adjacent_view::begin (C++23)

adjacent_view::end (C++23)

adjacent_view::size (C++23)

Iterator

Member functions

adjacent_view::iterator::iterator (C++23)

adjacent_view::iterator::operator* (C++23)

adjacent_view::iterator::operator[] (C++23)

adjacent_view::iterator::operator++ adjacent_view::iterator::operator++(int) adjacent_view::iterator::operator-- adjacent_view::iterator::operator--(int) adjacent_view::iterator::operator+= adjacent_view::iterator::operator-= (C++23)(C++23)(C++23)(C++23)(C++23)(C++23)

Non-member functions

operator==(adjacent_view::iterator) operator<(adjacent_view::iterator) operator>(adjacent_view::iterator) operator<=(adjacent_view::iterator) operator>=(adjacent_view::iterator) operator<=>(adjacent_view::iterator) (C++23)(C++23)(C++23)(C++23)(C++23)(C++23)

operator+(adjacent_view::iterator) operator-(adjacent_view::iterator) (C++23)(C++23)

iter_move(adjacent_view::iterator) (C++23)

iter_swap(adjacent_view::iterator) (C++23)

Sentinel

Member functions

adjacent_view::sentinel::sentinel (C++23)

Non-member functions

operator==(adjacent_view::iterator,adjacent_view::sentinel) (C++23)

operator-(adjacent_view::iterator,adjacent_view::sentinel) (C++23)

 

constexpr auto begin() requires (!__SimpleView<V>);	(1)	(since C++23)
constexpr auto begin() const requires ranges::range<const V>;	(2)	(since C++23)

Returns an iterator to the first element of the adjacent_view.

Let base_ be the underlying view.

1) Equivalent to return /*iterator*/<false>(ranges::begin(base_), ranges::end(base_));.

2) Equivalent to return /*iterator*/<true>(ranges::begin(base_), ranges::end(base_));.

Parameters

(none)

Return value

Iterator to the first element.

Example

A link to test: Compiler Explorer/g++-13

Run this code

#include <tuple>
#include <ranges>
#include <type_traits>
 
int main()
{
    constexpr static auto v = {'A', 'B', 'C', 'D', 'E'};
 
    constexpr auto view = std::views::adjacent<3>(v);
 
    constexpr auto tuple = *view.begin();
 
    static_assert(
        std::is_same_v<
            decltype(tuple),
            const std::tuple<char const&, char const&, char const&>
    >);
 
    static_assert(
        std::get<0>(tuple) == 'A' and
        std::get<1>(tuple) == 'B' and
        std::get<2>(tuple) == 'C'
    );
}

See also

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