minheap

README

minheap

Slightly more user-friendly heap on top of containers/heap.

import "github.com/mailgun/minheap"
	

func toEl(i int) interface{} {
	return &i
}

func fromEl(i interface{}) int {
	return *(i.(*int))
}

mh := minheap.NewMinHeap()

el := &minheap.Element{
   Value:    toEl(1),
   Priority: 5,
}

mh.PushEl(el)
mh.PeekEl()
mh.Len()
mh.PopEl()

Documentation

Index

• type Element
• type MinHeap
  • func NewMinHeap() *MinHeap
  • func (mh MinHeap) Len() int
  • func (mh MinHeap) Less(i, j int) bool
  • func (mh *MinHeap) PeekEl() *Element
  • func (mh *MinHeap) Pop() interface{}
  • func (mh *MinHeap) PopEl() *Element
  • func (mh *MinHeap) Push(x interface{})
  • func (mh *MinHeap) PushEl(el *Element)
  • func (mh *MinHeap) RemoveEl(el *Element)
  • func (mh MinHeap) Swap(i, j int)
  • func (mh *MinHeap) UpdateEl(el *Element, priority int)

Types

type Element

type Element struct {
	Value    interface{}
	Priority int // The priority of the item in the queue.
	// contains filtered or unexported fields
}

An Element is something we manage in a priority queue.

type MinHeap

type MinHeap []*Element

A PriorityQueue implements heap.Interface and holds Items.

func NewMinHeap

func NewMinHeap() *MinHeap

func (MinHeap) Len

func (mh MinHeap) Len() int

func (MinHeap) Less

func (mh MinHeap) Less(i, j int) bool

func (*MinHeap) PeekEl

func (mh *MinHeap) PeekEl() *Element

func (*MinHeap) Pop

func (mh *MinHeap) Pop() interface{}

func (*MinHeap) PopEl

func (mh *MinHeap) PopEl() *Element

func (*MinHeap) Push

func (mh *MinHeap) Push(x interface{})

func (*MinHeap) PushEl

func (mh *MinHeap) PushEl(el *Element)

func (*MinHeap) RemoveEl

func (mh *MinHeap) RemoveEl(el *Element)

func (MinHeap) Swap

func (mh MinHeap) Swap(i, j int)

func (*MinHeap) UpdateEl

func (mh *MinHeap) UpdateEl(el *Element, priority int)

update modifies the priority and value of an Item in the queue.