pqueue

Documentation

Overview

Package pqueue provides a priority queue implementation.

Index

• type Item
• type PriorityQueue
  • func New(capacity int) PriorityQueue
  • func (pq PriorityQueue) Len() int
  • func (pq PriorityQueue) Less(i, j int) bool
  • func (pq *PriorityQueue) PeekAndShift(max int64) (*Item, int64)
  • func (pq *PriorityQueue) Pop() interface{}
  • func (pq *PriorityQueue) Push(x interface{})
  • func (pq PriorityQueue) Swap(i, j int)

Types

type Item

type Item struct {
	Value    interface{}
	Priority int64
	Index    int
}

Item in the PriorityQueue.

type PriorityQueue

type PriorityQueue []*Item

PriorityQueue as implemented by a min heap ie. the 0th element is the *lowest* value.

func New

func New(capacity int) PriorityQueue

New creates a PriorityQueue of the given capacity.

func (PriorityQueue) Len

func (pq PriorityQueue) Len() int

Len returns the length of the queue.

func (PriorityQueue) Less

func (pq PriorityQueue) Less(i, j int) bool

Less returns true if the item at index i has a lower priority than the item at index j.

func (*PriorityQueue) PeekAndShift

func (pq *PriorityQueue) PeekAndShift(max int64) (*Item, int64)

PeekAndShift based the max priority.

func (*PriorityQueue) Pop

func (pq *PriorityQueue) Pop() interface{}

Pop an item from the queue.

func (*PriorityQueue) Push

func (pq *PriorityQueue) Push(x interface{})

Push a new value to the queue.

func (PriorityQueue) Swap

func (pq PriorityQueue) Swap(i, j int)

Swap the items at index i and j.