Namespaces
Variants

std::ranges:: advance

From cppreference.net
Iterator library
Iterator concepts
Iterator primitives
Algorithm concepts and utilities
Indirect callable concepts
Common algorithm requirements
(C++20)
(C++20)
(C++20)
Utilities
(C++20)
Iterator adaptors
Range access
(C++11) (C++14)
(C++14) (C++14)
(C++11) (C++14)
(C++14) (C++14)
(C++17) (C++20)
(C++17)
(C++17)
Definido en el encabezado <iterator>
Firma de llamada
template < std:: input_or_output_iterator I >
constexpr void advance ( I & i, std:: iter_difference_t < I > n ) ;
(1) (desde C++20)
template < std:: input_or_output_iterator I, std:: sentinel_for < I > S >
constexpr void advance ( I & i, S bound ) ;
(2) (desde 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) (desde C++20)
1) Incrementa el iterador dado i por n veces.
2) Incrementa el iterador dado i hasta que i == bound .
3) Incrementa el iterador dado i por n veces, o hasta que i == bound , lo que ocurra primero.

Si n es negativo, el iterador se decrementa. En este caso, I debe modelar std::bidirectional_iterator , y S debe ser del mismo tipo que I si se proporciona bound , de lo contrario el comportamiento es indefinido.

Las entidades similares a funciones descritas en esta página son algorithm function objects (conocidas informalmente como niebloids ), es decir:

Contenidos

Parámetros

i - iterador a ser avanzado
bound - centinela que denota el final del rango i es un iterador de
n - número de incrementos máximos de i

Valor de retorno

3) La diferencia entre n y la distancia real i recorrida.

Complejidad

Lineal.

Sin embargo, si I además modela std::random_access_iterator , o S modela std:: sized_sentinel_for < I > , o I y S modelan std:: assignable_from < I & , S > , la complejidad es constante.

Notas

El comportamiento es indefinido si la secuencia especificada de incrementos o decrementos requiere que un iterador no incrementable (como el iterador pasado-el-final) sea incrementado, o que un iterador no decrementable (como el iterador frontal o el iterador singular) sea decrementado.

Implementación posible

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 no es constexpr hasta 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();

Ejemplo

#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) valor: " << *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) valor: " << *vi << '\n';
    std::cout << "4) diff: " << std::ranges::advance(vi, 2, v.end())
              << ", valor: " << *vi << '\n';
    std::cout << "5) diff: " << std::ranges::advance(vi, 4, v.end())
              << ", vi == v.end(): " << (vi == v.end()) << '\n';
}

Salida:

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

Véase también

incrementa un iterador por una distancia dada o hasta un límite
(objeto función de algoritmo)
decrementa un iterador por una distancia dada o hasta un límite
(objeto función de algoritmo)
devuelve la distancia entre un iterador y un centinela, o entre el inicio y el final de un rango
(objeto función de algoritmo)
avanza un iterador por una distancia dada
(plantilla de función)