std::common_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::common_iterator

メンバ関数

common_iterator::common_iterator

common_iterator::operator=

common_iterator::operator*common_iterator::operator->

common_iterator::operator++common_iterator::operator++(int)

非メンバ関数

operator== (C++20)

operator- (C++20)

iter_move (C++20)

iter_swap (C++20)

ヘルパークラス

incrementable_traits<std::common_iterator> (C++20)

iterator_traits<std::common_iterator> (C++20)

 

ヘッダ <iterator> で定義
template< std::input_or_output_iterator I, std::sentinel_for<I> S >     requires ( !std::same_as<I, S> && std::copyable<I> ) class common_iterator;		(C++20以降)

std::common_iteratorは、イテレータI / センチネルSアダプタであり、イテレータまたはセンチネルのいずれかを含み、適切な等価比較演算子operator==を定義することにより、共通ではない範囲（IとSの型が異なる場合）をcommon_rangeとして表現できます。

std::common_iteratorは、イテレータ/センチネルペアで表されるシーケンスと、common_rangeのようなシーケンスを期待するレガシー関数の間の「ブリッジ」として使用できます。

データメンバー

メンバ名	定義
var	std::variant<I, S>型のオブジェクト (説明用のメンバオブジェクト*)

メンバ関数

(コンストラクタ)	新しいcommon_iteratorを構築します (public member function)
operator=	別のcommon_iteratorを代入します (public member function)
operator*operator->	指し示す要素にアクセスする (public member function)
operator++operator++(int)	common_iteratorを進めます (public member function)

非メンバ関数

operator== (C++20)	基になるイテレータまたはセンチネルを比較します (function template)
operator- (C++20)	2つのイテレータアダプタ間の距離を計算する (function template)
iter_move (C++20)	基底イテレータの間接参照の結果を関連する右辺値参照型にキャストする (関数)
iter_swap (C++20)	2つの基底イテレータが指すオブジェクトをスワップする (関数テンプレート)

ヘルパークラス

std::incrementable_traits<std::common_iterator> (C++20)	std::common_iterator型の関連する差分型を計算します (class template specialization)
std::iterator_traits<std::common_iterator> (C++20)	std::common_iterator型のプロパティへの統一インターフェースを提供します (クラステンプレート特殊化)

例

このコードを実行

#include <algorithm>
#include <iostream>
#include <iterator>
#include <list>
#include <string>
 
template<class ForwardIter>
void fire(ForwardIter first, ForwardIter last)
{
    std::copy(first, last, std::ostream_iterator<std::string>{std::cout, " "});    
}
 
int main()
{
    std::list<std::string> stars{"Pollux", "Arcturus", "Mira", "Aldebaran", "Sun"};
 
    using IT = std::common_iterator<
                   std::counted_iterator<std::list<std::string>::iterator>,
                   std::default_sentinel_t>;
 
    fire(IT(std::counted_iterator(stars.begin(), stars.size() - 1)),
         IT(std::default_sentinel));
}

出力

Pollux Arcturus Mira Aldebaran

参照

• C++23標準 (ISO/IEC 14882:2024)

• 23.5.5 Common iterators [iterators.common]

• C++20 standard (ISO/IEC 14882:2020)

• 23.5.4 Common iterators [iterators.common]

関連項目

ranges::common_range (C++20)	rangeが同一のイテレータ型と番兵型を持つことを規定する (コンセプト)
ranges::common_viewviews::common (C++20)	view を common_range に変換する (クラステンプレート) (rangeアダプタオブジェクト)