Difference between revisions of "cpp/ranges/iota view"
(→Defect reports: LWG 3610) |
m (→Example: + ranges::for_each with views::iota) |
||
Line 164: | Line 164: | ||
#include <ranges> | #include <ranges> | ||
#include <iostream> | #include <iostream> | ||
+ | #include <algorithm> | ||
int main() | int main() | ||
Line 177: | Line 178: | ||
for (int i : std::views::iota(1) {{!}} std::views::take(9)) | for (int i : std::views::iota(1) {{!}} std::views::take(9)) | ||
std::cout << i << ' '; | std::cout << i << ' '; | ||
+ | std::cout << '\n'; | ||
+ | |||
+ | std::ranges::for_each(std::views::iota(1, 10), [](int i) { | ||
+ | std::cout << i << ' '; | ||
+ | }); | ||
std::cout << '\n'; | std::cout << '\n'; | ||
} | } | ||
|output= | |output= | ||
+ | 1 2 3 4 5 6 7 8 9 | ||
1 2 3 4 5 6 7 8 9 | 1 2 3 4 5 6 7 8 9 | ||
1 2 3 4 5 6 7 8 9 | 1 2 3 4 5 6 7 8 9 |
Revision as of 15:25, 8 February 2022
Defined in header <ranges>
|
||
template< std::weakly_incrementable W, std::semiregular Bound = std::unreachable_sentinel_t > |
(1) | (since C++20) |
namespace views { inline constexpr /*unspecified*/ iota = /*unspecified*/; |
(2) | (since C++20) |
Call signature |
||
template< class W > requires /* see below */ |
(since C++20) | |
template< class W, class Bound > requires /* see below */ |
(since C++20) | |
Contents |
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)).
Customization point objects
The name views::iota
denotes a customization point object, which is a const function object of a literal semiregular
class type. For exposition purposes, the cv-unqualified version of its type is denoted as __iota_fn
.
All instances of __iota_fn
are equal. The effects of invoking different instances of type __iota_fn
on the same arguments are equivalent, regardless of whether the expression denoting the instance is an lvalue or rvalue, and is const-qualified or not (however, a volatile-qualified instance is not required to be invocable). Thus, views::iota
can be copied freely and its copies can be used interchangeably.
Given a set of types Args...
, if std::declval<Args>()... meet the requirements for arguments to views::iota
above, __iota_fn
models
- std::invocable<__iota_fn, Args...>,
- std::invocable<const __iota_fn, Args...>,
- std::invocable<__iota_fn&, Args...>, and
- std::invocable<const __iota_fn&, Args...>.
Otherwise, no function call operator of __iota_fn
participates in overload resolution.
Data members
Typical implementation of iota_view
holds two non-static data members: the beginning value value_
of type W
and the sentinel value bound_
of type Bound
. The names shown here are exposition-only.
Member functions
(constructor) (C++20) |
creates a iota_view (public member function) |
begin (C++20) |
obtains the beginning iterator of an iota_view (public member function) |
end (C++20) |
obtains the sentinel denoting the end of an iota_view (public member function) |
size (C++20) |
obtains the size of an iota_view if it is sized (public member function) |
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> )
| |
(C++23) |
returns a constant iterator to the beginning of the range. (public member function of std::ranges::view_interface<D> )
|
(C++23) |
returns a sentinel for the constant iterator of the range. (public member function of std::ranges::view_interface<D> )
|
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> )
| |
returns the first element in the derived view. Provided if it satisfies forward_range . (public member function of std::ranges::view_interface<D> )
| |
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> )
| |
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::iota_view::iota_view
iota_view() requires std::default_initializable<W> = default; |
(1) | (since C++20) |
constexpr explicit iota_view( W value ); |
(2) | (since C++20) |
constexpr iota_view( std::type_identity_t<W> value, std::type_identity_t<Bound> bound ); |
(3) | (since C++20) |
constexpr iota_view( /*iterator*/ first, /*see below*/ last ); |
(4) | (since C++20) |
value_
and bound_
via their default member initializers (= W() and = Bound()).value_
with value and value-initializes bound_
. This constructor is used to create unbounded iota_view
s, e.g. iota(0) yields numbers 0,1,2..., infinitely.value_
with value and bound_
with bound. The behavior is undefined if std::totally_ordered_with<W, Bound> is modeled and bool(value <= bound) is false. This constructor is used to create bounded iota views, e.g. iota(10, 20) yields numbers from 10 to 19.value_
is initialized with the W
value stored in first
, and
- if
W
andBound
are the same type, then the type oflast
is /*iterator*/ andbound_
initialized with theW
value stored inlast
, - otherwise, if the
iota_view
is unbounded (i.e.Bound
is std::unreachable_sentinel_t), then the type oflast
is std::unreachable_sentinel_t andbound_
initialized with std::unreachable_sentinel. - otherwise, the type of
last
is /*sentinel*/ andbound_
initialized with theBound
value stored inlast
.
last
is same as decltype(end()).For (2), (3), and (4), the behavior is undefined if the iota_view
is bounded (i.e. Bound
is not std::unreachable_sentinel_t) and bound_
is initialized to a value unreachable from value_
.
Parameters
value | - | the starting value |
bound | - | the bound |
first | - | the iterator denoting the starting value |
last | - | the iterator or sentinel denoting the bound |
std::ranges::iota_view::begin
constexpr /*iterator*/ begin() const; |
(since C++20) | |
Returns an iterator initialized with value_.
std::ranges::iota_view::end
constexpr auto end() const; |
(1) | (since C++20) |
constexpr /*iterator*/ end() const requires std::same_as<W, Bound>; |
(2) | (since C++20) |
std::ranges::iota_view::size
constexpr auto size() const requires (std::same_as<W, Bound> && /*advanceable*/<W>) || |
(since C++20) | |
Returns the size of the view if the view is bounded.
The exposition-only concept advanceable
is described in this page.
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> requires (!/*is-integer-like*/<W> || !/*is-integer-like*/<Bound> || |
(since C++20) | |
For any type T
, /*is-integer-like*/<T> is true if and only if T
is integer-like, and /*is-signed-integer-like*/<T> is true if and only if T
is integer-like and capable of representing negative values.
Note that the guide protects itself against signed/unsigned mismatch bugs, like views::iota(0, v.size()), where 0 is a (signed) int and v.size() is an (unsigned) std::size_t.
Nested classes
(C++20) |
the iterator type (exposition-only member class*) |
(C++20) |
the sentinel type used when the iota_view is bounded and Bound and W are not the same type(exposition-only member class*) |
Helper templates
template<std::weakly_incrementable W, std::semiregular Bound> inline constexpr bool enable_borrowed_range<ranges::iota_view<W, Bound>> = true; |
(since C++20) | |
This specialization of std::ranges::enable_borrowed_range makes iota_view
satisfy borrowed_range
.
Example
#include <ranges> #include <iostream> #include <algorithm> int main() { for (int i : std::ranges::iota_view{1, 10}) std::cout << i << ' '; std::cout << '\n'; for (int i : std::views::iota(1, 10)) std::cout << i << ' '; std::cout << '\n'; for (int i : std::views::iota(1) | std::views::take(9)) std::cout << i << ' '; std::cout << '\n'; std::ranges::for_each(std::views::iota(1, 10), [](int i) { std::cout << i << ' '; }); std::cout << '\n'; }
Output:
1 2 3 4 5 6 7 8 9 1 2 3 4 5 6 7 8 9 1 2 3 4 5 6 7 8 9 1 2 3 4 5 6 7 8 9
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 3523 | C++20 | iterator-sentinel pair constructor might use wrong sentinel type | corrected |
P2325R3 | C++20 | iota_view required that W is semiregular as view required default_initializable
|
only requires that W is copyable
|
LWG 3610 | C++20 | size might reject integer-class types
|
made accepting if possible |
See also
(C++11) |
fills a range with successive increments of the starting value (function template) |