Package it.unimi.dsi.fastutil.ints

Class IntHeapPriorityQueue

java.lang.Object

it.unimi.dsi.fastutil.ints.IntHeapPriorityQueue

All Implemented Interfaces:

IntPriorityQueue, PriorityQueue<Integer>, Serializable

public class IntHeapPriorityQueue
extends Object
implements IntPriorityQueue, Serializable

A type-specific heap-based priority queue.

Instances of this class represent a priority queue using a heap. The heap is enlarged as needed, but it is never shrunk. Use the trim() method to reduce its size, if necessary.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
IntHeapPriorityQueue()	Creates a new empty queue using the natural order.
IntHeapPriorityQueue(int capacity)	Creates a new empty queue with a given capacity and using the natural order.
IntHeapPriorityQueue(int[] a)	Wraps a given array in a queue using the natural order.
IntHeapPriorityQueue(int[] a, int size)	Wraps a given array in a queue using the natural order.
IntHeapPriorityQueue(int[] a, int size, IntComparator c)	Wraps a given array in a queue using a given comparator.
IntHeapPriorityQueue(int[] a, IntComparator c)	Wraps a given array in a queue using a given comparator.
IntHeapPriorityQueue(int capacity, IntComparator c)	Creates a new empty queue with a given capacity and comparator.
IntHeapPriorityQueue(IntCollection collection)	Creates a queue using the elements in a type-specific collection using the natural order.
IntHeapPriorityQueue(IntCollection collection, IntComparator c)	Creates a queue using the elements in a type-specific collection using a given comparator.
IntHeapPriorityQueue(IntComparator c)	Creates a new empty queue with a given comparator.
IntHeapPriorityQueue(Collection<? extends Integer> collection)	Creates a queue using the elements in a collection using the natural order.
IntHeapPriorityQueue(Collection<? extends Integer> collection, IntComparator c)	Creates a queue using the elements in a collection using a given comparator.

Method Summary

Modifier and Type	Method	Description
void	changed()	Notifies the queue that the first element has changed (optional operation).
void	clear()	Removes all elements from this queue.
IntComparator	comparator()	Returns the comparator associated with this priority queue, or null if it uses its elements' natural ordering.
int	dequeueInt()	Dequeues the first element from the queue.
void	enqueue(int x)	Enqueues a new element.
int	firstInt()	Returns the first element of the queue.
int	size()	Returns the number of elements in this queue.
void	trim()	Trims the underlying heap array so that it has exactly size() elements.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.ints.IntPriorityQueue

dequeue, enqueue, first, last, lastInt

Methods inherited from interface it.unimi.dsi.fastutil.PriorityQueue

isEmpty

Constructor Details

IntHeapPriorityQueue

public IntHeapPriorityQueue(int capacity,
 IntComparator c)

Creates a new empty queue with a given capacity and comparator.

Parameters:

capacity - the initial capacity of this queue.

c - the comparator used in this queue, or null for the natural order.

IntHeapPriorityQueue

public IntHeapPriorityQueue(int capacity)

Creates a new empty queue with a given capacity and using the natural order.

Parameters:

capacity - the initial capacity of this queue.

IntHeapPriorityQueue

public IntHeapPriorityQueue(IntComparator c)

Creates a new empty queue with a given comparator.

Parameters:

c - the comparator used in this queue, or null for the natural order.

IntHeapPriorityQueue

public IntHeapPriorityQueue()

Creates a new empty queue using the natural order.

IntHeapPriorityQueue

public IntHeapPriorityQueue(int[] a,
 int size,
 IntComparator c)

Wraps a given array in a queue using a given comparator.

The queue returned by this method will be backed by the given array. The first size element of the array will be rearranged so to form a heap (this is more efficient than enqueing the elements of a one by one).

Parameters:

a - an array.

size - the number of elements to be included in the queue.

c - the comparator used in this queue, or null for the natural order.

IntHeapPriorityQueue

public IntHeapPriorityQueue(int[] a,
 IntComparator c)

Wraps a given array in a queue using a given comparator.

The queue returned by this method will be backed by the given array. The elements of the array will be rearranged so to form a heap (this is more efficient than enqueing the elements of a one by one).

Parameters:

a - an array.

c - the comparator used in this queue, or null for the natural order.

IntHeapPriorityQueue

public IntHeapPriorityQueue(int[] a,
 int size)

Wraps a given array in a queue using the natural order.

The queue returned by this method will be backed by the given array. The first size element of the array will be rearranged so to form a heap (this is more efficient than enqueing the elements of a one by one).

Parameters:

a - an array.

size - the number of elements to be included in the queue.

IntHeapPriorityQueue

public IntHeapPriorityQueue(int[] a)

Wraps a given array in a queue using the natural order.

The queue returned by this method will be backed by the given array. The elements of the array will be rearranged so to form a heap (this is more efficient than enqueing the elements of a one by one).

Parameters:

a - an array.

IntHeapPriorityQueue

public IntHeapPriorityQueue(IntCollection collection,
 IntComparator c)

Creates a queue using the elements in a type-specific collection using a given comparator.

This constructor is more efficient than enqueing the elements of collection one by one.

Parameters:

collection - a collection; its elements will be used to initialize the queue.

c - the comparator used in this queue, or null for the natural order.

IntHeapPriorityQueue

public IntHeapPriorityQueue(IntCollection collection)

Creates a queue using the elements in a type-specific collection using the natural order.

This constructor is more efficient than enqueing the elements of collection one by one.

Parameters:

collection - a collection; its elements will be used to initialize the queue.

IntHeapPriorityQueue

public IntHeapPriorityQueue(Collection<? extends Integer> collection,
 IntComparator c)

Creates a queue using the elements in a collection using a given comparator.

This constructor is more efficient than enqueing the elements of collection one by one.

Parameters:

collection - a collection; its elements will be used to initialize the queue.

c - the comparator used in this queue, or null for the natural order.

IntHeapPriorityQueue

public IntHeapPriorityQueue(Collection<? extends Integer> collection)

Creates a queue using the elements in a collection using the natural order.

This constructor is more efficient than enqueing the elements of collection one by one.

Parameters:

collection - a collection; its elements will be used to initialize the queue.

Method Details

enqueue

public void enqueue(int x)

Description copied from interface: IntPriorityQueue

Enqueues a new element.

Specified by:

enqueue in interface IntPriorityQueue

Parameters:

x - the element to enqueue.

See Also:

• PriorityQueue.enqueue(Object)

dequeueInt

public int dequeueInt()

Description copied from interface: IntPriorityQueue

Dequeues the first element from the queue.

Specified by:

dequeueInt in interface IntPriorityQueue

Returns:

the dequeued element.

See Also:

• IntPriorityQueue.dequeue()

firstInt

public int firstInt()

Description copied from interface: IntPriorityQueue

Returns the first element of the queue.

Specified by:

firstInt in interface IntPriorityQueue

Returns:

the first element.

See Also:

• IntPriorityQueue.first()

changed

public void changed()

Description copied from interface: PriorityQueue

Notifies the queue that the first element has changed (optional operation).

This default implementation just throws an UnsupportedOperationException.

Specified by:

changed in interface PriorityQueue<Integer>

size

public int size()

Description copied from interface: PriorityQueue

Returns the number of elements in this queue.

Specified by:

size in interface PriorityQueue<Integer>

Returns:

the number of elements in this queue.

clear

public void clear()

Description copied from interface: PriorityQueue

Removes all elements from this queue.

Specified by:

clear in interface PriorityQueue<Integer>

trim

public void trim()

Trims the underlying heap array so that it has exactly size() elements.

comparator

public IntComparator comparator()

Description copied from interface: IntPriorityQueue

Returns the comparator associated with this priority queue, or null if it uses its elements' natural ordering.

Specified by:

comparator in interface IntPriorityQueue

Specified by:

comparator in interface PriorityQueue<Integer>

Returns:

the comparator associated with this priority queue.

See Also:

• PriorityQueue.comparator()