com.carrotsearch.hppcrt

Interface LongPriorityQueue

All Superinterfaces:

java.lang.Iterable<LongCursor>, LongCollection, LongContainer

All Known Implementing Classes:

LongHeapPriorityQueue

@Generated(date="2017-07-11T19:16:23+0200",
           value="KTypePriorityQueue.java")
public interface LongPriorityQueue
extends LongCollection

A Priority queue of longs.

Method Summary

Modifier and Type	Method and Description
void	add(long k) Add a k element in the priority queue
long	getDefaultValue() Returns the "default value" value used in methods returning "default value"
long	popTop() Retrieve, and remove the top element of the queue, i.e. the min element with respect to the comparison criteria (implementation defined) Returns the default value if empty.
void	setDefaultValue(long defaultValue) Set the "default value" value to be used in methods returning "default value"
long	top() Retrieve, but not remove, the top element of the queue, i.e. the min element with respect to the comparison criteria (implementation defined) of the queue.
void	updatePriorities() Update priorities of all the elements of the queue, to re-establish the correct priorities towards the comparison criteria.
void	updateTopPriority() Update the priority of the top() element, to re-establish its actual priority towards the comparison criteria when it may have changed such that it is no longer the min element with respect to the comparison criteria.

Methods inherited from interface com.carrotsearch.hppcrt.LongCollection

clear, removeAll, removeAll, removeAll, retainAll, retainAll

Methods inherited from interface com.carrotsearch.hppcrt.LongContainer

capacity, contains, forEach, forEach, isEmpty, iterator, size, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

add

void add(long k)

Add a k element in the priority queue

Parameters:

k -

top

long top()

Retrieve, but not remove, the top element of the queue, i.e. the min element with respect to the comparison criteria (implementation defined) of the queue. Returns the default value if empty.

popTop

long popTop()

Retrieve, and remove the top element of the queue, i.e. the min element with respect to the comparison criteria (implementation defined) Returns the default value if empty.

updatePriorities

void updatePriorities()

Update priorities of all the elements of the queue, to re-establish the correct priorities towards the comparison criteria.

updateTopPriority

void updateTopPriority()

Update the priority of the top() element, to re-establish its actual priority towards the comparison criteria when it may have changed such that it is no longer the min element with respect to the comparison criteria.

getDefaultValue

long getDefaultValue()

Returns the "default value" value used in methods returning "default value"

setDefaultValue

void setDefaultValue(long defaultValue)

Set the "default value" value to be used in methods returning "default value"