priorityqueue

Documentation

Index

• type Item
• type Queue
  • func NewMax[T supportedValueType](capacity int) *Queue[T]
  • func NewMin[T supportedValueType](capacity int) *Queue[T]
  • func NewMinWithId[T supportedValueType](capacity int) *Queue[T]
  • func (q *Queue[T]) Cap() int
  • func (q *Queue[T]) Insert(id uint64, distance float32) int
  • func (q *Queue[T]) InsertAndPop(id uint64, score float64, limit int, worstDist *float64, val T)
  • func (q *Queue[T]) InsertWithValue(id uint64, distance float32, val T) int
  • func (q *Queue[T]) Len() int
  • func (q *Queue[T]) Pop() Item[T]
  • func (q *Queue[T]) Reset()
  • func (q *Queue[T]) ResetCap(capacity int)
  • func (q *Queue[T]) ShouldEnqueue(distance float32, limit int) bool
  • func (q *Queue[T]) Top() Item[T]

Types

type Item

type Item[T supportedValueType] struct {
	ID       uint64
	Dist     float32
	Rescored bool
	Value    T
}

Item represents a queue item supporting an optional additional Value

type Queue

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

Queue is a priority queue supporting generic item values

func NewMax

func NewMax[T supportedValueType](capacity int) *Queue[T]

NewMax constructs a priority queue which prioritizes items with greater distance

func NewMin

func NewMin[T supportedValueType](capacity int) *Queue[T]

NewMin constructs a priority queue which prioritizes items with smaller distance

func NewMinWithId

func NewMinWithId[T supportedValueType](capacity int) *Queue[T]

NewMin constructs a priority queue which prioritizes items with larger distance and smaller ID: - higher scores first - if tied, lower document id first Thus, the signs in the Less function are opposite for scores and ids

func (*Queue[T]) Cap

func (q *Queue[T]) Cap() int

Cap returns the remaining capacity of the queue

func (*Queue[T]) Insert

func (q *Queue[T]) Insert(id uint64, distance float32) int

Insert creates a valueless item and adds it to the queue

func (*Queue[T]) InsertAndPop

func (q *Queue[T]) InsertAndPop(id uint64, score float64, limit int, worstDist *float64, val T)

func (*Queue[T]) InsertWithValue

func (q *Queue[T]) InsertWithValue(id uint64, distance float32, val T) int

InsertWithValue creates an item with a T type value and adds it to the queue

func (*Queue[T]) Len

func (q *Queue[T]) Len() int

Len returns the length of the queue

func (*Queue[T]) Pop

func (q *Queue[T]) Pop() Item[T]

Pop removes the next item in the queue and returns it

func (*Queue[T]) Reset

func (q *Queue[T]) Reset()

Reset clears all items from the queue

func (*Queue[T]) ResetCap

func (q *Queue[T]) ResetCap(capacity int)

ResetCap drops existing queue items, and allocates a new queue with the given capacity

func (*Queue[T]) ShouldEnqueue

func (q *Queue[T]) ShouldEnqueue(distance float32, limit int) bool

func (*Queue[T]) Top

func (q *Queue[T]) Top() Item[T]

Top peeks at the next item in the queue