std::ranges::views::take, std::ranges::take_view

< cpp‎ | ranges
Ranges library
Range access
Range conversions
Range primitives

Dangling iterator handling
Range concepts


Range generators
Range adaptor objects
Range adaptor closure objects
Helper items
Defined in header <ranges>
template< ranges::view V >
class take_view : public ranges::view_interface<take_view<V>>
(1) (since C++20)
namespace views {

    inline constexpr /*unspecified*/ take = /*unspecified*/;

(2) (since C++20)
Call signature
template< ranges::viewable_range R, class DifferenceType >

    requires /* see below */

constexpr ranges::view auto take( R&& r, DifferenceType&& count );
(since C++20)
template< class DifferenceType >
constexpr /*range adaptor closure*/ take( DifferenceType&& count );
(since C++20)
1) A range adaptor that represents view of the elements from an underlying sequence, starting at the beginning and ending at a given bound.
2) views::take is a RangeAdaptorObject. The expression views::take(e, f) results in a view that represents the first f elements from e. The result is not necessarily a take_view.

It is expression-equivalent to (where T is std::remove_cvref_t<decltype((e))> and D is ranges::range_difference_t<decltype((e))>):

  • otherwise, if T is a specialization of ranges::repeat_view:
  • views::repeat(*e.value_, std::min<D>(ranges::distance(e), f)), if T models sized_range; is such case e is evaluated only once;
  • views::repeat(*e.value_, static_cast<D>(e)) otherwise;
(since C++23)
  • otherwise, take_view(e, f).
In all cases, decltype((f)) must model std::convertible_to<D>.

take_view models the concepts contiguous_range, random_access_range, bidirectional_range, forward_range, input_range, and sized_range when the underlying view V models respective concepts. It models common_range when the underlying view V models both random_access_range and sized_range.


[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 take_view
(public member function) [edit]
returns a copy of the underlying (adapted) view
(public member function) [edit]
returns an iterator to the beginning
(public member function) [edit]
returns an iterator or a sentinel to the end
(public member function) [edit]
returns the number of elements. Provided only if the underlying (adapted) range satisfies sized_range.
(public member function) [edit]
Inherited from std::ranges::view_interface
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]
Gets the address of derived view's data. Provided if its iterator type satisfies contiguous_iterator.
(public member function of std::ranges::view_interface<D>) [edit]
Returns the first element in the derived view. Provided if it satisfies forward_range.
(public member function of std::ranges::view_interface<D>) [edit]
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]
Returns the nth element in the derived view. Provided if it satisfies random_access_range.
(public member function of std::ranges::view_interface<D>) [edit]

[edit] Deduction guides

[edit] Nested classes

the sentinel type
(exposition-only member class template)

[edit] Helper templates

template<class T>

inline constexpr bool enable_borrowed_range<std::ranges::take_view<T>> =

(since C++20)

This specialization of std::ranges::enable_borrowed_range makes take_view satisfy borrowed_range when the underlying view satisfies it.

[edit] Example

#include <algorithm>
#include <iostream>
#include <ranges>
auto print = [](char x) { std::cout << x; };
int main()
    constexpr char pi[] { '3', '.', '1', '4', '1', '5', '9', '2' };
    std::ranges::for_each(pi | std::ranges::views::take(6), print);
    std::cout << '\n';
    std::ranges::for_each(std::ranges::take_view{pi, 42}, print);
        // safely takes 8 chars only, i.e. min(pi.size(), 42)
    std::cout << '\n';



[edit] Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR Applied to Behavior as published Correct behavior
LWG 3494 C++20 take_view was never a borrowed_range it is a borrowed_range if its underlying view is
LWG 3407 C++20 views::take sometimes fails to construct
a sized random access range
the result type is adjusted so that construction is always valid

[edit] See also

creates a subrange from an iterator and a count
(customization point object) [edit]
a view consisting of the initial elements of another view, until the first element on which a predicate returns false
(class template) (range adaptor object) [edit]
copies a number of elements to a new location
(niebloid) [edit]