std::random_access_iterator

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

イテレータライブラリ

イテレータのコンセプト
indirectly_readable (C++20) indirectly_writable (C++20) weakly_incrementable (C++20) incrementable (C++20) is-integer-like is-signed-integer-like (C++20)(C++20)	sentinel_for (C++20) sized_sentinel_for (C++20) input_iterator (C++20) output_iterator (C++20) input_or_output_iterator (C++20)	forward_iterator (C++20) bidirectional_iterator (C++20) random_access_iterator (C++20) contiguous_iterator (C++20)
イテレータのプリミティブ
input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tagcontiguous_iterator_tag (C++20)	iter_value_titer_difference_titer_reference_titer_const_reference_titer_rvalue_reference_titer_common_reference_t (C++20)(C++20)(C++20)(C++23)(C++20)(C++20)	iterator (C++17で非推奨) iterator_traits incrementable_traits (C++20) indirectly_readable_traits (C++20)
アルゴリズムのコンセプトとユーティリティ
間接呼び出し可能コンセプト
indirectly_unary_invocableindirectly_regular_unary_invocable (C++20)(C++20)	indirect_unary_predicate (C++20) indirect_binary_predicate (C++20)	indirect_equivalence_relation (C++20) indirect_strict_weak_order (C++20)
共通アルゴリズム要件
indirectly_movable (C++20) indirectly_movable_storable (C++20) indirectly_copyable (C++20)	indirectly_copyable_storable (C++20)   indirectly_swappable (C++20) indirectly_comparable (C++20)	permutable (C++20) mergeable (C++20) sortable (C++20)
ユーティリティ
indirect_result_t (C++20)	projected (C++20)	projected_value_t (C++26)
イテレータアダプタ
reverse_iterator make_reverse_iterator (C++14) move_iterator (C++11) make_move_iterator (C++11) default_sentinel_tdefault_sentinel (C++20)(C++20) unreachable_sentinel_tunreachable_sentinel (C++20)(C++20)	front_insert_iterator back_insert_iterator inserter insert_iterator front_inserter back_inserter move_sentinel (C++20)	common_iterator (C++20) counted_iterator (C++20) basic_const_iterator (C++23) const_iterator (C++23) const_sentinel (C++23) make_const_iterator (C++23) make_const_sentinel (C++23)
ストリームイテレータ istream_iterator    ostream_iterator istreambuf_iterator ostreambuf_iterator	イテレータのカスタマイゼーションポイント ranges::iter_move (C++20) ranges::iter_swap (C++20)
イテレータ操作 advance distance prev (C++11)   next (C++11) ranges::advance (C++20) ranges::distance (C++20) ranges::prev (C++20) ranges::next (C++20)	Rangeアクセス begincbegin (C++11)(C++14) rbegincrbegin (C++14)(C++14)   endcend (C++11)(C++14) rendcrend (C++14)(C++14)   sizessize (C++17)(C++20) empty (C++17) data (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以降)

Concept random_access_iterator は、+=, +, -=, - 演算子による定数時間での前進、- 演算子による定数時間での距離計算、添字演算子 [] による配列表記のサポートを追加することで、bidirectional_iterator を改良します。

イテレータコンセプトの決定

このコンセプトの定義は、展示専用のエイリアステンプレート /*ITER_CONCEPT*/ を介して指定されます。

Determine /*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> は型を表さず、置換失敗となります。

意味論的要件

a および b を型 I の有効なイテレータとし、b が a から到達可能であり、n を std::iter_difference_t<I> 型の値で b - a に等しいとします。std::random_access_iterator<I> は、それが包含するすべてのコンセプトがモデル化されており、かつ、

• (a += n) が b に等しい場合にのみモデル化されます。
• std::addressof(a += n) は std::addressof(a) に等しいです。^[1]
• (a + n) は (a += n) に等しいです。
• (a + n) は (n + a) に等しいです。
• 任意の2つの正の整数 x と y について、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 コンセプトは、間接参照が左辺値を返すことを要求しません。

例

C++20 コンセプトを介した std::distance の可能な実装を示します。

このコードを実行

#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);
}

関連項目

bidirectional_iterator (C++20)	forward_iterator が、後方への移動をサポートする双方向イテレータであることを規定する (コンセプト)
contiguous_iterator (C++20)	メモリ上で連続する要素を参照する、random_access_iterator が連続イテレータであることを指定します。 (コンセプト)