std::random_access_iterator

来自cppreference.com
< cpp‎ | iterator
 
 
迭代器库
迭代器概念
random_access_iterator
(C++20)


迭代器原语
算法概念与工具
间接可调用概念
常用算法要求
(C++20)
(C++20)
(C++20)
工具
(C++20)
迭代器适配器
范围访问
(C++11)(C++14)
(C++14)(C++14)  
(C++11)(C++14)
(C++14)(C++14)  
(C++17)(C++20)
(C++17)
(C++17)
 
在标头 <iterator> 定义
template< class I >

    concept random_access_iterator =
        std::bidirectional_iterator<I> &&
        std::derived_from</*ITER_CONCEPT*/<I>, std::random_access_iterator_tag> &&
        std::totally_ordered<I> &&
        std::sized_sentinel_for<I, I> &&
        requires(I i, const I j, const std::iter_difference_t<I> n) {
            { i += n } -> std::same_as<I&>;
            { j +  n } -> std::same_as<I>;
            { n +  j } -> std::same_as<I>;
            { i -= n } -> std::same_as<I&>;
            { j -  n } -> std::same_as<I>;
            {  j[n]  } -> std::same_as<std::iter_reference_t<I>>;

        };
(C++20 起)

概念 random_access_iterator 精化 bidirectional_iterator,添加了用 +=-=+- 运算符进行常数时间的前进,用 - 进行常数时间的距离计算,及带下标 [] 的数组记法支持。

迭代器概念确定

此概念的定义通过仅用于阐释的别名模板 /*ITER_CONCEPT*/ 说明。

为确定 /*ITER_CONCEPT*/<I>,令 ITER_TRAITS<I> 若特化 std::iterator_traits<I> 从主模板生成则代表 I,否则代表 std::iterator_traits<I>

  • ITER_TRAITS<I>::iterator_concept 合法并指名类型,则 /*ITER_CONCEPT*/<I> 代表该类型。
  • 否则,若 ITER_TRAITS<I>::iterator_category 合法并指名类型,则 /*ITER_CONCEPT*/<I> 代表该类型。
  • 否则,若 std::iterator_traits<I> 从主模板生成,则 /*ITER_CONCEPT*/<I> 指代 std::random_access_iterator_tag
  • 否则 /*ITER_CONCEPT*/<I> 不代表类型并导致替换失败。

语义要求

abI 类型的合法迭代器,使得从 a 可及 b,并令 n 为等于 b - astd::iter_difference_t<I> 类型的值。random_access_iterator<I> 仅若其所蕴含的概念均被实现并且符合下列条件才得到实现:

  • (a += n) 等于 b
  • std::addressof(a += n) 等于 std::addressof(a)[1]
  • (a + n) 等于 (a += n)
  • (a + n) 等于 (n + a)
  • 对于任何两个正整数 xy,若 a + (x + y) 合法,则 a + (x + y) 等于 (a + x) + y
  • a + 0 等于 a
  • (a + (n - 1)) 合法,则 --b 等于 (a + (n - 1))
  • (b += -n)(b -= n) 都等于 a
  • std::addressof(b -= n) 等于 std::addressof(b)[1]
  • (b - n) 等于 (b -= n)
  • b 可解引用,则 a[n] 合法并等于 *b
  • bool(a <= b)true
  • 每个要求的操作均拥有常数时间复杂度。

注意,std::addressof 返回迭代器对象的地址,而非迭代器所指向对象的地址。即 operator+=operator-= 必须返回到 *this 的引用。

相等性保持

标准库概念的 requires 表达式中声明的表达式都要求保持相等性(除非另外说明)。

隐式表达式变种

使用了不修改某常量左值操作数的表达式的 requires 表达式,也会要求其隐式的表达式变种

注解

不同于老式随机访问迭代器 (LegacyRandomAccessIterator) 要求,random_access_iterator 概念不要求解引用返回左值。

示例

演示一种 std::distance 的通过 C++20 概念的可能实现。

#include <iterator>
 
namespace cxx20
{
    template<std::input_or_output_iterator Iter>
    constexpr std::iter_difference_t<Iter> distance(Iter first, Iter last)
    {
        if constexpr(std::random_access_iterator<Iter>)
            return last - first;
        else
        {
            std::iter_difference_t<Iter> result{};
            for (; first != last; ++first)
                ++result;
            return result;
        }
    }
}
 
int main()
{
    static constexpr auto il = {3, 1, 4};
 
    static_assert(std::random_access_iterator<decltype(il.begin())> &&
                  cxx20::distance(il.begin(), il.end()) == 3 &&
                  cxx20::distance(il.end(), il.begin()) == -3);
}

参阅

指定 forward_iterator 为双向迭代器,支持向后移动
(概念)
指定 random_access_iterator 为连续迭代器,指代内存中连续相接的元素
(概念)