std::ranges::views::join_with, std::ranges::join_with_view

 

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::join_with_view

Member functions

join_with_view::join_with_view (C++23)

join_with_view::base (C++23)

join_with_view::begin (C++23)

join_with_view::end (C++23)

Deduction guides

Iterator

join_with_view::iterator::iterator (C++23)

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

join_with_view::iterator::operator++ join_with_view::iterator::operator++(int) join_with_view::iterator::operator-- join_with_view::iterator::operator--(int) (C++23)(C++23)(C++23)(C++23)

operator==(join_with_view::iterator) (C++23)

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

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

Sentinel

join_with_view::sentinel::sentinel (C++23)

operator==(join_with_view::sentinel) (C++23)

 

Defined in header <ranges>
template< ranges::input_range V, ranges::forward_range Pattern >   requires ranges::view<V> && ranges::input_range<ranges::range_reference_t<V>> &&            ranges::view<Pattern> &&            /* range_reference_t<V> and Pattern have compatible elements (see below) */ class join_with_view : ranges::view_interface<join_with_view<V, Pattern>>	(1)	(since C++23)
namespace views {     inline constexpr /*unspecified*/ join_with = /*unspecified*/; }	(2)	(since C++23)
Call signature
template< ranges::viewable_range R, class Pattern >     requires /* see below */ constexpr ranges::view auto join_with( R&& r, Pattern&& pattern );		(since C++23)
template< class Pattern > constexpr /* range adaptor closure */ join_with( Pattern&& pattern );		(since C++23)

1) A range adaptor that represents view consisting of the sequence obtained from flattening a view of ranges, with every element of the delimiter inserted in between elements of the view. The delimiter can be a single element or a view of elements.

2) Range adaptor object. The expression views::join_with(e, f) is expression-equivalent to join_with_view(e, f) for any suitable subexpressions e and f.

ranges::range_reference_t<V> and Pattern have compatible elements if, let Inner denote ranges::range_reference_t<V>, all of the following concepts are modeled:

• std::common_with<range_value_t<Inner>, range_value_t<Pattern>>
• std::common_reference_with<range_reference_t<Inner>, range_reference_t<Pattern>>
• std::common_reference_with<range_rvalue_reference_t<Inner>, range_rvalue_reference_t<Pattern>>

join_with_view models input_range.

join_with_view models forward_range when:

• ranges::range_reference_t<V> is a reference, and
• V and ranges::range_reference_t<V> each model forward_range.

join_with_view models bidirectional_range when:

• ranges::range_reference_t<V> is a reference,
• V, ranges::range_reference_t<V>, and Pattern each models bidirectional_range, and
• ranges::range_reference_t<V> and Pattern each model common_range.

join_with_view models common_range when:

• ranges::range_reference_t<V> is a reference,
• V and ranges::range_reference_t<V> each model forward_range and common_range.

Expression-equivalent

Expression e is expression-equivalent to expression f, if

• e and f have the same effects, and
• either both are constant subexpressions or else neither is a constant subexpression, and
• either both are potentially-throwing or else neither is potentially-throwing (i.e. noexcept(e) == noexcept(f)).

Member functions

(constructor) (C++23)	constructs a join_with_view (public member function)
base (C++23)	returns a copy of the underlying (adapted) view (public member function)
begin (C++23)	returns an iterator to the beginning (public member function)
end (C++23)	returns an iterator or a sentinel to the end (public member function)
Inherited from std::ranges::view_interface
empty (C++20)	Returns whether the derived view is empty. Provided if it satisfies sized_range or forward_range. (public member function of std::ranges::view_interface<D>)
operator bool (C++20)	Returns whether the derived view is not empty. Provided if ranges::empty is applicable to it. (public member function of std::ranges::view_interface<D>)
front (C++20)	Returns the first element in the derived view. Provided if it satisfies forward_range. (public member function of std::ranges::view_interface<D>)
back (C++20)	Returns the last element in the derived view. Provided if it satisfies bidirectional_range and common_range. (public member function of std::ranges::view_interface<D>)

Nested classes

iterator (C++23)	the iterator type (exposition-only member class template)
sentinel (C++23)	the sentinel type (exposition-only member class template)

Example

Run this code

#include <iostream>
#include <ranges>
#include <vector>
#include <string_view>
 
int main() {
    using namespace std::literals;
 
    std::vector v{"This"sv, "is"sv, "a"sv, "test."sv};
    auto joined = v | std::views::join_with(' ');
 
    for (auto c : joined) std::cout << c;
    std::cout << '\n';
}

Output:

This is a test.

See also

ranges::join_viewviews::join (C++20)

a view consisting of the sequence obtained from flattening a view of ranges (class template) (range adaptor object)