std::ranges::iter_swap

 

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> で定義
namespace ranges {     inline namespace /* 未指定 */ {         inline constexpr /* 未指定 */             iter_swap = /* 未指定 */;     } }		(C++20以降) (カスタマイズポイントオブジェクト)
呼び出しシグネチャ
template< class I1, class I2 > constexpr void iter_swap( I1&& i1, I2&& i2 ) noexcept(/* 以下参照 */);		(C++20以降)
ヘルパー関数
template< class X, class Y > constexpr std::iter_value_t<X>     iter-exchange-move( X&& x, Y&& y )     noexcept(noexcept(std::iter_value_t<X>(std::ranges::iter_move(x))) &&              noexcept(*x = std::ranges::iter_move(y)));		(説明用*)

2つのイテレータが指す値を交換します。

exposition-onlyヘルパー関数 iter-exchange-move の効果は、以下と同等です。

std::iter_value_t<X> old(std::ranges::iter_move(x));
*x = std::ranges::iter_move(y);
return old;

ranges::iter_swap(i1, i2) は 式同値 です。

1. (void)iter_swap(i1, i2)、ただし i1 または i2 がクラス型または列挙型を持ち、式が well-formed である場合。この場合、iter_swap の オーバーロード解決 は、追加の候補 void iter_swap(auto, auto) = delete; を伴って行われ、std::ranges::iter_swap 自体は除外されます。
   • 選択されたオーバーロードが i1 と i2 が指す値を交換しない場合、プログラムは ill-formed であり、診断は不要です。
2. それ以外の場合、ranges::swap(*i1, *i2)、ただし I1 と I2 の両方が indirectly_readable をモデルとし、かつ std::iter_reference_t<I1> と std::iter_reference_t<I2> が swappable_with をモデルとする場合。
3. それ以外の場合、(void)(*i1 = iter-exchange-move(i2, i1))、ただし std::indirectly_movable_storable<I1, I2> と std::indirectly_movable_storable<I2, I1> が両方ともモデルとされ、かつ i1 は一度だけ評価される場合。
4. それ以外の場合、ranges::iter_swap(i1, i2) は ill-formed となり、ranges::iter_swap(i1, i2) がテンプレートインスタンス化の直接のコンテキストに現れると SFINAE の結果となる可能性があります。

カスタマイゼーションポイントオブジェクト

ranges::iter_swap という名前は、関数オブジェクトであり、リテラルな semiregular クラス型の定数 customization point object を表します。説明のために、その型の cv-unqualified バージョンは __iter_swap_fn と表記されます。

__iter_swap_fn のすべてのインスタンスは等価です。同じ引数に対して呼び出される __iter_swap_fn の異なるインスタンスの効果は、インスタンスを表す式が lvalue であるか rvalue であるか、および const 修飾されているか否かに関わらず同等です（ただし、volatile 修飾されたインスタンスが呼び出し可能である必要はありません）。したがって、ranges::iter_swap は自由にコピーでき、そのコピーは相互に交換可能に使用できます。

型のセット Args... が与えられた場合、std::declval<Args>()... が上記の ranges::iter_swap の引数に対する要件を満たす場合、__iter_swap_fn は以下をモデルとします。

• std::invocable<__iter_swap_fn, Args...>,
• std::invocable<const __iter_swap_fn, Args...>,
• std::invocable<__iter_swap_fn&, Args...>、および
• std::invocable<const __iter_swap_fn&, Args...>.
  

それ以外の場合、__iter_swap_fn の関数呼び出し演算子のいずれもオーバーロード解決に参加しません。

関連項目

iter_swap (C++20)	2つの調整された基礎となるイテレータが指すオブジェクトをスワップする (関数テンプレート)
iter_swap (C++20)	2つの基底イテレータが指すオブジェクトをスワップする (関数テンプレート)
iter_swap	2つのイテレータが指す要素をスワップする (関数テンプレート)