ObjectHeapPriorityQueue (object-queues 8.5.13-SNAPSHOT API)

java.lang.Object
- it.unimi.dsi.fastutil.objects.ObjectHeapPriorityQueue<K>

All Implemented Interfaces:

it.unimi.dsi.fastutil.PriorityQueue<K>, java.io.Serializable
```
public class ObjectHeapPriorityQueue<K>
extends java.lang.Object
implements it.unimi.dsi.fastutil.PriorityQueue<K>, java.io.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

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Comparator<? super K>`	`c` The type-specific comparator used in this queue.
`protected K[]`	`heap` The heap array.
`protected int`	`size` The number of elements in this queue.

Constructor Summary

Constructors
Constructor and Description
`ObjectHeapPriorityQueue()` Creates a new empty queue using the natural order.
`ObjectHeapPriorityQueue(java.util.Collection<? extends K> collection)` Creates a queue using the elements in a collection using the natural order.
`ObjectHeapPriorityQueue(java.util.Collection<? extends K> collection, java.util.Comparator<? super K> c)` Creates a queue using the elements in a collection using a given comparator.
`ObjectHeapPriorityQueue(java.util.Comparator<? super K> c)` Creates a new empty queue with a given comparator.
`ObjectHeapPriorityQueue(int capacity)` Creates a new empty queue with a given capacity and using the natural order.
`ObjectHeapPriorityQueue(int capacity, java.util.Comparator<? super K> c)` Creates a new empty queue with a given capacity and comparator.
`ObjectHeapPriorityQueue(K[] a)` Wraps a given array in a queue using the natural order.
`ObjectHeapPriorityQueue(K[] a, java.util.Comparator<? super K> c)` Wraps a given array in a queue using a given comparator.
`ObjectHeapPriorityQueue(K[] a, int size)` Wraps a given array in a queue using the natural order.
`ObjectHeapPriorityQueue(K[] a, int size, java.util.Comparator<? super K> c)` Wraps a given array in a queue using a given comparator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changed()`
`void`	`clear()`
`java.util.Comparator<? super K>`	`comparator()`
`K`	`dequeue()`
`void`	`enqueue(K x)`
`K`	`first()`
`int`	`size()`
`void`	`trim()` Trims the underlying heap array so that it has exactly `size()` elements.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.PriorityQueue
isEmpty, last

- Field Detail
  - heap
```
protected transient K[] heap
```
    The heap array.
  - size
```
protected int size
```
    The number of elements in this queue.
  - c
```
protected java.util.Comparator<? super K> c
```
    The type-specific comparator used in this queue.
- Constructor Detail
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(int capacity,
                               java.util.Comparator<? super K> 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.
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(int capacity)
```
    Creates a new empty queue with a given capacity and using the natural order.
    
    Parameters:
    
    capacity - the initial capacity of this queue.
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(java.util.Comparator<? super K> c)
```
    Creates a new empty queue with a given comparator.
    
    Parameters:
    
    c - the comparator used in this queue, or null for the natural order.
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue()
```
    Creates a new empty queue using the natural order.
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(K[] a,
                               int size,
                               java.util.Comparator<? super K> 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.
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(K[] a,
                               java.util.Comparator<? super K> 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.
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(K[] 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.
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(K[] 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.
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(java.util.Collection<? extends K> collection,
                               java.util.Comparator<? super K> 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.
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(java.util.Collection<? extends K> 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 Detail
  - enqueue
```
public void enqueue(K x)
```
    Specified by:
    
    enqueue in interface it.unimi.dsi.fastutil.PriorityQueue<K>
  - dequeue
```
public K dequeue()
```
    Specified by:
    
    dequeue in interface it.unimi.dsi.fastutil.PriorityQueue<K>
  - first
```
public K first()
```
    Specified by:
    
    first in interface it.unimi.dsi.fastutil.PriorityQueue<K>
  - changed
```
public void changed()
```
    Specified by:
    
    changed in interface it.unimi.dsi.fastutil.PriorityQueue<K>
  - size
```
public int size()
```
    Specified by:
    
    size in interface it.unimi.dsi.fastutil.PriorityQueue<K>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface it.unimi.dsi.fastutil.PriorityQueue<K>
  - trim
```
public void trim()
```
    Trims the underlying heap array so that it has exactly size() elements.
  - comparator
```
public java.util.Comparator<? super K> comparator()
```
    Specified by:
    
    comparator in interface it.unimi.dsi.fastutil.PriorityQueue<K>

Class ObjectHeapPriorityQueue<K>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

heap

size

c

Constructor Detail

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

Method Detail

enqueue

dequeue

first

changed

size

clear

trim

comparator