heap

Documentation

Overview

Copyright (c) 2016-2019 Uber Technologies, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type Item
• type PriorityQueue
  • func NewPriorityQueue(items ...*Item) *PriorityQueue
  • func (pq *PriorityQueue) Len() int
  • func (pq *PriorityQueue) Pop() (*Item, error)
  • func (pq *PriorityQueue) Push(item *Item)

Types

type Item

type Item struct {
	Value    interface{} // The value of the item; arbitrary.
	Priority int         // The priority of the item in the queue (low value == high priority).
}

An Item is something we manage in a priority queue.

type PriorityQueue

type PriorityQueue struct {
	// contains filtered or unexported fields
}

PriorityQueue implements a heap returns Items with lowest priority first.

func NewPriorityQueue

func NewPriorityQueue(items ...*Item) *PriorityQueue

NewPriorityQueue initializes a PriorityQueue with passed items.

func (*PriorityQueue) Len

func (pq *PriorityQueue) Len() int

Len returns the number of Items in the PriorityQueue.

func (*PriorityQueue) Pop

func (pq *PriorityQueue) Pop() (*Item, error)

Pop removes and returns the lowest priority Item from the PriorityQueue.

func (*PriorityQueue) Push

func (pq *PriorityQueue) Push(item *Item)

Push adds the Item to the PriorityQueue.