名稱空間
變體
操作

std::ranges::advance

來自 cppreference.com
 
 
迭代器庫
迭代器概念
迭代器原語
演算法概念與工具
間接可呼叫概念
常用演算法要求
(C++20)
(C++20)
(C++20)
工具
(C++20)
迭代器介面卡
迭代器操作
(C++11)  
(C++11)
ranges::advance
(C++20)
範圍訪問
(C++11)(C++14)
(C++14)(C++14)  
(C++11)(C++14)
(C++14)(C++14)  
(C++17)(C++20)
(C++17)
(C++17)
 
定義於標頭檔案 <iterator>
呼叫簽名 (Call signature)
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 為負數,則迭代器遞減。在此情況下,如果提供了 bound,則 I 必須是 std::bidirectional_iterator 的模型,且 S 必須與 I 型別相同,否則行為未定義。

本頁描述的類函式實體是 演算法函式物件(非正式地稱為 niebloids),即

目錄

[編輯] 引數

i - 要前進的迭代器
bound - 表示 i 是其迭代器的範圍的末尾的哨位
n - i 的最大遞增次數

[編輯] 返回值

3) ni 遍歷的實際距離之間的差值。

[編輯] 複雜度

線性。

然而,如果 I 額外模型化 std::random_access_iterator,或者 S 模型化 std::sized_sentinel_for<I>,或者 IS 模型化 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

[編輯] 參閱

按給定距離或到邊界遞增迭代器
(演算法函式物件)[編輯]
按給定距離或到邊界遞減迭代器
(演算法函式物件)[編輯]
返回迭代器與哨兵之間,或範圍開頭與結尾之間的距離
(演算法函式物件)[編輯]
按給定距離前進迭代器
(函式模板) [編輯]