qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-09-25 13:20:13 -06:00
Code Releases Activity

container/heap: better package documentation

Browse Source 
Fixes #1820.

R=golang-dev, bradfitz, gri
CC=golang-dev
https://golang.org/cl/5540073
This commit is contained in:
Rob Pike 2012-01-17 13:07:47 -08:00
parent a00de45bbb
commit 4c40558c74
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/pkg/container/heap/heap.go
View File

@ -3,7 +3,13 @@
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
// Package heap provides heap operations for any type that implements // Package heap provides heap operations for any type that implements
// heap.Interface. // heap.Interface. A heap is a tree with the property that each node is the
// highest-valued node in its subtree.
//
// A heap is a common way to impement a priority queue. To build a priority
// queue, implement the Heap interface with the (negative) priority as the
// ordering for the Less method, so Push adds items while Pop removes the
// highest-priority item from the queue.
// //
package heap package heap