heap

Documentation

Index

• type Heap
  • func New[T any](keyFn keyFunc[T], lessFn lessFunc[T]) *Heap[T]
  • func (h *Heap[T]) Delete(key string)
  • func (h *Heap[T]) GetByKey(key string) *T
  • func (h *Heap[T]) Len() int
  • func (h *Heap[T]) List() []*T
  • func (h *Heap[T]) Pop() *T
  • func (h *Heap[T]) PushIfNotPresent(obj *T) (added bool)
  • func (h *Heap[T]) PushOrUpdate(obj *T)

Types

type Heap

type Heap[T any] struct {
	// contains filtered or unexported fields
}

Heap is a producer/consumer queue that implements a heap data structure. It can be used to implement priority queues and similar data structures.

func New

func New[T any](keyFn keyFunc[T], lessFn lessFunc[T]) *Heap[T]

New returns a Heap which can be used to queue up items to process.

func (*Heap[T]) Delete

func (h *Heap[T]) Delete(key string)

Delete removes an item.

func (*Heap[T]) GetByKey

func (h *Heap[T]) GetByKey(key string) *T

GetByKey returns the requested item, or sets exists=false.

func (*Heap[T]) Len

func (h *Heap[T]) Len() int

Len returns the number of items in the heap.

func (*Heap[T]) List

func (h *Heap[T]) List() []*T

List returns a list of all the items.

func (*Heap[T]) Pop

func (h *Heap[T]) Pop() *T

Pop returns the head of the heap and removes it.

func (*Heap[T]) PushIfNotPresent

func (h *Heap[T]) PushIfNotPresent(obj *T) (added bool)

PushIfNotPresent inserts an item to the queue. If an item with the key is present in the map, no changes is made to the item.

func (*Heap[T]) PushOrUpdate

func (h *Heap[T]) PushOrUpdate(obj *T)

PushOrUpdate inserts an item to the queue. The item will be updated if it already exists.