Namespaces
Variants
Views
Actions

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

From cppreference.com
< cpp‎ | ranges
 
 
Ranges library
Range access
Range conversions
(C++23)
Range primitives



Dangling iterator handling
Range concepts
Views

Factories




Adaptors
Range adaptor objects
Range adaptor closure objects
Helper items
 
 
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) RangeAdaptorObject. 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:

join_with_view models input_range.

join_with_view models forward_range when:

join_with_view models bidirectional_range when:

join_with_view models common_range when:

Contents

[edit] 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)).

[edit] Member functions

constructs a join_with_view
(public member function) [edit]
(C++23)
returns a copy of the underlying (adapted) view
(public member function) [edit]
(C++23)
returns an iterator to the beginning
(public member function) [edit]
(C++23)
returns an iterator or a sentinel to the end
(public member function) [edit]
Inherited from std::ranges::view_interface
(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>) [edit]
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>) [edit]
(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>) [edit]
(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>) [edit]

[edit] Deduction guides

[edit] Nested classes

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

[edit] Example

#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.

[edit] See also

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