golang中container/heap包用法

這是一個建立於 的文章，其中的資訊可能已經有所發展或是發生改變。

heap包對任意實現了heap介面的類型提供堆操作。（小根）堆是具有“每個節點都是以其為根的子樹中最小值”屬性的樹。樹的最小元素在根部，為index 0.

heap是常用的實現優先隊列的方法。要建立一個優先隊列，實現一個具有使用（負的）優先順序作為比較的依據的Less方法的Heap介面，如此一來可用Push添加項目而用Pop取出隊列最高優先順序的項目。

type Interface

type Interface interface {    sort.Interface    Push(x interface{}) // add x as element Len()    Pop() interface{}   // remove and return element Len() - 1.}

可以看出，這個堆結構繼承自sort.Interface, 而sort.Interface，需要實現三個方法：Len() int /   Less(i, j int) bool  /  Swap(i, j int) 再加上堆介面定義的兩個方法：Push(x interface{})   /  Pop() interface{}。故只要實現了這五個方法，變定義了一個堆。

任何實現了本介面的類型都可以用於構建最小堆。最小堆可以通過heap.Init建立，資料是遞增順序或者空的話也是最小堆。最小堆的約束條件是：

!h.Less(j, i) for 0 <= i < h.Len() and 2*i+1 <= j <= 2*i+2 and j < h.Len()

注意介面的Push和Pop方法是供heap包調用的，請使用heap.Push和heap.Pop來向一個堆添加或者刪除元素。

func Fix(h Interface, i int)  //  在修改第i個元素後，調用本函數修複堆，比刪除第i個元素後插入新元素更有效率。複雜度O(log(n))，其中n等於h.Len()。
func Init(h Interface)  //初始化一個堆。一個堆在使用任何堆操作之前應先初始化。Init函數對於堆的約束性是等冪的（多次執行無意義），並可能在任何時候堆的約束性被破壞時被調用。本函數複雜度為O(n)，其中n等於h.Len()。
func Pop(h Interface) interface{}  //刪除並返回堆h中的最小元素（不影響約束性）。複雜度O(log(n))，其中n等於h.Len()。該函數等價於Remove(h, 0)。
func Push(h Interface, x interface{})  //向堆h中插入元素x，並保持堆的約束性。複雜度O(log(n))，其中n等於h.Len()。
func Remove(h Interface, i int) interface{}  //刪除堆中的第i個元素，並保持堆的約束性。複雜度O(log(n))，其中n等於h.Len()。

舉例說明其用法：

package mainimport ("container/heap""fmt")// An IntHeap is a min-heap of ints.type IntHeap []intfunc (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 := *hn := 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 main() {h := &IntHeap{2, 1, 5, 100, 3, 6, 4, 5}heap.Init(h)heap.Push(h, 3)heap.Fix(h, 3)fmt.Printf("minimum: %d\n", (*h)[0])for h.Len() > 0 {fmt.Printf("%d ", heap.Pop(h))}}

利用heap建立一個優先順序隊列

// This example demonstrates a priority queue built using the heap interface.package mainimport ("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 []*Itemfunc (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 = ipq[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 := *pqn := 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 = valueitem.priority = priorityheap.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 main() {// 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 := 0for 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 \n", item.priority, item.value)}}

參考：https://golang.org/pkg/container/heap/