STL源码剖析——序列式容器#5 heap

　　准确来讲，heap并不属于STL容器，但它是其中一个容器priority queue必不可少的一部分。顾名思义，priority queue就是优先级队列，允许用户以任何次序将任何元素加入容器内，但取出时是从优先权最高的元素开始取。而优先权有两种，可以是容器内数值最低的，也可以是数值最高的。而priority queue是选择了数值高作为评判优先级的标准。对应实现方法就是binary max heap，其作为priority queue的底层机制。

　　所谓的binary heap（二叉堆），是一种完全二叉树，也就是说，整棵二叉树除了最底层的叶子节点外，其他节点都是被填满的，而最底层的节点是从左至右不得有空节点的，如图所示：

 

 

 　　如图所示，完全二叉树整棵树内没有任何节点漏洞，这使得我们可以使用数组来存储一棵完全二叉树上的所有结点。另外，如果我们数组的索引1开始记录节点，那么父节点与子节点在数组中的关系就一般为：父节点在 i 处，其左子节点必位于数组的 2i 处，其右子节点必位于数组的 2i+1 处。这种以数组表示树的方式，称为隐式表述法。我们的heap需要动态改变节点数，所以用vector是更好的选择。由于priority queue选择的是binary max heap做为自己的底层机制，所以也只提供了max heap的实现，所以我们接下里讨论的都是大根堆（max heap）。每个节点的键值都大于或等于其子节点的键值。

 

heap算法

• push_heap

　　为了满足完全二叉树的条件，最新加入的元素一定要放在最下一层做为叶子节点，并填补在从左至右的第一个空格。新加入的元素并不一定适合于现有的位置，为了满足max-heap的条件，我们需要对刚加入的元素进行一个上浮（percolate up）的操作：将新节点与其父节点比较，如果其键值比父节点的大，就父子交换位置，交换后新加的元素成为了父节点，此时再与它的父节点比较，如此一直上溯，直到不需对换或直到根节点为止。

 

 

 　　push_heap函数接受两个随机迭代器，用来表示一个heap底部容器（vector）的头尾，并且新元素已经插入到底部容器的最尾端，才会进入到该函数。如果参数不符合，或并无新元素插入，该函数的执行结果不可预期。

template <class RandomAccessIterator>
inline void push_heap(RandomAccessIterator first, RandomAccessIterator last) {
    // 注意，此函数被调用时，新元素应已置于底层容器的最尾端。
    //即是新元素被加入到数组（原本最后元素的下一位置）后，才调用该函数
    __push_heap_aux(first, last, distance_type(first), value_type(first));
}

template <class RandomAccessIterator, class Distance, class T>
inline void __push_heap_aux(RandomAccessIterator first,
    RandomAccessIterator last, Distance*, T*) {
    __push_heap(first, Distance((last - first) - 1), Distance(0),
        T(*(last - 1)));
        //于上个函数获取到的迭代器所指对象类型T，用于强制转换
        //Distance(0)为指出最大值的索引值
        //Distance((last - first) - 1)为指出新添值的索引值
}

template <class RandomAccessIterator, class Distance, class T>
void __push_heap(RandomAccessIterator first, Distance holeIndex,
    Distance topIndex, T value) {
    //holeIndex为指出新添值的索引值
    //topIndex最大值的索引值
    //value为新添值内容
    Distance parent = (holeIndex - 1) / 2; // 找出新元素的父节点
    while (holeIndex > topIndex && *(first + parent) < value) {
        // 当尚未到达顶端，且父节点小于新值（不符合 heap 的次序特性），继续上浮
        // 由于以上使用 operator<，可知 STL heap 是一种 max-heap（大根堆）。
        *(first + holeIndex) = *(first + parent); // 子位置设父值
        holeIndex = parent; // percolate up：調整新添值的索引值，向上提升至父节点。
            parent = (holeIndex - 1) / 2; // 获取新索引值的父节点
    } // 持续到顶端，或满足 heap 的次序特性为止。
    *(first + holeIndex) = value; // 令最后的索引值为新值，完成插入。
}

• pop_heap

　　最大值在根节点处，pop操作取走根节点（其实是把它转移到vector的尾端节点上），为了满足完全二叉树的条件，必须割舍最底层最右边的节点，把其值拿出来放至一临时变量里，然后该位置放根节点的值（最后会被pop_back()给移除）。

template <class RandomAccessIterator>
inline void pop_heap(RandomAccessIterator first, RandomAccessIterator last) {
    __pop_heap_aux(first, last, value_type(first));
}

template <class RandomAccessIterator, class T>
inline void __pop_heap_aux(RandomAccessIterator first,
    RandomAccessIterator last, T*) {
    __pop_heap(first, last - 1, last - 1, T(*(last - 1)), distance_type(first));
    // 设定准条调整的值为尾值，然后将首值调至
    // 尾节点（所以以上将迭代器 result 设为 last-1）。然后重整 [first, last-1)，
    // 使之重新成一個合格的 heap。
}

template <class RandomAccessIterator, class T, class Distance>
inline void __pop_heap(RandomAccessIterator first, RandomAccessIterator last,
    RandomAccessIterator result, T value, Distance*) {
    *result = *first; // 设定尾值为首值，于是尾值即为要求的结果，
                      // 可由客端稍后再调用 pop_back() 取出尾值。
    __adjust_heap(first, Distance(0), Distance(last - first), value);
    // 以上重新调整 heap，要调整的索引值为 0（亦即树根处），欲调整值为 value（原尾值）。
}

template <class RandomAccessIterator, class Distance, class T>
void __adjust_heap(RandomAccessIterator first, Distance holeIndex,
    Distance len, T value) {
    //holeIndex：要调整的索引值，从树根处出发
    //len：所有元素个数（不包括被调整到尾节点的首节点），即[0, len)
    //value：记录了原最底层最右边的节点的值
    Distance topIndex = holeIndex;
    Distance secondChild = 2 * holeIndex + 2; // 调整的索引值的右子节点
    while (secondChild < len) {
        // 比较这左右两个子值，然后以 secondChild 代表较大子节点。
        if (*(first + secondChild) < *(first + (secondChild - 1)))
            secondChild--;
        // Percolate down：令较大子值代替要调整索引值处的值，再令调整的索引值下移至较大子节点处。
        *(first + holeIndex) = *(first + secondChild);
        holeIndex = secondChild;
        // 继续找出要调整的索引值的右子节点
        secondChild = 2 * (secondChild + 1);
    }
    if (secondChild == len) { // 相等，说明沒有右子节点（不是说没有，而是被准备pop掉的元素占用了，见*result = *first;），只有左子节点
                              // Percolate down：令左子值代替要调整索引值处的值，再令要调整的索引值下移至左子节点处。
        *(first + holeIndex) = *(first + (secondChild - 1));
        holeIndex = secondChild - 1;
    }

    // 此时可能尚未满足次序特性，再执行一次上浮操作
    __push_heap(first, holeIndex, topIndex, value);
}

 　　注意，pop_heap之后，最大元素只是被放置于底部容器的最尾端，尚未被取走。如果要取其值，可使用底部容器的back()函数。如果要移除它，可使用底部容器所提供的pop_back()函数。

• sort_heap

　　既然每次调用pop_heap可获得heap中键值最大的元素，如果持续对整个heap做pop_heap操作，且每次的操作范围都从后向前缩减一个元素，那么当整个程序执行完毕，我们便有了一个递增序列。sort_heap便是如此做的。该函数接受两个迭代器，用来表示heap的首尾。如果并非首尾，该函数的执行结果不可预期。注意，排序过后，底层容器里的就不再是一个合法的heap了。

template <class RandomAccessIterator>
void sort_heap(RandomAccessIterator first, RandomAccessIterator last) {
    // 以下，每执行一次 pop_heap()，极大值即被放在尾端。
    // 尾端自减后（往左移动一格）再执行一次 pop_heap()，次极值又被放在新尾端。一直下去，最后即得
    // 排序结果。
    while (last - first > 1)
        pop_heap(first, last--); // 每执行 pop_heap() 一次，操作范围即退缩一格。
}

 

• make_heap

　　这个算法用来将一段现有的数据转化为一个heap。把一段数据转换为heap的要点就是找到最后一个拥有子节点的节点，例如：

 

 　　假设这是一个普通数组，并无heap特性，那么要想其转化为一个heap，切入点就是找到最后一个拥有子节点的节点，上图而言就是E点，以E节点为首的子树，对该子树进行下沉操作和上浮操作，即先交换E跟J的值，再对J进行上浮操作。这样以E节点为首的子树就符合heap特性了。然后自减，来到了D节点（倒二拥有子节点的节点），同样对以D节点为首的子树进行下沉和上浮操作；然后再自减，直至到达根节点为止。这样整个数组就符合heap特性了。那么问题来了？怎么在一个普通数组中找到最后一个拥有子节点的节点的索引值呢？可以证明的是，如果有一长度为n的数组，那么最后一个拥有子节点的节点的索引值就是 (n - 2) / 2 ，这是数组从索引0开始的情况。

// 将 [first,last) 排列为一个 heap。
template <class RandomAccessIterator>
inline void make_heap(RandomAccessIterator first, RandomAccessIterator last) {
    __make_heap(first, last, value_type(first), distance_type(first));
}

template <class RandomAccessIterator, class T, class Distance>
void __make_heap(RandomAccessIterator first, RandomAccessIterator last, T*,
    Distance*) {
    if (last - first < 2) return; // 如果長度為 0 或 1，不必重新排列。
    Distance len = last - first;
    // 找出第一个需要重排的子树头部，以 parent 标示出。由于任何叶子节点都不需执行
        // perlocate down（下沉），所以有以下计算。
        Distance parent = (len - 2) / 2;

    while (true) {
        // 重排以 parent 为首的子树。len 是为了让 __adjust_heap() 判断操作范围
        __adjust_heap(first, parent, len, T(*(first + parent)));
        if (parent == 0) return; // 直至根节点，就结束。
        parent--; // 未到根节点，就将（即将重排的子树的）索引值向前一個节点
    }
}

　　heap没有迭代器，heap的所有元素都必须遵循特别的排列规则，所以heap不提供遍历功能，也不提供迭代器。