heap

Documentation

Overview

Package heap provides a generic heap implementation.

Index

• type Heap
  • func NewHeap[K cmp.Ordered, T comparable]() *Heap[K, T]
  • func (h *Heap[K, T]) Len() int
  • func (h *Heap[K, T]) Peek() (k K, v T, ok bool)
  • func (h *Heap[K, T]) Pop() (k K, v T, ok bool)
  • func (h *Heap[K, T]) Push(key K, data T)
  • func (h *Heap[K, T]) Remove(data T) bool

Types

type Heap

type Heap[K cmp.Ordered, T comparable] struct {
	// contains filtered or unexported fields
}

Heap is a generic heap implementation.

func NewHeap

func NewHeap[K cmp.Ordered, T comparable]() *Heap[K, T]

NewHeap creates a new heap.

func (*Heap[K, T]) Len

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

Len returns the number of items in the queue.

func (*Heap[K, T]) Peek

func (h *Heap[K, T]) Peek() (k K, v T, ok bool)

Peek returns the next item in the queue without removing it.

func (*Heap[K, T]) Pop

func (h *Heap[K, T]) Pop() (k K, v T, ok bool)

Pop removes an item from the queue.

func (*Heap[K, T]) Push

func (h *Heap[K, T]) Push(key K, data T)

Push adds an item to the queue.

func (*Heap[K, T]) Remove

func (h *Heap[K, T]) Remove(data T) bool

Remove removes an item from the queue.