README
¶
Go Priority Queue
Copyright © 2023 kk-min
Generic priority queue implementation for Go.
Usage
type CustomItem struct{
Key string
Val int
}
// Create a PriorityQueue of type CustomItem by passing in a "less" comparator function to CreatePQ:
q := pq.CreatePQ[CustomItem](func(a, b CustomItem) bool { return a.Val < b.Val })
// Put items in the Priority Queue:
q.Put(CustomItem{"a", 5})
q.Put(CustomItem{"b", 1})
// Peek the head of the queue:
q.Peek() // CustomItem{"b", 1}
// Get (Dequeue) the head of the queue:
q.Get() // CustomItem{"b", 1}
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LessFunction ¶
type LessFunction[T comparable] func(T, T) bool
Generic comparator function that is passed as a parameter when creating a new PQ.
type PQ ¶
type PQ[T comparable] struct { Items []*T // contains filtered or unexported fields }
Internally maintains a slice of pointers to items of type T.
func CreatePQ ¶
func CreatePQ[T comparable](less LessFunction[T]) *PQ[T]
Creates a new instance of a priority queue with the given comparator function.
func (*PQ[T]) Get ¶
func (pq *PQ[T]) Get() T
Removes and returns the top item from the priority queue.
func (*PQ[T]) Peek ¶
func (pq *PQ[T]) Peek() T
Returns the top item from the priority queue without removing it.
Source Files
Click to show internal directories.
Click to hide internal directories.