std::distance

Определено в заголовке `<iterator>`
template< class InputIt > typename std::iterator_traits<InputIt>::difference_type distance( InputIt first, InputIt last );		(constexpr начиная с C++17)

Возвращает число переходов от first к last.

Если InputIt не является LegacyRandomAccessIterator, поведение неопределено, если last не достижимо из first.

Если InputIt является LegacyRandomAccessIterator, поведение неопределено, если first и last не достижимы друг от друга.

Параметры

first	-	итератор, указывающий на первый элемент
last	-	итератор, указывающий на конец диапазона
Требования к типу
-`InputIt` должен удовлетворять требованиям LegacyInputIterator. Операция более эффективна, если `InputIt` дополнительно удовлетворяет требованиям LegacyRandomAccessIterator.

Значение результата

Число инкрементов, необходимых для перехода от first к last.

Значение может быть отрицательным, если используются итераторы произвольного доступа, и first достижимо из last.

(начиная с C++11)

Сложность

Линейная.

Однако, если InputIt дополнительно удовлетворяет требованиям LegacyRandomAccessIterator, сложность является постоянной.

Возможная реализация

См. также реализации в libstdc++ и libc++.

Реализация C++98 с помощью диспетчеризации тегов, с удалением constexpr
namespace detail { template<class It> constexpr // required since C++17 typename std::iterator_traits<It>::difference_type do_distance(It first, It last, std::input_iterator_tag) { typename std::iterator_traits<It>::difference_type result = 0; while (first != last) { ++first; ++result; } return result; } template<class It> constexpr // required since C++17 typename std::iterator_traits<It>::difference_type do_distance(It first, It last, std::random_access_iterator_tag) { return last - first; } } // namespace detail template<class It> constexpr // since C++17 typename std::iterator_traits<It>::difference_type distance(It first, It last) { return detail::do_distance(first, last, typename std::iterator_traits<It>::iterator_category()); }
Реализация C++17 с помощью if constexpr
template<class It> constexpr typename std::iterator_traits<It>::difference_type distance(It first, It last) { using category = typename std::iterator_traits<It>::iterator_category; static_assert(std::is_base_of_v<std::input_iterator_tag, category>); if constexpr (std::is_base_of_v<std::random_access_iterator_tag, category>) return last - first; else { typename std::iterator_traits<It>::difference_type result = 0; while (first != last) { ++first; ++result; } return result; } }

Реализация C++98 с помощью диспетчеризации тегов, с удалением constexpr

namespace detail
{
    template<class It>
    constexpr // required since C++17
    typename std::iterator_traits<It>::difference_type 
        do_distance(It first, It last, std::input_iterator_tag)
    {
        typename std::iterator_traits<It>::difference_type result = 0;
        while (first != last)
        {
            ++first;
            ++result;
        }
        return result;
    }
 
    template<class It>
    constexpr // required since C++17
    typename std::iterator_traits<It>::difference_type 
        do_distance(It first, It last, std::random_access_iterator_tag)
    {
        return last - first;
    }
} // namespace detail
 
template<class It>
constexpr // since C++17
typename std::iterator_traits<It>::difference_type 
    distance(It first, It last)
{
    return detail::do_distance(first, last,
                               typename std::iterator_traits<It>::iterator_category());
}

Реализация C++17 с помощью if constexpr

template<class It>
constexpr typename std::iterator_traits<It>::difference_type
    distance(It first, It last)
{
    using category = typename std::iterator_traits<It>::iterator_category;
    static_assert(std::is_base_of_v<std::input_iterator_tag, category>);
 
    if constexpr (std::is_base_of_v<std::random_access_iterator_tag, category>)
        return last - first;
    else
    {
        typename std::iterator_traits<It>::difference_type result = 0;
        while (first != last)
        {
            ++first;
            ++result;
        }
        return result;
    }
}

Пример

#include <iostream>
#include <iterator>
#include <vector>
 
int main() 
{
    std::vector<int> v{3, 1, 4};
    std::cout << "distance(first, last) = "
              << std::distance(v.begin(), v.end()) << '\n'
              << "distance(last, first) = "
              << std::distance(v.end(), v.begin()) << '\n';
              // the behavior is undefined (until LWG940)
 
    static constexpr auto il = {3, 1, 4};
    // Since C++17 `distance` can be used in constexpr context.
    static_assert(std::distance(il.begin(), il.end()) == 3);
    static_assert(std::distance(il.end(), il.begin()) == -3);
}

Вывод:

distance(first, last) = 3
distance(last, first) = -3

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющие поведение, были применены ретроактивно к ранее опубликованным стандартам C++.

DR	Применено к	Поведение, опубликованное	Правильное поведение
LWG 940	C++98	формулировка была неясной в случае, когда `first` достижимо из `last`	уточнено

См. также

advance	перемещает итератор на заданное расстояние (шаблон функции)
countcount_if	возвращает количество элементов, удовлетворяющих определённому критерию (шаблон функции)
ranges::distance (C++20)	возвращает расстояние между итератором и стражем или между началом и концом диапазона (niebloid)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/iterator/distance