README.md

UGC Priority Queue

Unbuffered Generic Concurrent Priority Queue in GoLang.

Installation

go get github.com/kc596/UGCPriorityQueue

Quickstart

import (
	"github.com/kc596/UGCPriorityQueue/maxpq"
	"fmt"
)

func ExamplePQ() {
	// create new max priority queue
	pq := maxpq.New()
    
	// creating new pq node with priority 1
	node1 := maxpq.NewNode("Value1", 1)
    
	// value of node could be of any type, int here
	node2 := maxpq.NewNode(101, 10)
    
	// add the nodes to pq
	pq.Insert(node1)
	pq.Insert(node2)
    
	// get the node with highest priority
	highestPriorityNode, _ := pq.Max()
	fmt.Printf("%+v\n", highestPriorityNode)
    
	// pop the nodes with highest priority
	highestPriorityNode, _ = pq.Pop()
	nextHighest, _ := pq.Pop()
	fmt.Printf("%+v\n", highestPriorityNode) // value:101, priority:10
	fmt.Printf("%+v\n", nextHighest)         // value:Value1, priority:1
}

APIs

maxpq.PQ

Method	Return Type	Description
IsEmpty()	bool	Returns true if there are no nodes in priority queue
Size()	int	Returns the number of nodes in priority queue
Insert(*Node)	void	Adds a new node to the priority queue
Max()	*Node,error	Returns highest priority node of the priority queue
Pop()	*Node,error	Returns highest priority node and deletes it from priority queue
Clear()	void	Clears the priority queue

maxpq.Node

Method	Return Type
GetPriority()	float64
GetStringValue()	string
GetFloat64Value()	float64
GetFloat32Value()	float32
GetIntValue()	int
GetInt64Value()	int64
GetInt32Value()	int32
GetUIntValue()	uint
GetUInt64Value()	uint64
GetUInt32Value()	uint32
GetFuncValue()	func()
GetValue(target interface{})	void