std::ranges::advance
来自 cppreference.cn
定义于头文件 <iterator> |
||
调用签名 |
||
template< std::input_or_output_iterator I > constexpr void advance( I& i, std::iter_difference_t<I> n ); |
(1) | (自 C++20 起) |
template< std::input_or_output_iterator I, std::sentinel_for<I> S > constexpr void advance( I& i, S bound ); |
(2) | (自 C++20 起) |
template< std::input_or_output_iterator I, std::sentinel_for<I> S > constexpr std::iter_difference_t<I> advance( I& i, std::iter_difference_t<I> n, S bound ); |
(3) | (自 C++20 起) |
1) 将给定的迭代器 i 递增 n 次。
2) 递增给定的迭代器 i 直到 i == bound。
3) 将给定的迭代器 i 递增 n 次,或直到 i == bound,以先发生者为准。
如果 n 为负数,则迭代器递减。在这种情况下,如果提供了 bound,则 I
必须是 std::bidirectional_iterator 模型,且 S
必须与 I
类型相同,否则行为未定义。
此页面上描述的类函数实体是算法函数对象(俗称 niebloid),即
内容 |
[编辑] 参数
i | - | 要递增的迭代器 |
bound | - | 哨位,表示范围的末尾,i 是指向该范围的迭代器 |
n | - | i 的最大递增次数 |
[编辑] 返回值
3) n 与 i 实际遍历的距离之差。
[编辑] 复杂度
线性。
但是,如果 I
额外地是 std::random_access_iterator 模型,或者 S
是 std::sized_sentinel_for<I> 模型,或者 I
和 S
是 std::assignable_from<I&, S> 模型,则复杂度为常数。
[编辑] 注解
如果指定的递增或递减序列需要递增不可递增的迭代器(例如,过尾迭代器),或者递减不可递减的迭代器(例如,首迭代器或奇异迭代器),则行为未定义。
[编辑] 可能的实现
struct advance_fn { template<std::input_or_output_iterator I> constexpr void operator()(I& i, std::iter_difference_t<I> n) const { if constexpr (std::random_access_iterator<I>) i += n; else { while (n > 0) { --n; ++i; } if constexpr (std::bidirectional_iterator<I>) { while (n < 0) { ++n; --i; } } } } template<std::input_or_output_iterator I, std::sentinel_for<I> S> constexpr void operator()(I& i, S bound) const { if constexpr (std::assignable_from<I&, S>) i = std::move(bound); else if constexpr (std::sized_sentinel_for<S, I>) (*this)(i, bound - i); else while (i != bound) ++i; } template<std::input_or_output_iterator I, std::sentinel_for<I> S> constexpr std::iter_difference_t<I> operator()(I& i, std::iter_difference_t<I> n, S bound) const { if constexpr (std::sized_sentinel_for<S, I>) { // std::abs is not constexpr until C++23 auto abs = [](const std::iter_difference_t<I> x) { return x < 0 ? -x : x; }; if (const auto dist = abs(n) - abs(bound - i); dist < 0) { (*this)(i, bound); return -dist; } (*this)(i, n); return 0; } else { while (n > 0 && i != bound) { --n; ++i; } if constexpr (std::bidirectional_iterator<I>) { while (n < 0 && i != bound) { ++n; --i; } } return n; } } }; inline constexpr auto advance = advance_fn(); |
[编辑] 示例
运行此代码
#include <iostream> #include <iterator> #include <vector> int main() { std::vector<int> v {3, 1, 4}; auto vi = v.begin(); std::ranges::advance(vi, 2); std::cout << "1) value: " << *vi << '\n' << std::boolalpha; std::ranges::advance(vi, v.end()); std::cout << "2) vi == v.end(): " << (vi == v.end()) << '\n'; std::ranges::advance(vi, -3); std::cout << "3) value: " << *vi << '\n'; std::cout << "4) diff: " << std::ranges::advance(vi, 2, v.end()) << ", value: " << *vi << '\n'; std::cout << "5) diff: " << std::ranges::advance(vi, 4, v.end()) << ", vi == v.end(): " << (vi == v.end()) << '\n'; }
输出
1) value: 4 2) vi == v.end(): true 3) value: 3 4) diff: 0, value: 4 5) diff: 3, vi == v.end(): true
[编辑] 参见
(C++20) |
将迭代器递增给定距离或到边界 (算法函数对象) |
(C++20) |
将迭代器递减给定距离或到边界 (算法函数对象) |
(C++20) |
返回迭代器与哨位之间,或范围的开始和结束之间的距离 (算法函数对象) |
将迭代器递增给定距离 (函数模板) |