pq

README

go-ipfs-pq

go-ipfs-pq implements a priority queue.

Table of Contents

• Install
• Usage
• Contribute
• License

Install

go-ipfs-pq works like a regular Go module:

> go get github.com/ipfs/go-ipfs-pq

Usage

import "github.com/ipfs/go-ipfs-pq"

Check the GoDoc documentation

Contribute

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © Protocol Labs, Inc.

Documentation

Overview

Package pq implements a priority queue.

Index

• type Elem
• type ElemComparator
• type PQ
  • func New(cmp ElemComparator) PQ

Types

type Elem

type Elem interface {
	// SetIndex stores the int index.
	SetIndex(int)
	// Index returns the last given by SetIndex(int).
	Index() int
}

Elem describes elements that can be added to the PQ. Clients must implement this interface.

type ElemComparator

type ElemComparator func(a, b Elem) bool

ElemComparator returns true if pri(a) > pri(b)

type PQ

type PQ interface {
	// Push adds the ele
	Push(Elem)
	// Pop removes and returns the highest priority Elem in PQ.
	Pop() Elem
	// Peek returns the highest priority Elem in PQ (without removing it).
	Peek() Elem
	// Remove removes the item at the given index from the PQ.
	Remove(index int) Elem
	// Len returns the number of elements in the PQ.
	Len() int
	// Update `fixes` the PQ.
	Update(index int)
}

PQ is a basic priority queue.

func New

func New(cmp ElemComparator) PQ

New creates a PQ with a client-supplied comparator.