std::ranges:: advance

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

このページで説明されている関数ライクな実体は、 アルゴリズム関数オブジェクト （非公式には niebloids として知られる）です。つまり：

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

パラメータ

戻り値

計算量

線形。

しかし、 I が追加で std::random_access_iterator をモデル化する場合、または S が std:: sized_sentinel_for < I > をモデル化する場合、または I と S が std:: assignable_from < I & , S > をモデル化する場合、計算量は定数時間となります。

注記

指定されたインクリメントまたはデクリメントのシーケンスが、インクリメント不可能なイテレータ（past-the-endイテレータなど）のインクリメント、またはデクリメント不可能なイテレータ（frontイテレータやsingularイテレータなど）のデクリメントを必要とする場合、動作は未定義です。

実装例

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はC++23までconstexprではない
            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

関連項目