【C++】std::distance()函数的详细解析（小白一看就懂哦！！）

这个 distance()函数是我在刷 leetcode 的时候遇到的，当时就充满疑惑，这个函数到底是干什么的呢？很是懵逼，于是在网上搜索了一下，将其总结如下。

sunny-ll

9127人浏览 · 2024-04-09 10:23:30

sunny-ll · 2024-04-09 10:23:30 发布

一、前言

这个 distance()函数 是我在刷 leetcode 的时候遇到的，当时就充满疑惑，这个函数到底是干什么的呢？很是懵逼，于是在网上搜索了一下，将其总结如下。

二、简介

在C++标准库中，std::distance()是一个非常有用的函数，可用于计算两个迭代器之间的距离。它提供了一种方便的方法来确定容器中元素的数量，以及在处理迭代器范围时进行遍历和计算。它在头文件 <iterator> 中定义，函数原型如下：

template< class InputIt >
typename std::iterator_traits<InputIt>::difference_type
    distance( InputIt first, InputIt last );

这个函数接受两个迭代器参数，即 first 和 last，用于指定要计算距离的范围。它返回一个类型为 iterator_traits<InputIt>::difference_type的值，表示first和last之间的距离。
在使用 std::distance()之前，需要包含头文件<iterator>，该头文件定义了std::distance()函数以及相关的迭代器特性。

三、使用说明

以下是一个简单的示例，演示了如何使用std::distance()计算一个向量中元素的数量：

#include <iostream>
#include <vector>
#include <iterator>

int main() {
    // 创建一个 一维动态数组
    std::vector<int> vec = {1, 2, 3, 4, 5};
    // 建立 迭代器
    auto begin = vec.begin(); // 向量的起始迭代器
    auto end = vec.end(); // 向量的结束迭代器

    auto count = std::distance(begin, end); // 计算距离 --- 5

    std::cout << "元素数量: " << count << std::endl;

    return 0;
}

在这个示例中，我们创建了一个包含 5 个元素的向量 vec，并使用vec.begin()和vec.end()分别获取向量的起始迭代器和结束迭代器。然后，我们使用std::distance()函数计算begin和end之间的距离，并将结果存储在变量count中。最后，我们输出计算得到的元素数量。

std::distance()不仅适用于容器类型，还适用于普通数组（指针）。以下是一个示例，展示了如何使用std::distance()计算数组中元素的数量：

#include <iostream>
#include <iterator>

int main() 
{
    int arr[] = {1, 2, 3, 4, 5};

    auto begin = std::begin(arr); // 数组的起始迭代器
    auto end = std::end(arr); // 数组的结束迭代器

    auto count = std::distance(begin, end); // 计算距离

    std::cout << "元素数量: " << count << std::endl;

    return 0;
}

可以看出来，std::distance()对指针的计算与C/C++中直接将指针相减的结果是一致的，即是基于类型长度的距离，而非基于内存地址的直接做差。

四、注意事项

在使用std::distance()函数时，有几点需要注意：

std::distance()函数适用于各种迭代器类型，包括指针迭代器、容器迭代器等。只要迭代器满足LegacyInputIterator的要求，即可以从所指向的元素读取数据。LegacyInputIterators只能保证单遍算法的有效性：一旦LegacyInputIterator已经递增，它前一个值的所有副本都可能无效。
std::distance()函数计算的是迭代器之间的距离，而不是元素的个数。因此，在使用时需要确保迭代器范围有效，否则可能导致未定义行为。
对于顺序容器（如向量、列表等），std::distance)_的时间复杂度为O(N)，其中N是迭代器范围内的元素数量。对于随机访问迭代器（如指针、数组等），std::distance()的时间复杂度为O(1)，因为它可以直接通过指针的减法来计算距离。

五、常考面试题

题目：在排序数组中查找元素的第一个和最后一个
链接：34. 在排序数组中查找元素的第一个和最后一个位置

class Solution {
public:
    vector<int> searchRange(vector<int>& nums, int target) 
{
        if (!nums.size()) return {-1, -1};
        auto index1 = lower_bound(nums.begin(), nums.end(),target); // 返回第一个大于等于迭代器
        auto index2 = upper_bound(nums.begin(), nums.end(),target); // 返回第一个大于tar的迭代器
        if (index1 == nums.end() || *index1 != target) return {-1, -1}; // 这个值根本不存在
        return {(int)distance(nums.begin(), index1),(int)distance(nums.begin(), index2 - 1)};
    }
};