@@ -21,13 +21,13 @@ import "sort"
21
21
// for a type using the routines in this package.
22
22
// Any type that implements it may be used as a
23
23
// min-heap with the following invariants (established after
24
- // Init has been called or if the data is empty or sorted):
24
+ // [ Init] has been called or if the data is empty or sorted):
25
25
//
26
26
// !h.Less(j, i) for 0 <= i < h.Len() and 2*i+1 <= j <= 2*i+2 and j < h.Len()
27
27
//
28
- // Note that Push and Pop in this interface are for package heap's
28
+ // Note that [ Push] and [ Pop] in this interface are for package heap's
29
29
// implementation to call. To add and remove things from the heap,
30
- // use heap.Push and heap.Pop.
30
+ // use [ heap.Push] and [ heap.Pop] .
31
31
type Interface interface {
32
32
sort.Interface
33
33
Push (x any ) // add x as element Len()
@@ -55,7 +55,7 @@ func Push(h Interface, x any) {
55
55
56
56
// Pop removes and returns the minimum element (according to Less) from the heap.
57
57
// The complexity is O(log n) where n = h.Len().
58
- // Pop is equivalent to Remove(h, 0).
58
+ // Pop is equivalent to [ Remove] (h, 0).
59
59
func Pop (h Interface ) any {
60
60
n := h .Len () - 1
61
61
h .Swap (0 , n )
@@ -78,7 +78,7 @@ func Remove(h Interface, i int) any {
78
78
79
79
// Fix re-establishes the heap ordering after the element at index i has changed its value.
80
80
// Changing the value of the element at index i and then calling Fix is equivalent to,
81
- // but less expensive than, calling Remove(h, i) followed by a Push of the new value.
81
+ // but less expensive than, calling [ Remove] (h, i) followed by a Push of the new value.
82
82
// The complexity is O(log n) where n = h.Len().
83
83
func Fix (h Interface , i int ) {
84
84
if ! down (h , i , h .Len ()) {
0 commit comments