std::ranges::view_interface
From cppreference.com
C++
Feature test macros (C++20)
Concepts library (C++20)
Metaprogramming library (C++11)
Ranges library (C++20)
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Ranges library
(C++23)(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++26)(C++26)
(C++23)(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++23)
(C++23)(C++23)
(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++23)
std::ranges::view_interface
Defined in header
<ranges>
template< class D >
(since C++20)
requires std::is_class_v <D> && std::same_as <D, std::remove_cv_t <D>>
std::ranges::view_interface is a helper class template for defining a view interface.
view_interface is typically used with CRTP:
class my_view : public std::ranges::view_interface<my_view> { public: auto begin() const { /*...*/ } auto end() const { /*...*/ } // empty() is provided if begin() returns a forward iterator // and end() returns a sentinel for it. };
[edit] Member functions
returns whether the derived view is empty, provided only if it satisfies
(public member function) [edit]
sized_range or forward_range (public member function) [edit]
returns whether the derived view is not empty, provided only if ranges::empty is applicable to it
(public member function) [edit]
(public member function) [edit]
gets the address of derived view's data, provided only if its iterator type satisfies
(public member function) [edit]
contiguous_iterator (public member function) [edit]
returns the number of elements in the derived view. Provided if it satisfies
(public member function) [edit]
forward_range and its sentinel and iterator type satisfy sized_sentinel_for. (public member function) [edit]
returns the first element in the derived view, provided if it satisfies
(public member function) [edit]
forward_range (public member function) [edit]
returns the last element in the derived view, provided only if it satisfies
(public member function) [edit]
bidirectional_range and common_range (public member function) [edit]
returns the
(public member function) [edit]
nth element in the derived view, provided only if it satisfies random_access_range (public member function) [edit]
[edit] Example
Run this code
#include <iostream> #include <ranges> #include <vector> template<class T, class A> class VectorView : public std::ranges::view_interface<VectorView<T, A>> { public: VectorView() = default; VectorView(const std::vector <T, A>& vec) : m_begin(vec.cbegin()), m_end(vec.cend()) {} auto begin() const { return m_begin; } auto end() const { return m_end; } private: typename std::vector <T, A>::const_iterator m_begin{}, m_end{}; }; int main() { std::vector <int> v = {1, 4, 9, 16}; VectorView view_over_v{v}; // We can iterate with begin() and end(). for (int n : view_over_v) std::cout << n << ' '; std::cout << '\n'; // We get operator[] for free when inheriting from view_interface // since we satisfy the random_access_range concept. for (std::ptrdiff_t i = 0; i != view_over_v.size(); ++i) std::cout << "v[" << i << "] = " << view_over_v[i] << '\n'; }
Output:
1 4 9 16 v[0] = 1 v[1] = 4 v[2] = 9 v[3] = 16
[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 3549 | C++20 | view_interface was required to be derived from view_base,which sometimes required multiple view_base subobjects in a view
|
inheritance removed |