prioqueue

package

v0.0.4 Latest Latest Go to latest Published: May 22, 2023 License: BSD-3-Clause Imports: 3 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Item struct {
	Value any
	// contains filtered or unexported fields
}

Item contains a reference to an enqueued value.

type LessFunc func(any, any) bool

LessFunc returns whether the first parameter is to be considered less than the second parameter.

type PrioQueue struct {
	Less LessFunc
	// contains filtered or unexported fields
}

PrioQueue is a min-heap queue with items sorted using the Less function.

func (q *PrioQueue) Clear()

Clear removes all items from the queue.

func (q *PrioQueue) Len() int

Len returns the number of items in the queue.

func (q *PrioQueue) Peek() any

Peek returns the minimum value in the queue.

func (q *PrioQueue) Pop() any

Pop removes and returns the minimum value from the queue.

func (q *PrioQueue) Push(value any) *Item

Push inserts a new value into the queue, returning an Item pointer suitable for updating or removing the value directly.

func (q *PrioQueue) Remove(item *Item)

Remove removes an item regardless of its current position in the queue.

func (q *PrioQueue) Update(item *Item)

Update corrects item's position in the queue after its underlying value has been changed.