Documentation
¶
Overview ¶
Package heap provide a min-heap implementation called Heap.
Example (HeapSort) ¶
package main
import (
"fmt"
"github.com/TiagoMalhadas/xcweaver/internal/heap"
)
func main() {
less := func(x, y int) bool { return x < y }
ints := heap.New(less)
unsorted := []int{2, 9, 6, 3, 8, 7, 4, 1, 5}
sorted := []int{}
for _, x := range unsorted {
ints.Push(x)
}
for ints.Len() > 0 {
x, _ := ints.Pop()
sorted = append(sorted, x)
}
fmt.Println(sorted)
}
Output: [1 2 3 4 5 6 7 8 9]
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Heap ¶
type Heap[T any] struct { // contains filtered or unexported fields }
Heap is a generic min-heap. Modifying an element while it is on the heap invalidates the heap.
func New ¶
New returns a new empty heap, with elements sorted using the provided comparator function.
Example ¶
package main
import (
"github.com/TiagoMalhadas/xcweaver/internal/heap"
)
func main() {
// Create a heap of ints.
heap.New(func(x, y int) bool { return x < y })
// Create a heap of strings.
heap.New(func(x, y string) bool { return x < y })
}
Output:
func (*Heap[T]) Peek ¶
Peek returns the least element from the heap, if the heap is non-empty. Unlike Pop, Peek does not modify the heap.
Example ¶
package main
import (
"fmt"
"github.com/TiagoMalhadas/xcweaver/internal/heap"
)
func main() {
ints := heap.New(func(x, y int) bool { return x < y })
fmt.Println(ints.Peek())
ints.Push(42)
fmt.Println(ints.Peek())
}
Output: 0 false 42 true
func (*Heap[T]) Pop ¶
Pop pops the least element from the heap, if the heap is non-empty.
Example ¶
package main
import (
"fmt"
"github.com/TiagoMalhadas/xcweaver/internal/heap"
)
func main() {
ints := heap.New(func(x, y int) bool { return x < y })
ints.Push(2)
ints.Push(1)
fmt.Println(ints.Pop())
fmt.Println(ints.Pop())
fmt.Println(ints.Pop())
}
Output: 1 true 2 true 0 false
Source Files
Click to show internal directories.
Click to hide internal directories.