std::ranges...:repeat_view(3)

πŸ“¦ version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

πŸŽ€ std::ranges...:repeat_view(3) πŸŽ€

okay bestie, welcome to the C++ Standard Libary manual page for std::ranges::views::repeat and std::ranges::repeat_view β€” yes, both, they're besties. this one is a range factory, and it's lowkey iconic. πŸ’…

✨ NAME ✨

std::ranges::views::repeat, std::ranges::repeat_view β€” std::ranges::views::repeat, std::ranges::repeat_view

🌸 Synopsis 🌸

Defined in header <ranges>.

template< std::move_constructible W,
          std::semiregular Bound = std::unreachable_sentinel_t >
    requires (std::is_object_v<W> &&
              std::same_as<W, std::remove_cv_t<W>> &&
              (/*is-integer-like*/<Bound> ||
               std::same_as<Bound, std::unreachable_sentinel_t>))
class repeat_view : public ranges::view_interface<repeat_view<W, Bound>>

(1) (since C++23)

namespace views {
    inline constexpr /*unspecified*/ repeat = /*unspecified*/;
}

(2) (since C++23)

πŸ“ž Call signature πŸ“ž

template< class W >
    requires /* see below */
constexpr /* see below */ repeat( W&& value );

(since C++23)

template< class W, class Bound >
    requires /* see below */
constexpr /* see below */ repeat( W&& value, Bound&& bound );

(since C++23)

  1. A range factory that generates a sequence of elements by repeatedly producing the same value. Can be either bounded or unbounded (infinite).
  2. views::repeat(e) and views::repeat(e, f) are expression-equivalent to (has the same effect as) repeat_view(e) and repeat_view(e, f) respectively for any suitable subexpressions e and f.

repeat_view models random_access_range. If Bound is not std::unreachable_sentinel_t, repeat_view also models sized_range and common_range.

πŸ‘‘ Member functions πŸ‘‘

  • constructor β€” creates a repeat_view (public member function)
  • begin β€” obtains the beginning iterator of a repeat_view (public member function)
  • end β€” obtains the sentinel denoting the end of a repeat_view (public member function)
  • size β€” obtains the size of a repeat_view if it is sized (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>)
  • cbegin (C++23) β€” returns a constant iterator to the beginning of the range. (public member function of std::ranges::view_interface<D>)
  • cend (C++23) β€” returns a sentinel for the constant iterator of the 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>)
  • operator[] (C++20) β€” returns the n^th element in the derived view. Provided if it satisfies random_access_range. (public member function of std::ranges::view_interface<D>)

🌟 std::ranges::repeat_view::repeat_view 🌟

repeat_view() requires std::default_initializable<W> = default;

(1) (since C++23)

constexpr explicit repeat_view( const W& value, Bound bound = Bound() );

(2) (since C++23)

constexpr explicit repeat_view( W&& value, Bound bound = Bound() );

(3) (since C++23)

template < class... WArgs, class... BoundArgs >
    requires std::constructible_from<W, WArgs...>
          && std::constructible_from<Bound, BoundArgs...>
constexpr explicit repeat( std::piecewise_construct_t,
                           std::tuple<WArgs...> value_args,
                           std::tuple<BoundArgs...> bound_args =
                               std::tuple<>{} );

(4) (since C++23)

  1. Value-initializes value_ and bound_ via their default member initializers (= W() and = Bound()).
  2. Initializes value_ with value and initializes bound_ with bound. The behavior is undefined if Bound is not std::unreachable_sentinel_t and bool(bound >= 0) is false.
  3. Initializes value_ with std::move(value) and initializes bound_ with bound. The behavior is undefined if Bound is not std::unreachable_sentinel_t and bool(bound >= 0) is false.
  4. Initializes value_ and bound_ through piecewise construction.

🎯 Parameters 🎯

  • value β€” the value to be repeatedly produced
  • bound β€” the bound

πŸš€ std::ranges::repeat_view::begin πŸš€

constexpr /*iterator*/ begin() const;

(since C++23)

Returns an iterator initialized with std::addressof(*value_).

πŸ›‘ std::ranges::repeat_view::end πŸ›‘

constexpr /*iterator*/ end() const
    requires (!std::same_as<Bound, std::unreachable_sentinel_t>);

(1) (since C++23)

constexpr std::unreachable_sentinel_t end() const;

(2) (since C++23)

  1. Returns an iterator initialized with std::addressof(*value_) and bound_.
  2. Returns an std::unreachable_sentinel.

πŸ“ std::ranges::repeat_view::size πŸ“

constexpr auto size() const
    requires (!std::same_as<Bound, std::unreachable_sentinel_t>);

(since C++23)

Returns the size of the view if the view is bounded. Equivalent to return /*to-unsigned-like*/(bound_);.

The exposition-only function template to-unsigned-like converts its argument (which must be integer-like) to the corresponding unsigned version of the argument type.

🧠 Deduction guides 🧠

template< class W, class Bound >
repeat_view( W, Bound ) -> repeat_view<W, Bound>;

(since C++23)

πŸͺ† Nested classes πŸͺ†

  • iterator (C++23) β€” the iterator type (exposition-only member class*)

πŸ“ Notes πŸ“

  • Feature-test macro __cpp_lib_ranges_repeat, value 202207L, Std (C++23), feature std::ranges::repeat_view.

πŸ’» Example πŸ’»

// Run this code

#include <iostream>
#include <ranges>
#include <string_view>
using namespace std::literals;

int main()
{
    // bounded overload
    for (auto s : std::views::repeat("C++"sv, 3))
        std::cout << s << ' ';
    std::cout << '\n';

    // unbounded overload
    for (auto s : std::views::repeat("I know that you know that"sv)
                | std::views::take(3))
        std::cout << s << ' ';
    std::cout << "...\n";
}

🌈 Output 🌈

C++ C++ C++
I know that you know that I know that you know that I know that you know that ...

πŸ‘€ See also πŸ‘€

  • ranges::iota_view (C++20) β€” a view consisting of a sequence generated by repeatedly incrementing an initial value; (class template)
  • views::iota (C++20) β€” a view consisting of a sequence generated by repeatedly incrementing an initial value; (customization point object)

okay that's the whole page, bestie! source: cppreference.com, version/date 2024.06.10, manual page std::ranges...:repeat_view(3). slay and happy ranging! πŸ’–βœ¨

πŸ“¦ where this page comes from