Fluent C++：了解STL 算法库的重要性

原文

STL算法是一组神奇的工具，可以提高代码的表达性和正确性。

这篇文章解释了如何使用STL算法，以及它们能给你带来什么。

算法库与循环

让我们从可以在产品代码中找到的代码示例开始。你能告诉我这个代码有什么用吗？

for (std::vector::const_iterator it = employees.begin(); it != employees.end(); ++it)
{
    employeeRegister.push_back(*it);
}

如果你像大多数开发人员一样，我知道，你将通读这段代码，并在10至15秒内得出，这段代码将employees中的元素拷贝到某种register中。

现在你能说出第二段代码的作用吗？

std::copy(employees.begin(), employees.end(), std::back_inserter(employeeRegister));

即使你不知道std::back_inserter是什么意思（如果你继续阅读下一节，你无论如何都会这么做）时，你也可以立即知道这是在把employees拷贝到register中，因为代码里就是写的：copy。在这个单独的两行例子中，时间差不是很大——只有10-15秒。但是，当你将此值乘以代码库中的行数，并考虑更复杂的用例时，这实际上会不利于代码的阅读。

std::copy是STL的一种算法，通过#include即可找到。我意识到这段代码中有些东西比信息更复杂，比如. begin ()和. end () ，但是这可以用ranges来细化，我们将在一篇专门的文章中对此进行探讨。总之，STL的使用为明确说明执行什么操作奠定了基础。

基本上， STL算法说他们做什么，而不是如何做。这确实与尊重抽象层次有关，正如这个中心原则的专门文章所解释的(Fluent C++：一切都归结为尊重抽象级别)。

std::copy 和 std::back_inserter

如果你了解到上面的代码做了拷贝，但是你还不知道std::copy和std::back_inserter的细节，让我们现在就详细看一下。这是一个需要理解的重要例子，因为它是相当普遍的。如果你已经知道的话，可以直接跳到下一节。

std::copy在输入参数中使用了三个迭代器：

• 输入范围的开始和结束，包含要从中复制的元素
• 输出范围的起始点，拷贝应该放在该位置

这是它的原型：

template 
OutputIterator copy(InputIterator first, InputIterator last, OutputIterator out);

在STL中，范围的开始是一个迭代器，指向它的第一个元素，按照惯例，范围的结束是一个迭代器，指向它最后一个元素后面的一个：

image.png

std::copy的输出迭代器是将被复制到的范围的开始。

std::copy对输入范围进行迭代，依次将所有元素复制到从out迭代器开始的范围：

image.png

如上图所示，std::copy在输出集合中需要一些空间来放置它从输入中复制的所有元素。不过，在大多数情况下，预先计算在输出集合中应该有多少空间，并调整其大小是不切实际的。

这就是std::back_inserter发挥作用的地方。std::back_inserter创建一个迭代器，该迭代器连接到它所传递的容器。当你通过这个迭代器写代码时，它实际上会调用这个容器的push_back方法，而这个方法使用你试图写的值。如果输出容器是vector（大多数情况下与vector一样），这将有效地减轻程序员调整输出集合的大小，因为每次std::copy写入时，输出迭代器都直接产生空间。

因此，使用std::copy的代码可以这样写：

std::copy(employees.begin(), employees.end(), std::back_inserter(employeeRegister));

这是普通的C++。在编写本文时（<=C++17），该语言本身就提供了这些内容，尽管range的主题允许更进一步。你应该有能力读懂这些代码，并且不怕编写这些代码。

使用算法库的优点

如上所述，通过提高代码的抽象级别来提升表达能力是算法库的主要优点之一。也就是说，他们展示的是做了什么，而不是如何执行的。

不过，它们还带来其他几个好处：

• 他们避免一些常见的错误，如差一错误或操作空容器。在编写for循环时，总是需要确保它停在正确的步骤，并且当没有元素要迭代时，它的行为是正确的。所有的算法都为你处理过了这些状况。
• 当使用STL算法时，你将获得某种高质量的实现。这些算法已经由那些知道它们在做什么的人实现，并经过了广泛的测试。通过使用它们，你可以从这种级别的质量中获益。
• STL算法为你带来最佳算法复杂性。 std::copy非常简单，但还有其他更复杂的O ( n2 )级别的算法，可以优化到O ( n ) ，例如，像set上的算法。在这方面，STL提供了最佳实现方式。
• STL的设计使算法与运算数据解耦，使得数据和运算可以独立演进。

使用算法库应注意的两个误区

希望你现在已经决定使用STL算法来改进代码。但在开始之前，你需要知道两个经典的陷阱。

不要对每个问题都使用for_each

如果你从编写for循环的习惯中走出来，那么你可能会被std::for_each吸引，因为这个算法看起来有点像for循环。实际上，for_each连续地将一个函数（或函子或lambda）应用于集合的所有元素：

template 
Function for_each(InputIterator first, InputIterator last, Function f);

std::for_each确实是一种STL算法，因此将其放在你的工具箱中是件好事。但是主要有一个特殊的例子，其中for_each被有效地适应了：当执行副作用。实际上，for_each应该用来修改集合的元素，或者对更一般的意义执行副作用，比如向logger或外部服务发送信息。

如果你需要计算某一个值出现在容器中的次数，那么不要使用for_each。使用std::count。
如果你需要知道容器中是否至少有一个元素满足谓词，请不要使用for_each。使用std::any_of方式。
如果你需要知道容器的所有元素是否满足给定的谓词，请使用std::all_of。
如果你需要了解一个容器是否是另一个容器的排列，最有效的方式是使用std::is_permutation。

等等。

这么多算法

算法种类繁多，可能有些让人不知所措。第二个陷阱是当你在这样的一个参考上查找它们时，你会认出它们中的几个，比如copy，count或find，并且很容易地看到它们是如何有用的。]

但是，在算法列表中，还有一些的名称可能听起来很神秘，比如std::lexixicographical_compare、std::set_symmetric_difference或std::is_heap_until。

自然的反应是忽略这些奇怪的算法，因为你可能会认为它们非常复杂，或者是针对你永远不会遇到的特殊情况设计的。当我第一次开始使用STL算法时，我当然会有这种反应。

但这是不对的。几乎所有的算法在日常代码中都是有用的。

下面我们以std::set_difference为例。你知道这个算法吗？它做集合的差（集合，即排序集合，而不仅仅是std::set）.这就是说，对于排序集合A和排序集合B,set_difference输出A中存在但B中不存在的元素：

这怎么会有用呢？

让我们举一个计算模型的例子，它进行缓存。每次计算该模型时，它都会生成几个结果，这些结果可以添加到缓存中。我们将缓存表示为具有键和值的关联容器，其中允许有多个相同的键，这就是std::multimap的作用。

因此，该模型通过以下方式产生结果：

std::multimap computeModel();

缓存可以这样接受新的数据：

void addToCache(std::multimap const& results);

在实现addToCache函数时，我们需要注意不要添加缓存中已经存在的结果，以避免重复累加。

下面是不使用算法如何实现这一点：

for (std::multimap::const_iterator it = newResults.begin(); it != newResults.end(); ++it)
{
    std::pair::const_iterator, std::multimap::const_iterator> range = cachedResults.equal_range(it->first);
    if (range.first == range.second)
    {
        std::multimap::const_iterator it2 = it;
        while (!(it2->first < it->first) && !(it->first < it2->first))
        {
            ++it2;
        }
        cachedResults.insert(it, it2);
    }
}

我不建议你逐行理解上面的代码。相反，我们可以以不同的方式重新定义问题：我们需要向缓存中添加在结果中但不在缓存中的元素。这就是std::set_difference的作用：

std::multimap resultsToAdd;

std::set_difference(newResults.begin(),
                    newResults.end(),
                    cachedResults.begin(),
                    cachedResults.end(),
                    std::inserter(resultsToAdd, resultsToAdd.end()),
                    compareFirst);

std::copy(resultsToAdd.begin(), resultsToAdd.end(), std::inserter(cachedResults, cachedResults.end()));

std::inserter类似std::back_inserter，只是调用的是其关联的容器的insert方法，而不是push_back。compareFirst是我们定义的函数，告诉std::set_difference比较它们的键上的元素而不是键值对上的元素。

比较两段代码。第二个是告诉你做什么（集合的差），而第一个只是让你“破译”它。在这个特殊的例子中，仍然有太多的参数传递给了set_difference，这可能会在你不习惯使用它时使你有点难以理解。这个问题主要通过本文提出的range概念来解决Fluent C++：Ranges:STL的高级用法
。

正如你理解if和for等语言构造一样，你需要理解STL的组件才能理解代码试图告诉你什么。简单地说，你需要了解算法库。

学习所有这些知识需要时间，但这是一项有益的投资。我将按主题将它们分组展示，以便你了解它们之间的逻辑。希望这会让你尽可能多的，尽可能轻松得记住它们。