pq

Documentation

Index

• type Item
• type Number
• type PriorityQueue
  • func (pq PriorityQueue[S, T]) Len() int
  • func (pq PriorityQueue[S, T]) Less(i, j int) bool
  • func (pq *PriorityQueue[S, T]) Pop() any
  • func (pq *PriorityQueue[S, T]) Push(x any)
  • func (pq PriorityQueue[S, T]) Swap(i, j int)
• type SortableMap
  • func NewSortableMap[S comparable, T Number]() SortableMap[S, T]
  • func (m SortableMap[S, T]) Top(k int) SortableMap[S, T]

Types

type Item

type Item[S any, T Number] struct {
	Value    S // The Value of the item; arbitrary.
	Priority T // The Priority of the item in the queue.
	// The Index is needed by update and is maintained by the heap.Interface methods.
	Index int // The Index of the item in the heap.
}

type Number

type Number interface {
	constraints.Integer | constraints.Float
}

type PriorityQueue

type PriorityQueue[S any, T Number] []*Item[S, T]

A PriorityQueue implements heap.Interface and holds Items.

func (PriorityQueue[S, T]) Len

func (pq PriorityQueue[S, T]) Len() int

func (PriorityQueue[S, T]) Less

func (pq PriorityQueue[S, T]) Less(i, j int) bool

func (*PriorityQueue[S, T]) Pop

func (pq *PriorityQueue[S, T]) Pop() any

func (*PriorityQueue[S, T]) Push

func (pq *PriorityQueue[S, T]) Push(x any)

func (PriorityQueue[S, T]) Swap

func (pq PriorityQueue[S, T]) Swap(i, j int)

type SortableMap

type SortableMap[S comparable, T Number] map[S]T

func NewSortableMap

func NewSortableMap[S comparable, T Number]() SortableMap[S, T]

func (SortableMap[S, T]) Top

func (m SortableMap[S, T]) Top(k int) SortableMap[S, T]