std::basic_const_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)

 

std::basic_const_iterator

メンバ関数

basic_const_iterator::basic_const_iterator

basic_const_iterator::base

basic_const_iterator::operator*basic_const_iterator::operator->

basic_const_iterator::operator[]

basic_const_iterator::operator++basic_const_iterator::operator+=basic_const_iterator::operator--basic_const_iterator::operator-=

basic_const_iterator::operator==basic_const_iterator::operator<basic_const_iterator::operator<=basic_const_iterator::operator>basic_const_iterator::operator>=basic_const_iterator::operator<=>

basic_const_iterator::operator constant-iterator

非メンバ関数

operator<operator<=operator>operator>= (C++23)(C++23)(C++23)(C++23)

operator+ (C++23)

operator- (C++23)

iter_move(std::basic_const_iterator) (C++23)

ヘルパークラス

common_type<std::basic_const_iterator> (C++23)

 

ヘッダ <iterator> で定義
template< std::input_iterator Iter > class basic_const_iterator;		(C++23から)

std::basic_const_iteratorは、基になるイテレータ（少なくともLegacyInputIteratorであるか、input_iteratorをモデルとする必要がある）とまったく同じように動作するイテレータアダプタですが、逆参照すると、基になるイテレータによって返される値が不変に変換されます。std::basic_const_iteratorの特殊化は定数イテレータです。つまり、要素の変更は許可されないため、イテレータを出力イテレータとして使用することはできません。

メンバ型

メンバ型	定義
iterator_category (条件付きで存在)	Iterがforward_iteratorをモデルとする場合 メンバiterator_categoryは、std::iterator_traits<Iter>::iterator_categoryと同じ型です。 それ以外の場合、メンバiterator_categoryはありません。
iterator_concept	std::contiguous_iterator_tag、Iterがcontiguous_iteratorをモデルとする場合。 std::random_access_iterator_tag、Iterがrandom_access_iteratorをモデルとする場合。 std::bidirectional_iterator_tag、Iterがbidirectional_iteratorをモデルとする場合。 std::forward_iterator_tag、Iterがforward_iteratorをモデルとする場合。 std::input_iterator_tag、それ以外の場合。
value_type	std::iter_value_t<Iter>
difference_type	std::iter_difference_t<Iter>
reference (private)	std::iter_const_reference_t<Iter> (説明専用メンバ型*)

メンバオブジェクト

メンバ名	定義
current (private)	base()がコピーまたは移動する基になるイテレータ (説明用のメンバオブジェクト*)

メンバ関数

(コンストラクタ)	新しいbasic_const_iteratorを構築します。 (public member function)
base	基底イテレータにアクセスする (public member function)
operator*operator->	指し示す要素にアクセスする (public member function)
operator[]	インデックスで要素にアクセスする (public member function)
operator++operator++(int)operator+=operator--operator--(int)operator-=	イテレータを進めるまたは後退させます。 (public member function)
operator constant-iterator	基になるイテレータが変換可能な任意の定数イテレータに変換します。 (public member function)
operator==operator<operator>operator<=operator>=operator<=>	基底イテレータを比較する (public member function)

非メンバ関数

operator<operator>operator<=operator>=operator<=> (C++23)	basic_const_iteratorと非basic_const_iteratorを比較します。 (function template)
operator+operator- (C++23)	イテレータを進めるまたは後退させます。 (function template)
operator- (C++23)	2つのイテレータアダプタ間の距離を計算する (関数テンプレート)
iter_move (C++23)	基底イテレータの間接参照の結果を関連する右辺値参照型にキャストする (関数)

ヘルパークラス

std::common_type<std::basic_const_iterator> (C++23)

イテレータとアダプトされたbasic_const_iterator型の共通型を決定します。 (class template specialization)

ヘルパーエイリアステンプレート

template< std::input_iterator I > using const_iterator = /* 説明を参照 */;		(C++23から)

Iがconstant-iterator（公開されていないコンセプト）をモデルとする場合、const_iterator<I>は型Iを指します。それ以外の場合、basic_const_iterator<I>を指します。

template< std::semiregular S > using const_sentinel = /* 説明を参照 */;		(C++23から)

Sがinput_iteratorをモデルとする場合、const_sentinel<S>は型const_iterator<S>を指します。それ以外の場合、Sを指します。

ヘルパー関数テンプレート

template< std::input_iterator T > constexpr const_iterator<T> make_const_iterator( I it ) { return it; }		(C++23から)
template< std::semiregular S > constexpr const_sentinel<S> make_const_sentinel( S s ) { return s; }		(C++23から)

注記

機能テストマクロ	値	規格	機能
__cpp_lib_ranges_as_const	202207L	(C++23)	std::basic_const_iterator
	202311L	(C++23) (DR)	std::basic_const_iteratorは、基になる型の変換可能性に従う必要があります。

例

このコードを実行

#include <cassert>
#include <iterator>
#include <vector>
 
int main()
{
    std::vector v{1, 2, 3};
    std::vector<int>::iterator i = v.begin();
    *i = 4;   // OK, v[0] == 4 now
    i[1] = 4; // OK, the same as *(i + 1) = 4;
 
    auto ci = std::make_const_iterator(i);
    assert(*ci == 4);   // OK, can read the underlying object
    assert(ci[0] == 4); // OK, ditto
    // *ci = 13;        // Error: location is read-only
    // ci[0] = 13;      // Error: ditto
    ci.base()[0] = 42;  // OK, underlying iterator is writable
    assert(*ci == 42);  // OK, underlying location v[0] was modified
}

不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
P2836R1	C++23	basic_const_iteratorは基になる型の変換可能性に従っていません。	変換演算子が提供されています。