概述
heap包提供了对任意类型(实现了heap.Interface接口)的堆操作。(最小)堆是具有“每个节点都是以其为根的子树中最小值”属性的树。
树的最小元素为其根元素，索引0的位置。
heap是常用的实现优先队列的方法。要创建一个优先队列，实现一个具有使用(负的)优先级作为比较的依据的Less方法的Heap接口，如此一来可用Push添加项目而用Pop取出队列最高优先级的项目。
这是文档中的解释。
(container/heap 容器数据结构heap
heap的实现使用到了小根堆，下面先对堆做个简单说明
1. 堆概念
堆是一种经过排序的完全二叉树，其中任一非终端节点的数据值均不大于(或不小于)其左孩子和右孩子节点的值。
最大堆和最小堆是二叉堆的两种形式。
最大堆：根结点的键值是所有堆结点键值中最大者。
最小堆：根结点的键值是所有堆结点键值中最小者。
2. heap
树的最小元素在根部，为index 0.
heap包对任意实现了heap接口的类型提供堆操作。
heap是常用的实现优先队列的方法。要创建一个优先队列，实现一个具有使用(负的)优先级作为比较的依据的Less方法的Heap接口，如此一来可用Push添加项目而用Pop取出队列最高优先级的项目。
类型接口
heap包中核心是heap.Interface接口， 堆的基础存储是一个树形结构，可以用数组或是链表实现，通过heap的函数，可以建立堆并在堆上进行操作。
heap.Interface接口源码：
type Interface interface {
sort.Interface
Push(x interface{}) // add x as element Len()
Pop() interface{} // remove and return element Len() - 1.
}
sort.Interface接口源码
type Interface interface {
// Len is the number of elements in the collection.
Len() int
// Less reports whether the element with
// index i should sort before the element with index j.
Less(i, j int) bool
// Swap swaps the elements with indexes i and j.
Swap(i, j int)
}
在实现了这些接口之后，就可以被heap包提供的各个函数进行操作，从而实现一个堆。
根据上面interface的定义，可以看出这个堆结构继承自sort.Interface， 而sort.Interface，需要实现三个方法：Len()， Less() ， Swap() 。
同事还需要实现堆接口定义的两个方法：Push(x interface{}) / Pop() interface{}， 所以我们要想使用heap定义一个堆， 只需要定义实现了这五个方法结构就可以了。
注意
接口的Push和Pop方法是供heap包调用的，请使用heap.Push和heap.Pop来向一个堆添加或者删除元素。
成员函数
heap包中提供了几个最基本的堆操作函数，包括Init，Fix，Push，Pop和Remove (其中up, down函数为非导出函数)。这些函数都通过调用前面实现接口里的方法，对堆进行操作。
Init
func Init(h Interface)
一个堆在使用任何堆操作之前应先初始化。接受参数为实现了heap.Interface接口的对象。
Fix
func Fix(h Interface, i int)
在修改第i个元素后，调用本函数修复堆，比删除第i个元素后插入新元素更有效率。
Push&Pop
Push和Pop是一对标准堆操作，Push向堆添加一个新元素，Pop弹出并返回堆顶元素，而在push和pop操作不会破坏堆的结构
Remove
删除堆中的第i个元素，并保持堆的约束性
实例练习1
代码实现了一个小顶堆，堆中元素为长方形类，按照面积大小进行排序，使用slice作为基础存储。首先是类定义和接口实现，需要实现前面说到的五个接口。
package main
import (
"container/heap"
"fmt"
)
//定义一个正方形的结构体
type Rectangle struct {
width int
height int
}
//
func (rec *Rectangle) Area() int {
return rec.width * rec.width
}
// 定义一个堆结构体
type RectHeap []Rectangle
// 实现heap.Interface接口
func (rech RectHeap) Len() int {
return len(rech)
}
// 实现sort.Iterface
func (rech RectHeap) Swap(i, j int) {
rech[i], rech[j] = rech[j], rech[i]
}
func (rech RectHeap) Less(i, j int) bool {
return rech[i].Area() < rech[j].Area()
}
// 实现heap.Interface接口定义的额外方法
func (rech *RectHeap) Push(h interface{}) {
*rech = append(*rech, h.(Rectangle))
}
func (rech *RectHeap) Pop() (x interface{}) {
n := len(*rech)
x = (*rech)[n-1] // 返回删除的元素
*rech = (*rech)[:n-1] // [n:m]不包括下标为m的元素
return x
}
func main() {
hp := &RectHeap{}
for i := 2; i < 6; i++ {
*hp = append(*hp, Rectangle{i, i})
}
fmt.Println("原始slice: ", hp)
// 堆操作
heap.Init(hp)
heap.Push(hp, Rectangle{100, 10})
fmt.Println("top元素：", (*hp)[0])
fmt.Println("删除并返回最后一个：", heap.Pop(hp)) // 最后 一个元素
fmt.Println("最终slice: ", hp)
}
完成这个练习如果还有疑问？
那么我们先来看看container/heap的源码：
截取其中一部分：
// Push pushes the element x onto the heap. The complexity is
// O(log(n)) where n = h.Len().
//
func Push(h Interface, x interface{}) {
h.Push(x)
up(h, h.Len()-1)
}
// Pop removes the minimum element (according to Less) from the heap
// and returns it. The complexity is O(log(n)) where n = h.Len().
// It is equivalent to Remove(h, 0).
//
func Pop(h Interface) interface{} {
n := h.Len() - 1
h.Swap(0, n)
down(h, 0, n)
return h.Pop()
}
在调用heap.Push()后， 程序会再次调用堆对象的Push()方法进行操作， Pop亦是如此， 不过Pop做了swap(0, n) 。
实例练习2 - 包含int的最小堆
// This example demonstrates an integer heap built using the heap interface.
package heap_test
import (
"container/heap"
"fmt"
)
// An IntHeap is a min-heap of ints.
type IntHeap []int
func (h IntHeap) Len() int { return len(h) }
func (h IntHeap) Less(i, j int) bool { return h[i] < h[j] }
func (h IntHeap) Swap(i, j int) { h[i], h[j] = h[j], h[i] }
func (h *IntHeap) Push(x interface{}) {
// Push and Pop use pointer receivers because they modify the slice's length,
// not just its contents.
*h = append(*h, x.(int))
}
func (h *IntHeap) Pop() interface{} {
old := *h
n := len(old)
x := old[n-1]
*h = old[0 : n-1]
return x
}
// This example inserts several ints into an IntHeap, checks the minimum,
// and removes them in order of priority.
func Example_intHeap() {
h := &IntHeap{2, 1, 5}
heap.Init(h)
heap.Push(h, 3)
fmt.Printf("minimum: %d\n", (*h)[0])
for h.Len() > 0 {
fmt.Printf("%d ", heap.Pop(h))
}
// Output:
// minimum: 1
// 1 2 3 5
}
实例练习3 - 用heap创建一个优先级队列
// This example demonstrates a priority queue built using the heap interface.
package heap_test
import (
"container/heap"
"fmt"
)
// An Item is something we manage in a priority queue.
type Item struct {
value string // The value of the item; arbitrary.
priority int // The priority of the item in the queue.
// The index is needed by update and is maintained by the heap.Interface methods.
index int // The index of the item in the heap.
}
// A PriorityQueue implements heap.Interface and holds Items.
type PriorityQueue []*Item
func (pq PriorityQueue) Len() int { return len(pq) }
func (pq PriorityQueue) Less(i, j int) bool {
// We want Pop to give us the highest, not lowest, priority so we use greater than here.
return pq[i].priority > pq[j].priority
}
func (pq PriorityQueue) Swap(i, j int) {
pq[i], pq[j] = pq[j], pq[i]
pq[i].index = i
pq[j].index = j
}
func (pq *PriorityQueue) Push(x interface{}) {
n := len(*pq)
item := x.(*Item)
item.index = n
*pq = append(*pq, item)
}
func (pq *PriorityQueue) Pop() interface{} {
old := *pq
n := len(old)
item := old[n-1]
item.index = -1 // for safety
*pq = old[0 : n-1]
return item
}
// update modifies the priority and value of an Item in the queue.
func (pq *PriorityQueue) update(item *Item, value string, priority int) {
item.value = value
item.priority = priority
heap.Fix(pq, item.index)
}
// This example creates a PriorityQueue with some items, adds and manipulates an item,
// and then removes the items in priority order.
func Example_priorityQueue() {
// Some items and their priorities.
items := map[string]int{
"banana": 3, "apple": 2, "pear": 4,
}
// Create a priority queue, put the items in it, and
// establish the priority queue (heap) invariants.
pq := make(PriorityQueue, len(items))
i := 0
for value, priority := range items {
pq[i] = &Item{
value: value,
priority: priority,
index: i,
}
i++
}
heap.Init(&pq)
// Insert a new item and then modify its priority.
item := &Item{
value: "orange",
priority: 1,
}
heap.Push(&pq, item)
pq.update(item, item.value, 5)
// Take the items out; they arrive in decreasing priority order.
for pq.Len() > 0 {
item := heap.Pop(&pq).(*Item)
fmt.Printf("%.2d:%s ", item.priority, item.value)
}
// Output:
// 05:orange 04:pear 03:banana 02:apple
}
有疑问加站长微信联系(非本文作者)