std::ranges::advance

 

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< std::input_or_output_iterator I > constexpr void advance( I& i, std::iter_difference_t<I> n );	(1)	(C++20以降)
template< std::input_or_output_iterator I, std::sentinel_for<I> S > constexpr void advance( I& i, S bound );	(2)	(C++20以降)
template< std::input_or_output_iterator I, std::sentinel_for<I> S > constexpr std::iter_difference_t<I> advance( I& i, std::iter_difference_t<I> n, S bound );	(3)	(C++20以降)

1) 与えられたイテレータ i を n 回インクリメントします。

2) 与えられたイテレータ i を i == bound になるまでインクリメントします。

3) 与えられたイテレータ i を n 回、または i == bound になるまで、いずれか早い方までインクリメントします。

n が負の場合、イテレータはデクリメントされます。この場合、I は std::bidirectional_iterator をモデルとしなければならず、S が提供されている場合は I と同じ型でなければなりません。そうでなければ、動作は未定義です。

このページで説明されている関数のようなエンティティは、アルゴリズム関数オブジェクト（非公式にはニーブロイドとして知られている）です。つまり、

• これらのいずれかを呼び出す際に、明示的なテンプレート引数リストを指定することはできません。
• これらのいずれも実引数依存の名前探索には見えません。
• これらのいずれかが関数呼び出し演算子の左側の名前として通常の非修飾名探索によって見つかった場合、実引数依存の名前探索は抑制されます。

パラメータ

i	-	進めるイテレータ
bound	-	i が指している範囲の終端を示すセンチネル
n	-	i の最大インクリメント数

戻り値

3) n と、i が実際に移動した距離との差。

計算量

線形。

しかし、I がさらに std::random_access_iterator をモデルとする場合、または S が std::sized_sentinel_for<I> をモデルとする場合、または I と S が std::assignable_from<I&, S> をモデルとする場合は、計算量は定数です。

注記

指定されたインクリメントまたはデクリメントのシーケンスが、インクリメント不可能なイテレータ（終端イテレータなど）のインクリメント、またはデクリメント不可能なイテレータ（先頭イテレータまたは特異イテレータなど）のデクリメントを必要とする場合、動作は未定義です。

可能な実装

struct advance_fn { template<std::input_or_output_iterator I> constexpr void operator()(I& i, std::iter_difference_t<I> n) const { if constexpr (std::random_access_iterator<I>) i += n; else { while (n > 0) { --n; ++i; }   if constexpr (std::bidirectional_iterator<I>) { while (n < 0) { ++n; --i; } } } }   template<std::input_or_output_iterator I, std::sentinel_for<I> S> constexpr void operator()(I& i, S bound) const { if constexpr (std::assignable_from<I&, S>) i = std::move(bound); else if constexpr (std::sized_sentinel_for<S, I>) (*this)(i, bound - i); else while (i != bound) ++i; }   template<std::input_or_output_iterator I, std::sentinel_for<I> S> constexpr std::iter_difference_t<I> operator()(I& i, std::iter_difference_t<I> n, S bound) const { if constexpr (std::sized_sentinel_for<S, I>) { // std::abs is not constexpr until C++23 auto abs = [](const std::iter_difference_t<I> x) { return x < 0 ? -x : x; };   if (const auto dist = abs(n) - abs(bound - i); dist < 0) { (*this)(i, bound); return -dist; }   (*this)(i, n); return 0; } else { while (n > 0 && i != bound) { --n; ++i; }   if constexpr (std::bidirectional_iterator<I>) { while (n < 0 && i != bound) { ++n; --i; } }   return n; } } };   inline constexpr auto advance = advance_fn();

例

このコードを実行

#include <iostream>
#include <iterator>
#include <vector>
 
int main()
{
    std::vector<int> v {3, 1, 4};
 
    auto vi = v.begin();
 
    std::ranges::advance(vi, 2);
    std::cout << "1) value: " << *vi << '\n' << std::boolalpha;
 
    std::ranges::advance(vi, v.end());
    std::cout << "2) vi == v.end(): " << (vi == v.end()) << '\n';
 
    std::ranges::advance(vi, -3);
    std::cout << "3) value: " << *vi << '\n';
 
    std::cout << "4) diff: " << std::ranges::advance(vi, 2, v.end())
              << ", value: " << *vi << '\n';
 
    std::cout << "5) diff: " << std::ranges::advance(vi, 4, v.end())
              << ", vi == v.end(): " << (vi == v.end()) << '\n';
}

出力

1) value: 4
2) vi == v.end(): true
3) value: 3
4) diff: 0, value: 4
5) diff: 3, vi == v.end(): true

関連項目

ranges::next (C++20)	イテレータを指定された距離または境界までインクリメントする (アルゴリズム関数オブジェクト)
ranges::prev (C++20)	イテレータを指定された距離または境界までデクリメントする (アルゴリズム関数オブジェクト)
ranges::distance (C++20)	イテレータと番兵 (sentinel) の間の距離、またはRangeの始点と終点の間の距離を返す (アルゴリズム関数オブジェクト)
advance	イテレータを指定された距離だけ進める (関数テンプレート)