package heap

import "container/heap"

Package heap 为任何实现了 heap.Interface 的类型提供堆操作。 堆是一棵树,其特点是每个节点都是其子树中的最小值节点。

树中的最小元素是根节点,位于索引 0 处。

堆是实现优先级队列的常用方式。要构建优先级队列, 需要用(负)优先级作为 Less 方法的排序来实现 Heap 接口, 这样 Push 添加元素而 Pop 从队列中移除最高优先级的元素。 示例中包含了这样的实现;example_pq_test.go 文件中有完整的源代码。

Example (IntHeap)

This example inserts several ints into an IntHeap, checks the minimum, and removes them in order of priority.

// This example demonstrates an integer heap built using the heap interface.
package main

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 any) {
	// 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() any {
	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 main() {
	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
Example (PriorityQueue)

This example creates a PriorityQueue with some items, adds and manipulates an item, and then removes the items in priority order.

// This example demonstrates a priority queue built using the heap interface.
package main

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 any) {
	n := len(*pq)
	item := x.(*Item)
	item.index = n
	*pq = append(*pq, item)
}

func (pq *PriorityQueue) Pop() any {
	old := *pq
	n := len(old)
	item := old[n-1]
	old[n-1] = nil  // don't stop the GC from reclaiming the item eventually
	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 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 := 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

Index

Examples

Functions

func Fix

func Fix(h Interface, i int)

Fix 在索引 i 处的元素值改变后,重新建立堆的排序。 改变索引 i 处元素的值然后调用 Fix,等价于 但比调用 Remove(h, i) 后再 Push 新值更廉价。 时间复杂度为 O(log n),其中 n = h.Len()。

func Init

func Init(h Interface)

Init 建立本包中其他例程所需的堆不变量。 Init 对于堆不变量是幂等的, 可在堆不变量可能已失效的任何时候调用。 时间复杂度为 O(n),其中 n = h.Len()。

func Pop

func Pop(h Interface) any

Pop 移除并返回堆中的最小元素(根据 Less 方法)。 时间复杂度为 O(log n),其中 n = h.Len()。 Pop 等价于 Remove(h, 0)。

func Push

func Push(h Interface, x any)

Push 将元素 x 推入堆中。 时间复杂度为 O(log n),其中 n = h.Len()。

func Remove

func Remove(h Interface, i int) any

Remove 移除并返回堆中索引 i 处的元素。 时间复杂度为 O(log n),其中 n = h.Len()。

Types

type Interface

type Interface interface {
	sort.Interface
	Push(x any) // 将 x 添加为元素 Len()
	Pop() any   // 移除并返回元素 Len() - 1。
}

Interface 类型描述了使用本包中例程的类型所需满足的要求。 任何实现该接口的类型都可以作为最小堆使用,并满足以下不变量 (在调用 Init 后,或数据为空或已排序时建立):

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

注意,本接口中的 PushPop 供堆包实现调用。 要向堆中添加和移除元素,请使用 heap.Pushheap.Pop