The ranges library is an extension and generalization of the algorithms and iterator libraries that makes them more powerful by making them composable and less error-prone.
The library creates and manipulates range views, lightweight objects that indirectly represent iterable sequences (ranges). Ranges are an abstraction on top of.
ranges::sort) views::counted views::take_while views::iota The ranges library includes range algorithms, which are applied to ranges eagerly, and range adaptors, which are applied to views lazily. Adaptors can be composed into pipelines, so that their actions take place as the view is iterated.
Defined in header <ranges> | ||
|---|---|---|
namespace std {
namespace views = ranges::views;
}
| (since C++20) |
The namespace alias std::views is provided as a shorthand for std::ranges::views.
Defined in namespace std::ranges |
|
|---|---|
Range access |
|
Defined in header <ranges> |
|
Defined in header <iterator> |
|
|
(C++20) | returns an iterator to the beginning of a range (customization point object) |
|
(C++20) | returns a sentinel indicating the end of a range (customization point object) |
|
(C++20) | returns an iterator to the beginning of a read-only range (customization point object) |
|
(C++20) | returns a sentinel indicating the end of a read-only range (customization point object) |
|
(C++20) | returns a reverse iterator to a range (customization point object) |
|
(C++20) | returns a reverse end iterator to a range (customization point object) |
|
(C++20) | returns a reverse iterator to a read-only range (customization point object) |
|
(C++20) | returns a reverse end iterator to a read-only range (customization point object) |
|
(C++20) | returns an integer equal to the size of a range (customization point object) |
|
(C++20) | returns a signed integer equal to the size of a range (customization point object) |
|
(C++20) | checks whether a range is empty (customization point object) |
|
(C++20) | obtains a pointer to the beginning of a contiguous range (customization point object) |
|
(C++20) | obtains a pointer to the beginning of a read-only contiguous range (customization point object) |
Range primitives |
|
Defined in header <ranges> |
|
|
(C++20)(C++23)(C++20)(C++23)(C++20)(C++20)(C++20)(C++20)(C++23)(C++20)(C++20) | obtains associated types of a range (alias template) |
Dangling iterator handling |
|
Defined in header <ranges> |
|
|
(C++20) | a placeholder type indicating that an iterator or a subrange should not be returned since it would be dangling (class) |
|
(C++20) | obtains iterator type or subrange type of a borrowed_range (alias template) |
Range concepts |
|
Defined in header <ranges> |
|
|
(C++20) | specifies that a type is a range, that is, it provides a begin iterator and an end sentinel (concept) |
|
(C++20) | specifies that a type is a range and iterators obtained from an expression of it can be safely returned without danger of dangling (concept) |
|
(C++20) | specifies that a range knows its size in constant time (concept) |
|
(C++20) | specifies that a range is a view, that is, it has constant time copy/move/assignment (concept) |
|
(C++20) | specifies a range whose iterator type satisfies input_iterator (concept) |
|
(C++20) | specifies a range whose iterator type satisfies output_iterator (concept) |
|
(C++20) | specifies a range whose iterator type satisfies forward_iterator (concept) |
|
(C++20) | specifies a range whose iterator type satisfies bidirectional_iterator (concept) |
|
(C++20) | specifies a range whose iterator type satisfies random_access_iterator (concept) |
|
(C++20) | specifies a range whose iterator type satisfies contiguous_iterator (concept) |
|
(C++20) | specifies that a range has identical iterator and sentinel types (concept) |
|
(C++20) | specifies the requirements for a range to be safely convertible to a view (concept) |
|
(C++23) | specifies that a range has read-only elements (concept) |
Range conversions |
|
Defined in header <ranges> |
|
|
(C++23) | constructs a new non-view object from an input range (function template) |
Views |
|
Defined in header <ranges> |
|
|
(C++20) | helper class template for defining a view, using the curiously recurring template pattern (class template) |
|
(C++20) | combines an iterator-sentinel pair into a view (class template) |
Defined in header <ranges> |
|
|---|---|
Defined in namespace std::ranges |
|
|
(C++20) | an empty view with no elements (class template) (variable template) |
|
(C++20) | a view that contains a single element of a specified value (class template) (customization point object) |
|
(C++20) | a view consisting of a sequence generated by repeatedly incrementing an initial value (class template) (customization point object) |
|
(C++20) | a view consisting of the elements obtained by successive application of operator>> on the associated input stream (class template) (customization point object) |
|
(C++23) | a view consisting of a generated sequence by repeatedly producing the same value (class template) (customization point object) |
|
(C++23) | a view consisting of tuples of results calculated by the n-ary cartesian product of the adapted views (class template) (customization point object) |
Defined in header <ranges> |
|
|---|---|
Defined in namespace std::ranges |
|
|
(C++23) | helper base class template for defining a range adaptor closure object (class template) |
|
(C++20) | a view that includes all elements of a range (alias template) (range adaptor object) |
|
(C++20) | a view of the elements of some other range (class template) |
|
(C++20) | a view with unique ownership of some range (class template) |
|
(C++20) | a view that consists of the elements of a range that satisfies a predicate (class template) (range adaptor object) |
|
(C++20) | a view of a sequence that applies a transformation function to each element (class template) (range adaptor object) |
|
(C++20) | a view consisting of the first N elements of another view (class template) (range adaptor object) |
|
(C++20) | 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) |
|
(C++20) | a view consisting of elements of another view, skipping the first N elements (class template) (range adaptor object) |
|
(C++20) | a view consisting of the elements of another view, skipping the initial subsequence of elements until the first element where the predicate returns false (class template) (range adaptor object) |
|
(C++20) | a view consisting of the sequence obtained from flattening a view of ranges (class template) (range adaptor object) |
|
(C++20) | a view over the subranges obtained from splitting another view using a delimiter (class template) (range adaptor object) |
|
(C++20) | a view over the subranges obtained from splitting another view using a delimiter (class template) (range adaptor object) |
|
(C++20) | creates a subrange from an iterator and a count (customization point object) |
|
(C++20) | converts a view into a common_range (class template) (range adaptor object) |
|
(C++20) | a view that iterates over the elements of another bidirectional view in reverse order (class template) (range adaptor object) |
|
(C++20) | takes a view consisting of tuple-like values and a number N and produces a view of N'th element of each tuple (class template) (range adaptor object) |
|
(C++20) | takes a view consisting of pair-like values and produces a view of the first elements of each pair (class template) (range adaptor object) |
|
(C++20) | takes a view consisting of pair-like values and produces a view of the second elements of each pair (class template) (range adaptor object) |
|
(C++23) | a view that maps each element of adapted sequence to a tuple of both the element's position and its value (class template) (range adaptor object) |
|
(C++23) | a view consisting of tuples of references to corresponding elements of the adapted views (class template) (customization point object) |
|
(C++23) | a view consisting of tuples of results of application of a transformation function to corresponding elements of the adapted views (class template) (customization point object) |
|
(C++23) | a view consisting of tuples of references to adjacent elements of the adapted view (class template) (range adaptor object) |
|
(C++23) | a view consisting of tuples of results of application of a transformation function to adjacent elements of the adapted view (class template) (range adaptor object) |
|
(C++23) | a view consisting of the sequence obtained from flattening a view of ranges, with the delimiter in between elements (class template) (range adaptor object) |
|
(C++23) | a view whose Mth element is a view over the Mth through (M + N - 1)th elements of another view (class template) (range adaptor object) |
|
(C++23) | a range of views that are N-sized non-overlapping successive chunks of the elements of another view (class template) (range adaptor object) |
|
(C++23) | splits the view into subranges between each pair of adjacent elements for which the given predicate returns false (class template) (range adaptor object) |
|
(C++23) | converts a view into a constant_range (class template) (range adaptor object) |
|
(C++23) | a view of a sequence that casts each element to an rvalue (class template) (range adaptor object) |
|
(C++23) | a view consisting of elements of another view, advancing over N elements at a time (class template) (range adaptor object) |
Defined in header <generator> |
|
|---|---|
Defined in namespace std |
|
|
(C++23) | A view that represents synchronous coroutine generator (class template) |
See RangeAdaptorObject (RAO).
See RangeAdaptorClosureObject (RACO).
See Customization point object (CPO).
Some range adaptors wrap their elements or function objects with the copyable-box (until C++23)movable-box (since C++23). The wrapper auguments the wrapped object with assignability when needed.
Some range adaptors are specified in terms of an exposition-only class template non-propagating-cache, which behaves almost exactly like std::optional<T> (see description for differences).
template< class F, class Tuple >
constexpr auto /*tuple-transform*/( F&& f, Tuple&& tuple ) { // exposition only
return std::apply([&]<class... Ts>(Ts&&... elements) {
return std::tuple<std::invoke_result_t<F&, Ts>...>(
std::invoke(f, std::forward<Ts>(elements))...
);
}, std::forward<Tuple>(tuple));
}
| (1) | |
template< class F, class Tuple >
constexpr void /*tuple-for-each*/( F&& f, Tuple&& tuple ) { // exposition only
std::apply([&]<class... Ts>(Ts&&... elements) {
(static_cast<void>(std::invoke(f, std::forward<Ts>(elements))), ...);
}, std::forward<Tuple>(tuple));
}
| (2) | |
template< class T >
constexpr T& /*as-lvalue*/( T&& t ) { // exposition only
return static_cast<T&>(t);
}
| (3) |
Some range adaptors are specified in terms of these exposition-only function templates.
/*tuple-transform*/ returns a new tuple constructed by applying f to each element of tuple./*tuple-for-each*/ applies f to each element of tuple and returns nothing./*as-lvalue*/ forwards rvalue t as lvalue.Following exposition-only concepts are used for several types, but they are not parts of the interface of standard library.
template< class R >
concept /*simple-view*/ = // exposition only
ranges::view<R> && ranges::range<const R> &&
std::same_as<ranges::iterator_t<R>, ranges::iterator_t<const R>> &&
std::same_as<ranges::sentinel_t<R>, ranges::sentinel_t<const R>>;
| (1) | |
template< class I >
concept /*has-arrow*/ = // exposition only
ranges::input_iterator<I> &&
(std::is_pointer_v<I> || requires(I i) { i.operator->(); });
| (2) | |
template< class T, class U >
concept /*different-from*/ = // exposition only
!std::same_as<std::remove_cvref_t<T>, std::remove_cvref_t<U>>;
| (3) | |
template< class R >
concept /*range-with-movable-references*/ = // exposition only
ranges::input_range<R> &&
std::move_constructible<ranges::range_reference_t<R>> &&
std::move_constructible<ranges::range_rvalue_reference_t<R>>;
| (4) |
| Feature-test macro | Value | Std | Comment |
|---|---|---|---|
__cpp_lib_generator | 202207L | (C++23) |
std::generator – synchronous coroutine generator for ranges |
__cpp_lib_ranges | 201911L | (C++20) | Ranges library and constrained algorithms |
| 202106L |
(C++20) (DR) | Non-default-initializable views | |
| 202110L |
(C++20) (DR) | Views with ownership | |
| 202202L | (C++23) |
std::ranges::range_adaptor_closure |
|
| 202207L | (C++23) | Relaxing range adaptors to allow for move-only types | |
| 202211L | (C++23) | Removing "poison pills" (P2602) overloads in ranges::begin etc |
|
__cpp_lib_ranges_as_const | 202207L | (C++23) |
std::const_iterator, std::ranges::as_const_view |
__cpp_lib_ranges_as_rvalue | 202207L | (C++23) |
std::ranges::as_rvalue_view |
__cpp_lib_ranges_cartesian_product | 202207L | (C++23) |
std::ranges::cartesian_product_view |
__cpp_lib_ranges_chunk | 202202L | (C++23) |
std::ranges::chunk_view |
__cpp_lib_ranges_chunk_by | 202202L | (C++23) |
std::ranges::chunk_by_view |
__cpp_lib_ranges_enumerate | 202302L | (C++23) |
std::ranges::enumerate_view |
__cpp_lib_ranges_join_with | 202202L | (C++23) |
std::ranges::join_with_view |
__cpp_lib_ranges_repeat | 202207L | (C++23) |
std::ranges::repeat_view |
__cpp_lib_ranges_slide | 202202L | (C++23) |
std::ranges::slide_view |
__cpp_lib_ranges_stride | 202207L | (C++23) |
std::ranges::stride_view |
__cpp_lib_ranges_to_container | 202202L | (C++23) |
std::ranges::to |
__cpp_lib_ranges_zip | 202110L | (C++23) |
std::ranges::zip_view,std::ranges::zip_transform_view,std::ranges::adjacent_view,std::ranges::adjacent_transform_view |
#include <iostream>
#include <ranges>
int main()
{
auto const ints = {0, 1, 2, 3, 4, 5};
auto even = [](int i) { return 0 == i % 2; };
auto square = [](int i) { return i * i; };
// the "pipe" syntax of composing the views:
for (int i : ints | std::views::filter(even) | std::views::transform(square))
std::cout << i << ' ';
std::cout << '\n';
// a traditional "functional" composing syntax:
for (int i : std::views::transform(std::views::filter(ints, even), square))
std::cout << i << ' ';
}Output:
0 4 16 0 4 16
The following behavior-changing defect reports were applied retroactively to previously published C++ standards.
| DR | Applied to | Behavior as published | Correct behavior |
|---|---|---|---|
| LWG 3509 | C++20 | it was unclear how range adaptor objects bound trailing arguments | they are bound by value |
© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/ranges