jsat.utils

Class IntPriorityQueue

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<Integer>

jsat.utils.IntPriorityQueue

All Implemented Interfaces:

Serializable, Iterable<Integer>, Collection<Integer>, Queue<Integer>

public class IntPriorityQueue
extends AbstractQueue<Integer>
implements Serializable

This class represents a priority queue specifically designed to contain integer keys, and uses less memory then a PriorityQueue filled with integers. This queue can optionally support log(n) removal of key values at increased memory cost.

Author:

Edward Raff

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntPriorityQueue.Mode Sets the mode used for the priority queue.

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<Integer>	naturalComparator

Constructor Summary

Constructors

Constructor and Description
IntPriorityQueue() Creates a new integer priority queue using IntPriorityQueue.Mode.STANDARD
IntPriorityQueue(int initialSize, Comparator<Integer> comparator) Creates a new integer priority queue using the specified comparison and IntPriorityQueue.Mode.STANDARD
IntPriorityQueue(int initialSize, Comparator<Integer> comparator, IntPriorityQueue.Mode fastValueRemove) Creates a new integer priority queue
IntPriorityQueue(int initialSize, IntPriorityQueue.Mode fastValueRemove) Creates a new integer priority queue

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	contains(Object o)
Iterator<Integer>	iterator()
boolean	offer(int e)
boolean	offer(Integer e)
Integer	peek()
Integer	poll()
boolean	remove(Object o)
protected int	removeHeapNode(int i) Removes the node specified from the heap
int	size()

Methods inherited from class java.util.AbstractQueue

add, addAll, element, remove

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

naturalComparator

public static final Comparator<Integer> naturalComparator

Constructor Detail

IntPriorityQueue

public IntPriorityQueue()

Creates a new integer priority queue using IntPriorityQueue.Mode.STANDARD

IntPriorityQueue

public IntPriorityQueue(int initialSize,
                        Comparator<Integer> comparator)

Creates a new integer priority queue using the specified comparison and IntPriorityQueue.Mode.STANDARD

Parameters:

initialSize - the initial storage size of the queue

comparator - the comparator to determine the order of elements in the queue

IntPriorityQueue

public IntPriorityQueue(int initialSize,
                        IntPriorityQueue.Mode fastValueRemove)

Creates a new integer priority queue

Parameters:

initialSize - the initial storage size of the queue

fastValueRemove - the mode that whether or not, and how, fast arbitrary object removal from the queue will be done.

IntPriorityQueue

public IntPriorityQueue(int initialSize,
                        Comparator<Integer> comparator,
                        IntPriorityQueue.Mode fastValueRemove)

Creates a new integer priority queue

Parameters:

initialSize - the initial storage size of the queue

comparator - the comparator to determine the order of elements in the queue

fastValueRemove - the mode that whether or not, and how, fast arbitrary object removal from the queue will be done.

Method Detail

iterator

public Iterator<Integer> iterator()

Specified by:

iterator in interface Iterable<Integer>

Specified by:

iterator in interface Collection<Integer>

Specified by:

iterator in class AbstractCollection<Integer>

size

public int size()

Specified by:

size in interface Collection<Integer>

Specified by:

size in class AbstractCollection<Integer>

offer

public boolean offer(Integer e)

Specified by:

offer in interface Queue<Integer>

offer

public boolean offer(int e)

removeHeapNode

protected int removeHeapNode(int i)

Removes the node specified from the heap

Parameters:

i - the valid heap node index to remove from the heap

Returns:

the value that was stored in the heap node

poll

public Integer poll()

Specified by:

poll in interface Queue<Integer>

peek

public Integer peek()

Specified by:

peek in interface Queue<Integer>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<Integer>

Overrides:

contains in class AbstractCollection<Integer>

clear

public void clear()

Specified by:

clear in interface Collection<Integer>

Overrides:

clear in class AbstractQueue<Integer>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<Integer>

Overrides:

remove in class AbstractCollection<Integer>