pq

Documentation

Index

• type Queue
  • func New[T any](comparator comparison.Comparator[T]) *Queue[T]
  • func NewFromIterable[T any](comparator comparison.Comparator[T], iterable iter.Iterable[T]) *Queue[T]
  • func (pq *Queue[T]) Empty() bool
  • func (pq *Queue[T]) PeekFront() T
  • func (pq *Queue[T]) PopFront() T
  • func (pq *Queue[T]) PushBack(value T)

Types

type Queue

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

Queue is a priority queue implementation based on a binary heap. By default, the queue is a min-heap, but a custom comparator can be provided.

func New

func New[T any](comparator comparison.Comparator[T]) *Queue[T]

New creates a new priority queue with the given comparator.

func NewFromIterable

func NewFromIterable[T any](comparator comparison.Comparator[T], iterable iter.Iterable[T]) *Queue[T]

NewFromIterable creates a new Queue with the given comparator and elements from the given iter.Iterable

func (*Queue[T]) Empty

func (pq *Queue[T]) Empty() bool

Empty returns true if the queue is empty.

func (*Queue[T]) PeekFront

func (pq *Queue[T]) PeekFront() T

PeekFront returns the element at the front of the queue. Panics if the queue is empty.

func (*Queue[T]) PopFront

func (pq *Queue[T]) PopFront() T

PopFront removes and returns the element at the front of the queue. Panics if the queue is empty.

func (*Queue[T]) PushBack

func (pq *Queue[T]) PushBack(value T)

PushBack pushes a new element into the queue. The element is inserted at the end of the queue and then moved up the heap until the heap property is satisfied.