...

パッケージ heap

import "container/heap"
概要
目次

概要 ▾

heap パッケージは heap.Interface を実装する型のヒープ操作を実装します。 ヒープとは,各ノードが子ツリーの最小値になっている ツリーのことです。

ツリーの最小要素はルートで,インデックス 0 です。

ヒープは優先キューを実装する一般的な方法です。 優先キューを作るには,(負の)優先度を Less メソッドで用いて順序付けした Heap インターフェースを実装します。 Push で項目を追加し, Pop はキューの最も重要度の高い項目を取り除きます。 例の中にそのような実装例があります。 完全なソースは example_pq_test.go ファイルをご覧ください。

例 (IntHeap)

この例では IntHeap にいくつかの整数を挿入しています。そして,最小値をチェックしてから, 優先度順に取り除いています。

コード:

// この例は,ヒープインターフェースを利用して,整数ヒープを構築する例を示しています。
package heap_test

import (
    "container/heap"
    "fmt"
)

// IntHeap は,整数の最小ヒープです。
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 と Pop はポインタレシーバを使っています。
    // なぜなら,スライスの中身だけでなく,スライスの長さも変更するからです。
    *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
}

// この例では IntHeap にいくつかの整数を挿入しています。そして,最小値をチェックしてから,
// 優先度順に取り除いています。
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 を作成し,項目を追加したり変更したりします。 それから,優先度順に取り除きます。

コード:

// この例は,優先キューをヒープインターフェースを使って構築する方法を示しています。
package heap_test

import (
    "container/heap"
    "fmt"
)

// Item は,優先キューで管理する項目です。
type Item struct {
    value    string // 値。任意です。
    priority int    // キューにおける優先度
    // index は heap.Interface メソッドで更新されます。
    index int // ヒープにおけるインデックス
}

// PriorityQueue は heap.Interface を実装し,Item のリストを保持します。
type PriorityQueue []*Item

func (pq PriorityQueue) Len() int { return len(pq) }

func (pq PriorityQueue) Less(i, j int) bool {
    // Pop が最小ではなく最大の優先度を持つ項目を返して欲しいので,ここでは > を使っています。
    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]
    old[n-1] = nil  // avoid memory leak
    item.index = -1 // for safety
    *pq = old[0 : n-1]
    return item
}

// update はキューの Item の優先度と値を更新します。
func (pq *PriorityQueue) update(item *Item, value string, priority int) {
    item.value = value
    item.priority = priority
    heap.Fix(pq, item.index)
}

// この例はいくつかの項目で PriorityQueue を作成し,項目を追加したり変更したりします。
// それから,優先度順に取り除きます。
func Example_priorityQueue() {
    // いくつかの項目とその優先度
    items := map[string]int{
        "banana": 3, "apple": 2, "pear": 4,
    }

    // 優先キューを作成し,項目を設定し,
    // 優先キュー(ヒープ)構造を作成します。
    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)

    // 新たな項目を挿入し,それからその優先度を変更します。
    item := &Item{
        value:    "orange",
        priority: 1,
    }
    heap.Push(&pq, item)
    pq.update(item, item.value, 5)

    // 項目を取り出します。優先度の降順で出てきます。
    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
}

func Fix 1.2

func Fix(h Interface, i int)

Fix はインデックス i の要素の値が変わった後にヒープの並び順を再構築します。 インデックス i の要素の値を変えて Fix を呼び出すのは, Remove(h, i) を呼び出して新たな値を Push するのと同等ですが,計算量はすくなります。

計算時間は n = h.Len() として O(log n) です。

func Init

func Init(h Interface)

Init は,このパッケージの他の関数に必要なヒープ構造を作ります。 Init はヒープ構造に関して冪等であり, ヒープ構造が崩れた場合にはいつでも呼び出すことができます。 計算時間は n = h.Len() として O(n) です。

func Pop

func Pop(h Interface) interface{}

Pop は (Less で判断して) 最小の要素をヒープから取り除き,返します。 計算時間は n = h.Len() として O(log n) です。 Pop は Remove(h, 0) と同等です。

func Push

func Push(h Interface, x interface{})

Push は要素 x をヒープに追加します。 計算時間は n = h.Len() として O(log n) です。

func Remove

func Remove(h Interface, i int) interface{}

Remove はヒープのインデックス i の要素を取り除いて返します。 計算時間は n = h.Len() として O(log n) です。

type Interface

Interface はこのパッケージのルーチンを使う型に求められるインーターフェースです。

これを実装する型はどれでも, 下記の構造で最小ヒープを構成することができます。 (Init が呼ばれた後あるいは,データが空からソートされている場合に構成されます):

0 <= i < h.Len(), 2*i+1 <= j <= 2*i+2, j < h.Len() において !h.Less(j, i)

このインターフェースの Push と Pop は heap パッケージの実装から呼び出すためのものであることに注意してください。 ヒープに追加削除する場合は, heap.Push と heap.Pop を使います。

type Interface interface {
    sort.Interface
    Push(x interface{}) // 要素 Len() に x を追加
    Pop() interface{}   // Len() - 1 の要素を取り除いて返します。
}