Пакет heap

import "container/heap"
Обзор
Указатель
Примеры

Обзор

Пакет heap предоставляет операции с кучей для любого типа, реализующего heap.Interface. Куча — это дерево, в котором каждый узел имеет минимальное значение среди узлов своего поддерева.

Минимальный элемент дерева находится в корне, по индексу 0.

Куча — распространённый способ реализации очереди с приоритетом. Чтобы построить очередь с приоритетом, реализуйте интерфейс Heap, используя (отрицательный) приоритет в качестве порядка для метода Less, чтобы Push добавлял элементы, а Pop удалял из очереди элемент с наивысшим приоритетом. В примерах приведена такая реализация; файл example_pq_test.go содержит полный исходный код.

Пример (IntHeap)

В этом примере в IntHeap добавляется несколько целых чисел, проверяется минимальное значение, а затем они удаляются в порядке приоритета.

Код:

// 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 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 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
}

Пример (PriorityQueue)

В этом примере создаётся PriorityQueue с несколькими элементами, один элемент добавляется и изменяется, а затем элементы удаляются в порядке приоритета.

Код:

// 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 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 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
}

Примеры

Пакет (IntHeap)

Пакет (PriorityQueue)

Файлы пакета

heap.go

func Fix 1.2

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().

type Interface

Тип Interface описывает требования к типу, использующему процедуры этого пакета. Любой тип, реализующий этот интерфейс, можно использовать как мин-кучу со следующими инвариантами (которые устанавливаются после вызова 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.

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