std::ranges::split_view<V,Pattern>::iterator

 

C++

Compiler support

Freestanding and hosted

Language

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_t range_value_t	range_reference_trange_const_reference_trange_rvalue_reference_t   (C++23)	iterator_tconst_iterator_tsentinel_t (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
Factories
empty_viewviews::empty iota_viewviews::iota	single_viewviews::single basic_istream_viewviews::istream	repeat_viewviews::repeat (C++23)(C++23)
Adaptors
ref_view views::all_tviews::all common_viewviews::common owning_view views::counted reverse_viewviews::reverse zip_viewviews::zip (C++23)(C++23) as_const_viewviews::as_const (C++23)(C++23) as_rvalue_viewviews::as_rvalue (C++23)(C++23)	take_viewviews::take take_while_viewviews::take_while drop_viewviews::drop drop_while_viewviews::drop_while zip_transform_viewviews::zip_transform (C++23)(C++23) adjacent_transform_viewviews::adjacent_transform (C++23)(C++23)   cartesian_product_viewviews::cartesian_product (C++23)(C++23)	elements_viewviews::elements keys_viewviews::keys values_viewviews::values transform_viewviews::transform adjacent_viewviews::adjacent (C++23)(C++23) slide_viewviews::slide (C++23)(C++23) stride_viewviews::stride (C++23)(C++23)	filter_viewviews::filter join_viewviews::join split_viewviews::split lazy_split_viewviews::lazy_split join_with_viewviews::join_with (C++23)(C++23) chunk_viewviews::chunk (C++23)(C++23) chunk_by_viewviews::chunk_by (C++23)(C++23)
Range adaptor objects
Range adaptor closure objects
Helper items
copyable-box	simple-view

 

std::ranges::split_view

Member functions

split_view::split_view (C++20)

split_view::base (C++20)

split_view::begin (C++20)

split_view::end (C++20)

Nested classes

split_view::iterator (C++20)

split_view::sentinel (C++20)

Deduction guides

 

class /*iterator*/; // exposition only		(since C++20)

The return type of split_view::begin. The name iterator is for exposition purposes only.

This is a forward_iterator, so it is expected that V models at least forward_range.

Member types

Member type	Definition
iterator_concept	std::forward_iterator_tag
iterator_category	std::input_iterator_tag
value_type	ranges::subrange<ranges::iterator_t<V>>
difference_type	ranges::range_difference_t<V>

Data members

Typical implementations of iterator hold four non-static data members:

• a pointer of type ranges::split_view<V, Pattern>* to the parent split_view object (shown here as parent_ for exposition only),
• an iterator of type ranges::iterator_t<V> (shown here as cur_ for exposition only) into the underlying view; cur_ points to the begin of a current subrange,
• a subrange of type ranges::subrange<ranges::iterator_t<V>> (shown here as next_ for exposition only) to the position of the pattern next to the current subrange, and
• a boolean flag (shown here as trailing_empty_ for exposition only) that indicates whether an empty trailing subrange (if any) was reached.

Member functions

(constructor) (C++20)	constructs an iterator (public member function)
base (C++20)	returns the underlying iterator (public member function)
operator* (C++20)	returns the current subrange (public member function)
operator++operator++(int) (C++20)	advances the iterator (public member function)

std::ranges::split_view::iterator::iterator

/*iterator*/() = default;	(1)	(since C++20)
constexpr /*iterator*/( split_view& parent, ranges::iterator_t<V> current,                         ranges::subrange<ranges::iterator_t<V>> next );	(2)	(since C++20)

1) Value-initializes non-static data members with their default member initializers, that is

• ranges::split_view* parent_ = nullptr;,
• ranges::iterator_t<V> cur_ = ranges::iterator_t<V>();,
• ranges::subrange<ranges::iterator_t<V>> next_ = ranges::subrange<ranges::iterator_t<V>>();, and
• bool trailing_empty_ = false;.

2) Initializes non-static data members:

• ranges::split_view* parent_ = std::addressof(parent);,
• ranges::iterator_t<V> cur_ = std​::​move(current);,
• ranges::subrange<ranges::iterator_t<V>> next_ = std​::​move(next);, and
• bool trailing_empty_ = false;.

std::ranges::split_view::iterator::base

constexpr const ranges::iterator_t<V> base() const;		(since C++20)

Equivalent to return cur_;.

std::ranges::split_view::iterator::operator*

constexpr ranges::range_reference_t<V> operator*() const;		(since C++20)

Equivalent to return {cur_, next_.begin()};.

std::ranges::split_view::iterator::operator++

constexpr /*iterator*/& operator++();	(1)	(since C++20)
constexpr void operator++( int );	(2)	(since C++20)

1) Equivalent to
cur_ = next_.begin();

if (cur_ != ranges::end(parent_->base_)) {
  cur_ = next_.end();
  if (cur_ == ranges::end(parent_->base_)) {
    trailing_empty_ = true;
    next_ = {cur_, cur_};
  } else {
    next_ = parent_->find_next(cur_);
  }
} else {
  trailing_empty_ = false;
}

return *this;.

2) Equivalent to auto tmp = *this; ++*this; return tmp;.

Non-member functions

operator== (C++20)

compares the underlying iterators (function)

operator==(std::ranges::split_view::iterator, std::ranges::split_view::iterator)

friend constexpr bool operator==( const /*iterator*/& x, const /*iterator*/& y );		(since C++20)

Equivalent to return x.cur_ == y.cur_ && x.trailing_empty_ == y.trailing_empty_;.

The != operator is synthesized from operator==.

This function is not visible to ordinary unqualified or qualified lookup, and can only be found by argument-dependent lookup when std::ranges::split_view::iterator is an associated class of the arguments.