Namespaces
Variants

std::ranges:: distance

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 < class I, std:: sentinel_for < I > S >

requires ( ! std:: sized_sentinel_for < S, I > )
constexpr std:: iter_difference_t < I >

distance ( I first, S last ) ;
(1) (desde C++20)
template < class I, std:: sized_sentinel_for < std:: decay_t < I >> S >

constexpr std:: iter_difference_t < std:: decay_t < I >>

distance ( I && first, S last ) ;
(2) (desde C++20)
template < ranges:: range R >

constexpr ranges:: range_difference_t < R >

distance ( R && r ) ;
(3) (desde C++20)
1,2) Devuelve el número de saltos desde first hasta last .
3) Devuelve el tamaño de r como un entero con signo.

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

Contenidos

Parámetros

first - iterador que apunta al primer elemento
last - centinela que denota el final del rango first es un iterador a
r - rango para calcular la distancia de

Valor de retorno

1) El número de incrementos necesarios para ir desde first hasta last .
2) last - static_cast < const std:: decay_t < I > & > ( first ) .
3) Si R modela ranges:: sized_range , retorna ranges:: size ( r ) ; de lo contrario ranges :: distance ( ranges:: begin ( r ) , ranges:: end ( r ) ) .

Complejidad

1) Lineal.
2) Constante.
3) Si R modela ranges:: sized_range o si std:: sized_sentinel_for < ranges:: sentinel_t < R > , ranges:: iterator_t < R >> está modelado, la complejidad es constante; de lo contrario, lineal.

Implementación posible

struct distance_fn
{
    template<class I, std::sentinel_for<I> S>
        requires (!std::sized_sentinel_for<S, I>)
    constexpr std::iter_difference_t<I> operator()(I first, S last) const
    {
        std::iter_difference_t<I> result = 0;
        while (first != last)
        {
            ++first;
            ++result;
        }
        return result;
    }
    template<class I, std::sized_sentinel_for<std::decay<I>> S>
    constexpr std::iter_difference_t<I> operator()(const I& first, S last) const
    {
        return last - first;
    }
    template<ranges::range R>
    constexpr ranges::range_difference_t<R> operator()(R&& r) const
    {
        if constexpr (ranges::sized_range<std::remove_cvref_t<R>>)
            return static_cast<ranges::range_difference_t<R>>(ranges::size(r));
        else
            return (*this)(ranges::begin(r), ranges::end(r));
    }
};
inline constexpr auto distance = distance_fn{};

Ejemplo

#include <cassert>
#include <forward_list>
#include <iterator>
#include <vector>
int main() 
{
    std::vector<int> v{3, 1, 4};
    assert(std::ranges::distance(v.begin(), v.end()) == 3);
    assert(std::ranges::distance(v.end(), v.begin()) == -3);
    assert(std::ranges::distance(v) == 3);
    std::forward_list<int> l{2, 7, 1};
    // auto size = std::ranges::size(l); // error: not a sizable range
    auto size = std::ranges::distance(l); // OK, but aware O(N) complexity
    assert(size == 3);
}

Informes de defectos

Los siguientes informes de defectos que modifican el comportamiento se aplicaron retroactivamente a los estándares de C++ publicados anteriormente.

DR Se aplica a Comportamiento publicado Comportamiento correcto
LWG 3392 C++20 la sobrecarga (1) toma el iterador por valor, por lo tanto se rechazaba
un lvalue de iterador move-only con un centinela dimensionado
se añadió la sobrecarga (2)
LWG 3664 C++20 la resolución de LWG issue 3392 hizo que
ranges::distance rechazara argumentos de array
los acepta

Véase también

avanza un iterador por una distancia dada o hasta un límite dado
(objeto función de algoritmo)
devuelve el número de elementos que cumplen criterios específicos
(objeto función de algoritmo)
devuelve la distancia entre dos iteradores
(plantilla de función)