README.md

gheap

MinHeap, MaxHeap and MinMaxHeap priority queues using golang generics.

This package implements priority queues of the types Min Heap, Max Heap and Min-max Heap (as described by M.D.Atkinson et. al.; https://dl.acm.org/doi/10.1145/6617.6621).

The complete binary trees used by the queues are implicitly encoded using the underlying slice of HeapElements. By using golang generics, the key types for queue elements, the HeapElement Key type, can be any signed integer or float type, and the data type for queue elements, the HeapElement Data type, can be any type. Each queue implements Insert, RemoveMin and/or RemoveMax, PeekMin and/or PeakMax, and a shallow Copy. The MinMaxHeap also provides a non-destructive ascending or descending iterator generating function, GetIterator.

For example, to declare and fill a MinMaxHeap with some HeapElements using float32 as the HeapElement Key type and string as Data type:

testSet := []HeapElement[float32, string]{
		{0.0, "spruce"},
		{0.2, "cypress"},
		{0.6, "cedar"},
		{3.0, "oak"},
		{0.14, "maple"},
		{0.14, "palm"},
		{0.6, "mango"},
		{1.0, "walnut"}}

mmheap := MinMaxHeap[float32, string]{}
for _, v := range testSet {
	mmheap.Insert(v)
}

fmt.Println("Max : ", mmheap.PeekMax())
fmt.Println("Min : ", mmheap.PeekMin())

In addition, generic slice functions Reverse, Equals, and Fill are included.

Please see heap_test.go for more examples.